Merge branch 'ci' of https://github.com/PubMatic-OpenWrap/prebid-server…

… into prebid_v2.19.0-1
PubMatic-OpenWrap · Jun 14, 2024 · f7752b4 · f7752b4
2 parents 38fcf3a + 2262e6d
commit f7752b4
Show file tree

Hide file tree

Showing 103 changed files with 6,069 additions and 1,195 deletions.
diff --git a/Makefile b/Makefile
@@ -57,6 +57,10 @@ mockgenmetrics:
 	mkdir -p modules/pubmatic/openwrap/metrics/mock
 	mockgen github.com/PubMatic-OpenWrap/prebid-server/v2/modules/pubmatic/openwrap/metrics MetricsEngine > modules/pubmatic/openwrap/metrics/mock/mock.go
 
+mockgengeodb:
+	mkdir -p modules/pubmatic/openwrap/geodb/mock
+	mockgen github.com/PubMatic-OpenWrap/prebid-server/v2/modules/pubmatic/openwrap/geodb Geography > modules/pubmatic/openwrap/geodb/mock/mock.go
+
 mockgenlogger:
 	mkdir -p analytics/pubmatic/mhttp/mock
 	mockgen github.com/PubMatic-OpenWrap/prebid-server/v2/analytics/pubmatic/mhttp HttpCallInterface,MultiHttpContextInterface > analytics/pubmatic/mhttp/mock/mock.go

