Prebid v2.0.2

.github/workflows/adapter-code-coverage.yml

@@ -28,9 +28,9 @@ jobs:
           result-encoding: string
           script: |
             const utils = require('./.github/workflows/helpers/pull-request-utils.js')            
-            function directoryExtractor(filepath) {
-              // extract directory name from filepath of the form adapters/<adapter-name>/*.go
-              if (filepath.startsWith("adapters/") && filepath.split("/").length > 2) {
+            function directoryExtractor(filepath, status) {
+              // extract directory name only if file is not removed and file is in adapters directory
+              if (status != "removed" && filepath.startsWith("adapters/") && filepath.split("/").length > 2) {
                 return filepath.split("/")[1]
               }
               return ""
@@ -41,7 +41,7 @@ jobs:
 
       - name: Run coverage tests
         id: run_coverage
-        if: ${{ steps.get_directories.outputs.result }} != ""
+        if: steps.get_directories.outputs.result != ''
         run: |
           git config --global url."https://${USERNAME}:${TOKEN}@git.pubmatic.com".insteadOf "https://git.pubmatic.com"
 
@@ -81,7 +81,7 @@ jobs:
           repository: PubMatic-OpenWrap/prebid-server
 
       - name: Commit coverage files to coverage-preview branch
-        if: ${{ steps.run_coverage.outputs.coverage_dir }} != ""
+        if: steps.run_coverage.outputs.coverage_dir != ''
         id: commit_coverage
         run: |
           directory=.github/preview/${{ github.run_id }}_$(date +%s)
@@ -95,11 +95,11 @@ jobs:
           echo "remote_coverage_preview_dir=${directory}" >> $GITHUB_OUTPUT
 
       - name: Checkout master branch
-        if: ${{ steps.get_directories.outputs.result }} != ""
+        if: steps.get_directories.outputs.result != ''
         run: git checkout master
 
       - name: Add coverage summary to pull request
-        if: ${{ steps.run_coverage.outputs.coverage_dir }} != "" && ${{ steps.commit_coverage.outputs.remote_coverage_preview_dir }} != ""
+        if: steps.run_coverage.outputs.coverage_dir != '' && steps.commit_coverage.outputs.remote_coverage_preview_dir != ''
         uses: actions/github-script@v6
         with:
           script: |

.github/workflows/helpers/pull-request-utils.js

@@ -213,8 +213,8 @@ class diffHelper {
     })
 
     const directories = []
-    for (const { filename } of data) {
-      const directory = directoryExtractor(filename)
+    for (const { filename, status } of data) {
+      const directory = directoryExtractor(filename, status)
       if (directory != "" && !directories.includes(directory)) {
         directories.push(directory)
       }

.github/workflows/release.yml

@@ -6,11 +6,12 @@ on:
       releaseType:
         type: choice
         options:
+          - major
           - minor
           - patch
         default: minor
         required: true
-        description: 'minor: v0.X.0, patch: v0.0.X'
+        description: 'major: vX.0.0, minor: v0.X.0, patch: v0.0.X'
       debug:
         type: boolean
         default: true
@@ -78,11 +79,18 @@ jobs:
 
           nextTag=''
           releaseType=${{ inputs.releaseType }}
-          if [ $releaseType == "minor" ]; then
-            # increment minor version and reset patch version
-            nextTag=$(echo "${currentTag}" | awk -F. '{OFS="."; $2+=1; $3=0; print $0}')
+          if [ $releaseType == "major" ]; then
+              # PBS-GO skipped the v1.0.0 major release - https://github.com/prebid/prebid-server/issues/3068
+              # If the current tag is v0.x.x, the script sets the next release tag to v2.0.0
+              # Otherwise, the script increments the major version by 1 and sets the minor and patch versions to zero
+              # For example, v2.x.x will be incremented to v3.0.0
+              major=$(echo "${currentTag}" | awk -F. '{gsub(/^v/, "", $1); if($1 == 0) $1=2; else $1+=1; print $1}')
+              nextTag="v${major}.0.0"
+          elif [ $releaseType == "minor" ]; then
+              # Increment minor version and reset patch version
+              nextTag=$(echo "${currentTag}" | awk -F. '{OFS="."; $2+=1; $3=0; print $0}')
           else
-            # increment patch version
+            # Increment patch version
             nextTag=$(echo "${currentTag}" | awk -F. '{OFS="."; $3+=1; print $0}')
           fi
 

.gitignore

@@ -30,8 +30,8 @@ vendor
 
 # build artifacts
 prebid-server
-build
-debug
+/build
+/debug
 __debug_bin
 
 # config files

Dockerfile

@@ -20,7 +20,7 @@ RUN go mod tidy
 RUN go mod vendor
 ARG TEST="true"
 RUN if [ "$TEST" != "false" ]; then ./validate.sh ; fi
-RUN go build -mod=vendor -ldflags "-X github.com/prebid/prebid-server/version.Ver=`git describe --tags | sed 's/^v//'` -X github.com/prebid/prebid-server/version.Rev=`git rev-parse HEAD`" .
+RUN go build -mod=vendor -ldflags "-X github.com/prebid/prebid-server/v2/version.Ver=`git describe --tags | sed 's/^v//'` -X github.com/prebid/prebid-server/v2/version.Rev=`git rev-parse HEAD`" .
 
 FROM ubuntu:20.04 AS release
 LABEL maintainer="[email protected]" 

Makefile

@@ -15,7 +15,7 @@ test: deps
 ifeq "$(adapter)" ""
 	./validate.sh
 else
-	go test github.com/prebid/prebid-server/adapters/$(adapter) -bench=.
+	go test github.com/prebid/prebid-server/v2/adapters/$(adapter) -bench=.
 endif
 
 # build-modules generates modules/builder.go file which provides a list of all available modules
@@ -43,16 +43,16 @@ mockgeninstall:
 mockgendb:
 	mkdir -p modules/pubmatic/openwrap/database/mock modules/pubmatic/openwrap/database/mock_driver
 	mockgen database/sql/driver Driver,Connector,Conn,DriverContext > modules/pubmatic/openwrap/database/mock_driver/mock.go
-	mockgen github.com/PubMatic-OpenWrap/prebid-server/modules/pubmatic/openwrap/database Database > modules/pubmatic/openwrap/database/mock/mock.go
+	mockgen github.com/PubMatic-OpenWrap/prebid-server/v2/modules/pubmatic/openwrap/database Database > modules/pubmatic/openwrap/database/mock/mock.go
 
 mockgencache:
 	mkdir -p modules/pubmatic/openwrap/cache/mock
-	mockgen github.com/PubMatic-OpenWrap/prebid-server/modules/pubmatic/openwrap/cache Cache > modules/pubmatic/openwrap/cache/mock/mock.go
+	mockgen github.com/PubMatic-OpenWrap/prebid-server/v2/modules/pubmatic/openwrap/cache Cache > modules/pubmatic/openwrap/cache/mock/mock.go
 
 mockgenmetrics:
 	mkdir -p modules/pubmatic/openwrap/metrics/mock
-	mockgen github.com/PubMatic-OpenWrap/prebid-server/modules/pubmatic/openwrap/metrics MetricsEngine > modules/pubmatic/openwrap/metrics/mock/mock.go
+	mockgen github.com/PubMatic-OpenWrap/prebid-server/v2/modules/pubmatic/openwrap/metrics MetricsEngine > modules/pubmatic/openwrap/metrics/mock/mock.go
 
 mockgenlogger:
 	mkdir -p analytics/pubmatic/mhttp/mock
-	mockgen github.com/PubMatic-OpenWrap/prebid-server/analytics/pubmatic/mhttp HttpCallInterface,MultiHttpContextInterface > analytics/pubmatic/mhttp/mock/mock.go
+	mockgen github.com/PubMatic-OpenWrap/prebid-server/v2/analytics/pubmatic/mhttp HttpCallInterface,MultiHttpContextInterface > analytics/pubmatic/mhttp/mock/mock.go

account/account.go

@@ -2,32 +2,27 @@ package account
 
 import (
 	"context"
-	"encoding/json"
 	"fmt"
-	"github.com/buger/jsonparser"
+
 	"github.com/prebid/go-gdpr/consentconstants"
-	"github.com/prebid/prebid-server/config"
-	"github.com/prebid/prebid-server/errortypes"
-	"github.com/prebid/prebid-server/metrics"
-	"github.com/prebid/prebid-server/openrtb_ext"
-	"github.com/prebid/prebid-server/stored_requests"
-	"github.com/prebid/prebid-server/util/iputil"
-	jsonpatch "gopkg.in/evanphx/json-patch.v4"
+
+	"github.com/prebid/prebid-server/v2/config"
+	"github.com/prebid/prebid-server/v2/errortypes"
+	"github.com/prebid/prebid-server/v2/metrics"
+	"github.com/prebid/prebid-server/v2/openrtb_ext"
+	"github.com/prebid/prebid-server/v2/stored_requests"
+	"github.com/prebid/prebid-server/v2/util/iputil"
+	"github.com/prebid/prebid-server/v2/util/jsonutil"
 )
 
 // GetAccount looks up the config.Account object referenced by the given accountID, with access rules applied
 func GetAccount(ctx context.Context, cfg *config.Configuration, fetcher stored_requests.AccountFetcher, accountID string, me metrics.MetricsEngine) (account *config.Account, errs []error) {
-	// Check BlacklistedAcctMap until we have deprecated it
-	if _, found := cfg.BlacklistedAcctMap[accountID]; found {
-		return nil, []error{&errortypes.BlacklistedAcct{
-			Message: fmt.Sprintf("Prebid-server has disabled Account ID: %s, please reach out to the prebid server host.", accountID),
-		}}
-	}
 	if cfg.AccountRequired && accountID == metrics.PublisherUnknown {
 		return nil, []error{&errortypes.AcctRequired{
 			Message: fmt.Sprintf("Prebid-server has been configured to discard requests without a valid Account ID. Please reach out to the prebid server host."),
 		}}
 	}
+
 	if accountJSON, accErrs := fetcher.FetchAccount(ctx, cfg.AccountDefaultsJSON(), accountID); len(accErrs) > 0 || accountJSON == nil {
 		// accountID does not reference a valid account
 		for _, e := range accErrs {
@@ -49,45 +44,12 @@ func GetAccount(ctx context.Context, cfg *config.Configuration, fetcher stored_r
 	} else {
 		// accountID resolved to a valid account, merge with AccountDefaults for a complete config
 		account = &config.Account{}
-		err := json.Unmarshal(accountJSON, account)
-
-		// this logic exists for backwards compatibility. If the initial unmarshal fails above, we attempt to
-		// resolve it by converting the GDPR enforce purpose fields and then attempting an unmarshal again before
-		// declaring a malformed account error.
-		// unmarshal fetched account to determine if it is well-formed
-		var deprecatedPurposeFields []string
-		if _, ok := err.(*json.UnmarshalTypeError); ok {
-			// attempt to convert deprecated GDPR enforce purpose fields to resolve issue
-			accountJSON, err, deprecatedPurposeFields = ConvertGDPREnforcePurposeFields(accountJSON)
-			// unmarshal again to check if unmarshal error still exists after GDPR field conversion
-			err = json.Unmarshal(accountJSON, account)
-
-			if _, ok := err.(*json.UnmarshalTypeError); ok {
-				return nil, []error{&errortypes.MalformedAcct{
-					Message: fmt.Sprintf("The prebid-server account config for account id \"%s\" is malformed. Please reach out to the prebid server host.", accountID),
-				}}
-			}
-		}
-		usingGDPRChannelEnabled := useGDPRChannelEnabled(account)
-		usingCCPAChannelEnabled := useCCPAChannelEnabled(account)
-
-		if usingGDPRChannelEnabled {
-			me.RecordAccountGDPRChannelEnabledWarning(accountID)
-		}
-		if usingCCPAChannelEnabled {
-			me.RecordAccountCCPAChannelEnabledWarning(accountID)
-		}
-		for _, purposeName := range deprecatedPurposeFields {
-			me.RecordAccountGDPRPurposeWarning(accountID, purposeName)
-		}
-		if len(deprecatedPurposeFields) > 0 || usingGDPRChannelEnabled || usingCCPAChannelEnabled {
-			me.RecordAccountUpgradeStatus(accountID)
+		if err := jsonutil.UnmarshalValid(accountJSON, account); err != nil {
+			return nil, []error{&errortypes.MalformedAcct{
+				Message: fmt.Sprintf("The prebid-server account config for account id \"%s\" is malformed. Please reach out to the prebid server host.", accountID),
+			}}
 		}
 
-		if err != nil {
-			errs = append(errs, err)
-			return nil, errs
-		}
 		// Fill in ID if needed, so it can be left out of account definition
 		if len(account.ID) == 0 {
 			account.ID = accountID
@@ -97,7 +59,7 @@ func GetAccount(ctx context.Context, cfg *config.Configuration, fetcher stored_r
 		setDerivedConfig(account)
 	}
 	if account.Disabled {
-		errs = append(errs, &errortypes.BlacklistedAcct{
+		errs = append(errs, &errortypes.AccountDisabled{
 			Message: fmt.Sprintf("Prebid-server has disabled Account ID: %s, please reach out to the prebid server host.", accountID),
 		})
 		return nil, errs
@@ -111,9 +73,6 @@ func GetAccount(ctx context.Context, cfg *config.Configuration, fetcher stored_r
 		account.Privacy.IPv4Config.AnonKeepBits = iputil.IPv4DefaultMaskingBitSize
 	}
 
-	// set the value of events.enabled field based on deprecated events_enabled field and ensure backward compatibility
-	deprecateEventsEnabledField(account)
-
 	return account, nil
 }
 
@@ -178,102 +137,3 @@ func setDerivedConfig(account *config.Account) {
 		}
 	}
 }
-
-// PatchAccount represents the GDPR portion of a publisher account configuration that can be mutated
-// for backwards compatibility reasons
-type PatchAccount struct {
-	GDPR map[string]*PatchAccountGDPRPurpose `json:"gdpr"`
-}
-
-// PatchAccountGDPRPurpose represents account-specific GDPR purpose configuration data that can be mutated
-// for backwards compatibility reasons
-type PatchAccountGDPRPurpose struct {
-	EnforceAlgo    string `json:"enforce_algo,omitempty"`
-	EnforcePurpose *bool  `json:"enforce_purpose,omitempty"`
-}
-
-// ConvertGDPREnforcePurposeFields is responsible for ensuring account GDPR config backwards compatibility
-// given the recent type change of gdpr.purpose{1-10}.enforce_purpose from a string to a bool. This function
-// iterates over each GDPR purpose config and sets enforce_purpose and enforce_algo to the appropriate
-// bool and string values respectively if enforce_purpose is a string and enforce_algo is not set
-func ConvertGDPREnforcePurposeFields(config []byte) (newConfig []byte, err error, deprecatedPurposeFields []string) {
-	gdprJSON, _, _, err := jsonparser.Get(config, "gdpr")
-	if err != nil && err == jsonparser.KeyPathNotFoundError {
-		return config, nil, deprecatedPurposeFields
-	}
-	if err != nil {
-		return nil, err, deprecatedPurposeFields
-	}
-
-	newAccount := PatchAccount{
-		GDPR: map[string]*PatchAccountGDPRPurpose{},
-	}
-
-	for i := 1; i <= 10; i++ {
-		purposeName := fmt.Sprintf("purpose%d", i)
-
-		enforcePurpose, purposeDataType, _, err := jsonparser.Get(gdprJSON, purposeName, "enforce_purpose")
-		if err != nil && err == jsonparser.KeyPathNotFoundError {
-			continue
-		}
-		if err != nil {
-			return nil, err, deprecatedPurposeFields
-		}
-		if purposeDataType != jsonparser.String {
-			continue
-		} else {
-			deprecatedPurposeFields = append(deprecatedPurposeFields, purposeName)
-		}
-
-		_, _, _, err = jsonparser.Get(gdprJSON, purposeName, "enforce_algo")
-		if err != nil && err != jsonparser.KeyPathNotFoundError {
-			return nil, err, deprecatedPurposeFields
-		}
-		if err == nil {
-			continue
-		}
-
-		newEnforcePurpose := false
-		if string(enforcePurpose) == "full" {
-			newEnforcePurpose = true
-		}
-
-		newAccount.GDPR[purposeName] = &PatchAccountGDPRPurpose{
-			EnforceAlgo:    "full",
-			EnforcePurpose: &newEnforcePurpose,
-		}
-	}
-
-	patchConfig, err := json.Marshal(newAccount)
-	if err != nil {
-		return nil, err, deprecatedPurposeFields
-	}
-
-	newConfig, err = jsonpatch.MergePatch(config, patchConfig)
-	if err != nil {
-		return nil, err, deprecatedPurposeFields
-	}
-
-	return newConfig, nil, deprecatedPurposeFields
-}
-
-func useGDPRChannelEnabled(account *config.Account) bool {
-	return account.GDPR.ChannelEnabled.IsSet() && !account.GDPR.IntegrationEnabled.IsSet()
-}
-
-func useCCPAChannelEnabled(account *config.Account) bool {
-	return account.CCPA.ChannelEnabled.IsSet() && !account.CCPA.IntegrationEnabled.IsSet()
-}
-
-// deprecateEventsEnabledField is responsible for ensuring backwards compatibility of "events_enabled" field.
-// This function favors "events.enabled" field over deprecated "events_enabled" field, if values for both are set.
-// If only deprecated "events_enabled" field is set then it sets the same value to "events.enabled" field.
-func deprecateEventsEnabledField(account *config.Account) {
-	if account != nil {
-		if account.Events.Enabled == nil {
-			account.Events.Enabled = account.EventsEnabled
-		}
-		// assign the old value to the new value so old and new are always the same even though the new value is what is used in the application code.
-		account.EventsEnabled = account.Events.Enabled
-	}
-}