OTT-1704: Bidder Response mapping framework for ortb bidder

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

@@ -43,6 +43,10 @@ class diffHelper {
     let diff = {}
     for (const { filename, patch } of files) {
       if (this.fileNameFilter(filename)) {
+        if (!patch) {
+          console.log(`No patch found for file: ${filename}`)
+          continue
+        }
         const lines = patch.split("\n")
         if (lines.length === 1) {
           continue

adapters/ortbbidder/bidderparams/config.go

@@ -5,40 +5,44 @@ type BidderParamMapper struct {
 	Location string // do not update this parameter for each request, its being shared across all requests
 }
 
-// config contains mappings requestParams and responseParams
-type config struct {
-	requestParams  map[string]BidderParamMapper
-	responseParams map[string]BidderParamMapper
+// Config contains mappings RequestParams and ResponseParams
+type Config struct {
+	RequestParams  map[string]BidderParamMapper
+	ResponseParams map[string]BidderParamMapper
 }
 
-// BidderConfig contains map of bidderName to its requestParams and responseParams
+// BidderConfig contains map of bidderName to its RequestParams and ResponseParams
 type BidderConfig struct {
-	bidderConfigMap map[string]*config
+	BidderConfigMap map[string]*Config
 }
 
 // NewBidderConfig initializes and returns the object of BidderConfig
 func NewBidderConfig() *BidderConfig {
 	return &BidderConfig{
-		bidderConfigMap: make(map[string]*config),
+		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{}
+// GetRequestParams returns bidder specific ResponseParams
+func (bcfg *BidderConfig) GetRequestParams(bidderName string) map[string]BidderParamMapper {
+	if len(bcfg.BidderConfigMap) == 0 {
+		return nil
 	}
-	bcfg.bidderConfigMap[bidderName].requestParams = requestParams
+	bidderConfig := bcfg.BidderConfigMap[bidderName]
+	if bidderConfig == nil {
+		return nil
+	}
+	return bidderConfig.RequestParams
 }
 
-// GetRequestParams returns bidder specific requestParams
-func (bcfg *BidderConfig) GetRequestParams(bidderName string) map[string]BidderParamMapper {
-	if len(bcfg.bidderConfigMap) == 0 {
+// GetResponseParams returns bidder specific ResponseParams
+func (bcfg *BidderConfig) GetResponseParams(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
+		return map[string]BidderParamMapper{}
 	}
-	return bidderConfig.requestParams
+	return bidderConfig.ResponseParams
 }

adapters/ortbbidder/bidderparams/config_test.go

@@ -6,98 +6,6 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func TestSetRequestParams(t *testing.T) {
-	type fields struct {
-		bidderConfig *BidderConfig
-	}
-	type args struct {
-		bidderName    string
-		requestParams map[string]BidderParamMapper
-	}
-	type want struct {
-		bidderCfg *BidderConfig
-	}
-	tests := []struct {
-		name   string
-		fields fields
-		args   args
-		want   want
-	}{
-		{
-			name: "bidderName_not_found",
-			fields: fields{
-				bidderConfig: &BidderConfig{
-					bidderConfigMap: map[string]*config{},
-				},
-			},
-			args: args{
-				bidderName: "test",
-				requestParams: map[string]BidderParamMapper{
-					"param-1": {
-						Location: "path",
-					},
-				},
-			},
-			want: want{
-				bidderCfg: &BidderConfig{
-					bidderConfigMap: map[string]*config{
-						"test": {
-							requestParams: map[string]BidderParamMapper{
-								"param-1": {
-									Location: "path",
-								},
-							},
-						},
-					},
-				},
-			},
-		},
-		{
-			name: "bidderName_found",
-			fields: fields{
-				bidderConfig: &BidderConfig{
-					bidderConfigMap: map[string]*config{
-						"test": {
-							requestParams: map[string]BidderParamMapper{
-								"param-1": {
-									Location: "path-1",
-								},
-							},
-						},
-					},
-				},
-			},
-			args: args{
-				bidderName: "test",
-				requestParams: map[string]BidderParamMapper{
-					"param-2": {
-						Location: "path-2",
-					},
-				},
-			},
-			want: want{
-				bidderCfg: &BidderConfig{
-					bidderConfigMap: map[string]*config{
-						"test": {
-							requestParams: map[string]BidderParamMapper{
-								"param-2": {
-									Location: "path-2",
-								},
-							},
-						},
-					},
-				},
-			},
-		},
-	}
-	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.bidderCfg, tt.fields.bidderConfig, "mismatched bidderConfig")
-		})
-	}
-}
-
 func TestGetBidderRequestProperties(t *testing.T) {
 	type fields struct {
 		biddersConfig *BidderConfig
@@ -106,7 +14,7 @@ func TestGetBidderRequestProperties(t *testing.T) {
 		bidderName string
 	}
 	type want struct {
-		requestParams map[string]BidderParamMapper
+		RequestParams map[string]BidderParamMapper
 	}
 	tests := []struct {
 		name   string
@@ -118,21 +26,21 @@ func TestGetBidderRequestProperties(t *testing.T) {
 			name: "BidderConfigMap_is_nil",
 			fields: fields{
 				biddersConfig: &BidderConfig{
-					bidderConfigMap: nil,
+					BidderConfigMap: nil,
 				},
 			},
 			args: args{
 				bidderName: "test",
 			},
 			want: want{
-				requestParams: nil,
+				RequestParams: nil,
 			},
 		},
 		{
 			name: "BidderName_absent_in_biddersConfigMap",
 			fields: fields{
 				biddersConfig: &BidderConfig{
-					bidderConfigMap: map[string]*config{
+					BidderConfigMap: map[string]*Config{
 						"ortb": {},
 					},
 				},
@@ -141,14 +49,14 @@ func TestGetBidderRequestProperties(t *testing.T) {
 				bidderName: "test",
 			},
 			want: want{
-				requestParams: nil,
+				RequestParams: nil,
 			},
 		},
 		{
-			name: "BidderName_present_but_config_is_nil",
+			name: "BidderName_present_but_Config_is_nil",
 			fields: fields{
 				biddersConfig: &BidderConfig{
-					bidderConfigMap: map[string]*config{
+					BidderConfigMap: map[string]*Config{
 						"ortb": nil,
 					},
 				},
@@ -157,16 +65,16 @@ func TestGetBidderRequestProperties(t *testing.T) {
 				bidderName: "test",
 			},
 			want: want{
-				requestParams: nil,
+				RequestParams: nil,
 			},
 		},
 		{
 			name: "BidderName_present_in_biddersConfigMap",
 			fields: fields{
 				biddersConfig: &BidderConfig{
-					bidderConfigMap: map[string]*config{
+					BidderConfigMap: map[string]*Config{
 						"test": {
-							requestParams: map[string]BidderParamMapper{
+							RequestParams: map[string]BidderParamMapper{
 								"param-1": {
 									Location: "value-1",
 								},
@@ -179,7 +87,7 @@ func TestGetBidderRequestProperties(t *testing.T) {
 				bidderName: "test",
 			},
 			want: want{
-				requestParams: map[string]BidderParamMapper{
+				RequestParams: map[string]BidderParamMapper{
 					"param-1": {
 						Location: "value-1",
 					},
@@ -190,7 +98,64 @@ func TestGetBidderRequestProperties(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			params := tt.fields.biddersConfig.GetRequestParams(tt.args.bidderName)
-			assert.Equal(t, tt.want.requestParams, params, "mismatched requestParams")
+			assert.Equal(t, tt.want.RequestParams, params, "mismatched RequestParams")
+		})
+	}
+}
+
+func TestGetResponseParams(t *testing.T) {
+	tests := []struct {
+		name            string
+		bidderName      string
+		BidderConfigMap map[string]*Config
+		expected        map[string]BidderParamMapper
+	}{
+		{
+			name:       "Get response params for existing bidder",
+			bidderName: "existingBidder",
+			BidderConfigMap: map[string]*Config{
+				"existingBidder": {
+					ResponseParams: map[string]BidderParamMapper{
+						"param1": {
+							Location: "location",
+						},
+					},
+				},
+			},
+			expected: map[string]BidderParamMapper{
+				"param1": {
+					Location: "location",
+				},
+			},
+		},
+		{
+			name:       "Get response params for non-existing bidder",
+			bidderName: "nonExistingBidder",
+			BidderConfigMap: map[string]*Config{
+				"existingBidder": {
+					ResponseParams: map[string]BidderParamMapper{
+						"param1": {
+							Location: "location",
+						},
+					},
+				},
+			},
+			expected: map[string]BidderParamMapper{},
+		},
+		{
+			name:            "Get response params for empty bidder Config map",
+			bidderName:      "anyBidder",
+			BidderConfigMap: map[string]*Config{},
+			expected:        nil,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			bcfg := &BidderConfig{
+				BidderConfigMap: tt.BidderConfigMap,
+			}
+			got := bcfg.GetResponseParams(tt.bidderName)
+			assert.Equal(t, tt.expected, got)
 		})
 	}
 }