diff --git a/adapters/bidder.go b/adapters/bidder.go
@@ -156,8 +156,6 @@ type ExtraRequestInfo struct {
 	PbsEntryPoint              metrics.RequestType
 	GlobalPrivacyControlHeader string
 	CurrencyConversions        currency.Conversions
-
-	BidderCoreName openrtb_ext.BidderName // OW specific: required for oRTB bidder
 }
 
 func NewExtraRequestInfo(c currency.Conversions) ExtraRequestInfo {

diff --git a/adapters/ortbbidder/bidderparams/config.go b/adapters/ortbbidder/bidderparams/config.go
@@ -2,18 +2,7 @@ package bidderparams
 
 // BidderParamMapper contains property details like location
 type BidderParamMapper struct {
-	location []string
-}
-
-// GetLocation returns the location of bidderParam
-func (bpm *BidderParamMapper) GetLocation() []string {
-	return bpm.location
-}
-
-// SetLocation sets the location in BidderParamMapper
-// Do not modify the location of bidderParam unless you are writing unit test case
-func (bpm *BidderParamMapper) SetLocation(location []string) {
-	bpm.location = location
+	Location string // do not update this parameter for each request, its being shared across all requests
 }
 
 // config contains mappings requestParams and responseParams
@@ -27,28 +16,29 @@ type BidderConfig struct {
 	bidderConfigMap map[string]*config
 }
 
-// setRequestParams sets the bidder specific requestParams
-func (bcfg *BidderConfig) setRequestParams(bidderName string, requestParams map[string]BidderParamMapper) {
-	if bcfg == nil {
-		return
-	}
-	if bcfg.bidderConfigMap == nil {
-		bcfg.bidderConfigMap = make(map[string]*config)
+// NewBidderConfig initializes and returns the object of BidderConfig
+func NewBidderConfig() *BidderConfig {
+	return &BidderConfig{
+		bidderConfigMap: make(map[string]*config),
 	}
+}
+
+// SetRequestParams sets the bidder specific requestParams
+func (bcfg *BidderConfig) SetRequestParams(bidderName string, requestParams map[string]BidderParamMapper) {
 	if _, found := bcfg.bidderConfigMap[bidderName]; !found {
 		bcfg.bidderConfigMap[bidderName] = &config{}
 	}
 	bcfg.bidderConfigMap[bidderName].requestParams = requestParams
 }
 
 // GetRequestParams returns bidder specific requestParams
-func (bcfg *BidderConfig) GetRequestParams(bidderName string) (map[string]BidderParamMapper, bool) {
-	if bcfg == nil || len(bcfg.bidderConfigMap) == 0 {
-		return nil, false
+func (bcfg *BidderConfig) GetRequestParams(bidderName string) map[string]BidderParamMapper {
+	if len(bcfg.bidderConfigMap) == 0 {
+		return nil
 	}
-	bidderConfig, _ := bcfg.bidderConfigMap[bidderName]
+	bidderConfig := bcfg.bidderConfigMap[bidderName]
 	if bidderConfig == nil {
-		return nil, false
+		return nil
 	}
-	return bidderConfig.requestParams, true
+	return bidderConfig.requestParams
 }
diff --git a/adapters/ortbbidder/bidderparams/config_test.go b/adapters/ortbbidder/bidderparams/config_test.go
@@ -14,55 +14,15 @@ func TestSetRequestParams(t *testing.T) {
 		bidderName    string
 		requestParams map[string]BidderParamMapper
 	}
-
+	type want struct {
+		bidderCfg *BidderConfig
+	}
 	tests := []struct {
 		name   string
 		fields fields
 		args   args
-		want   *BidderConfig
+		want   want
 	}{
-		{
-			name: "bidderConfig_is_nil",
-			fields: fields{
-				bidderConfig: nil,
-			},
-			args: args{
-				bidderName: "test",
-				requestParams: map[string]BidderParamMapper{
-					"adunit": {
-						location: []string{"ext", "adunit"},
-					},
-				},
-			},
-			want: nil,
-		},
-		{
-			name: "bidderConfigMap_is_nil",
-			fields: fields{
-				bidderConfig: &BidderConfig{
-					bidderConfigMap: nil,
-				},
-			},
-			args: args{
-				bidderName: "test",
-				requestParams: map[string]BidderParamMapper{
-					"adunit": {
-						location: []string{"ext", "adunit"},
-					},
-				},
-			},
-			want: &BidderConfig{
-				bidderConfigMap: map[string]*config{
-					"test": {
-						requestParams: map[string]BidderParamMapper{
-							"adunit": {
-								location: []string{"ext", "adunit"},
-							},
-						},
-					},
-				},
-			},
-		},
 		{
 			name: "bidderName_not_found",
 			fields: fields{
@@ -74,16 +34,18 @@ func TestSetRequestParams(t *testing.T) {
 				bidderName: "test",
 				requestParams: map[string]BidderParamMapper{
 					"param-1": {
-						location: []string{"path"},
+						Location: "path",
 					},
 				},
 			},
-			want: &BidderConfig{
-				bidderConfigMap: map[string]*config{
-					"test": {
-						requestParams: map[string]BidderParamMapper{
-							"param-1": {
-								location: []string{"path"},
+			want: want{
+				bidderCfg: &BidderConfig{
+					bidderConfigMap: map[string]*config{
+						"test": {
+							requestParams: map[string]BidderParamMapper{
+								"param-1": {
+									Location: "path",
+								},
 							},
 						},
 					},
@@ -98,7 +60,7 @@ func TestSetRequestParams(t *testing.T) {
 						"test": {
 							requestParams: map[string]BidderParamMapper{
 								"param-1": {
-									location: []string{"path-1"},
+									Location: "path-1",
 								},
 							},
 						},
@@ -109,16 +71,18 @@ func TestSetRequestParams(t *testing.T) {
 				bidderName: "test",
 				requestParams: map[string]BidderParamMapper{
 					"param-2": {
-						location: []string{"path-2"},
+						Location: "path-2",
 					},
 				},
 			},
-			want: &BidderConfig{
-				bidderConfigMap: map[string]*config{
-					"test": {
-						requestParams: map[string]BidderParamMapper{
-							"param-2": {
-								location: []string{"path-2"},
+			want: want{
+				bidderCfg: &BidderConfig{
+					bidderConfigMap: map[string]*config{
+						"test": {
+							requestParams: map[string]BidderParamMapper{
+								"param-2": {
+									Location: "path-2",
+								},
 							},
 						},
 					},
@@ -128,8 +92,8 @@ func TestSetRequestParams(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			tt.fields.bidderConfig.setRequestParams(tt.args.bidderName, tt.args.requestParams)
-			assert.Equal(t, tt.want, tt.fields.bidderConfig, "mismatched bidderConfig")
+			tt.fields.bidderConfig.SetRequestParams(tt.args.bidderName, tt.args.requestParams)
+			assert.Equal(t, tt.want.bidderCfg, tt.fields.bidderConfig, "mismatched bidderConfig")
 		})
 	}
 }
@@ -143,27 +107,13 @@ func TestGetBidderRequestProperties(t *testing.T) {
 	}
 	type want struct {
 		requestParams map[string]BidderParamMapper
-		found         bool
 	}
 	tests := []struct {
 		name   string
 		fields fields
 		args   args
 		want   want
 	}{
-		{
-			name: "BidderConfig_is_nil",
-			fields: fields{
-				biddersConfig: nil,
-			},
-			args: args{
-				bidderName: "test",
-			},
-			want: want{
-				requestParams: nil,
-				found:         false,
-			},
-		},
 		{
 			name: "BidderConfigMap_is_nil",
 			fields: fields{
@@ -176,7 +126,6 @@ func TestGetBidderRequestProperties(t *testing.T) {
 			},
 			want: want{
 				requestParams: nil,
-				found:         false,
 			},
 		},
 		{
@@ -193,7 +142,6 @@ func TestGetBidderRequestProperties(t *testing.T) {
 			},
 			want: want{
 				requestParams: nil,
-				found:         false,
 			},
 		},
 		{
@@ -210,7 +158,6 @@ func TestGetBidderRequestProperties(t *testing.T) {
 			},
 			want: want{
 				requestParams: nil,
-				found:         false,
 			},
 		},
 		{
@@ -221,7 +168,7 @@ func TestGetBidderRequestProperties(t *testing.T) {
 						"test": {
 							requestParams: map[string]BidderParamMapper{
 								"param-1": {
-									location: []string{"value-1"},
+									Location: "value-1",
 								},
 							},
 						},
@@ -234,88 +181,16 @@ func TestGetBidderRequestProperties(t *testing.T) {
 			want: want{
 				requestParams: map[string]BidderParamMapper{
 					"param-1": {
-						location: []string{"value-1"},
+						Location: "value-1",
 					},
 				},
-				found: true,
 			},
 		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			params, found := tt.fields.biddersConfig.GetRequestParams(tt.args.bidderName)
+			params := tt.fields.biddersConfig.GetRequestParams(tt.args.bidderName)
 			assert.Equal(t, tt.want.requestParams, params, "mismatched requestParams")
-			assert.Equal(t, tt.want.found, found, "mismatched found value")
-		})
-	}
-}
-
-func TestBidderParamMapperGetLocation(t *testing.T) {
-	tests := []struct {
-		name string
-		bpm  BidderParamMapper
-		want []string
-	}{
-		{
-			name: "location_is_nil",
-			bpm: BidderParamMapper{
-				location: nil,
-			},
-			want: nil,
-		},
-		{
-			name: "location_is_non_empty",
-			bpm: BidderParamMapper{
-				location: []string{"req", "ext"},
-			},
-			want: []string{"req", "ext"},
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			got := tt.bpm.GetLocation()
-			assert.Equal(t, tt.want, got, "mismatched location")
-		})
-	}
-}
-
-func TestBidderParamMapperSetLocation(t *testing.T) {
-	type args struct {
-		location []string
-	}
-	tests := []struct {
-		name string
-		bpm  BidderParamMapper
-		args args
-		want BidderParamMapper
-	}{
-		{
-			name: "set_location",
-			bpm:  BidderParamMapper{},
-			args: args{
-				location: []string{"req", "ext"},
-			},
-			want: BidderParamMapper{
-				location: []string{"req", "ext"},
-			},
-		},
-		{
-			name: "override_location",
-			bpm: BidderParamMapper{
-				location: []string{"imp", "ext"},
-			},
-			args: args{
-				location: []string{"req", "ext"},
-			},
-			want: BidderParamMapper{
-				location: []string{"req", "ext"},
-			},
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			tt.bpm.SetLocation(tt.args.location)
-			assert.Equal(t, tt.want, tt.bpm, "mismatched location")
 		})
 	}
 }
diff --git a/adapters/ortbbidder/bidderparams/parser.go b/adapters/ortbbidder/bidderparams/parser.go
@@ -19,7 +19,7 @@ func LoadBidderConfig(dirPath string, isBidderAllowed func(string) bool) (*Bidde
 	if err != nil {
 		return nil, fmt.Errorf("error:[%s] dirPath:[%s]", err.Error(), dirPath)
 	}
-	bidderConfigMap := &BidderConfig{bidderConfigMap: make(map[string]*config)}
+	bidderConfigMap := NewBidderConfig()
 	for _, file := range files {
 		bidderName, ok := strings.CutSuffix(file.Name(), ".json")
 		if !ok {
@@ -36,7 +36,7 @@ func LoadBidderConfig(dirPath string, isBidderAllowed func(string) bool) (*Bidde
 		if err != nil {
 			return nil, err
 		}
-		bidderConfigMap.setRequestParams(bidderName, requestParams)
+		bidderConfigMap.SetRequestParams(bidderName, requestParams)
 	}
 	return bidderConfigMap, nil
 }
@@ -78,7 +78,7 @@ func prepareRequestParams(bidderName string, requestParamsConfig map[string]any)
 			return nil, fmt.Errorf("error:[incorrect_location_in_bidderparam] bidder:[%s] bidderParam:[%s]", bidderName, paramName)
 		}
 		requestParams[paramName] = BidderParamMapper{
-			location: strings.Split(locationStr, "."),
+			Location: locationStr,
 		}
 	}
 	return requestParams, nil