OTT-1390,UOE-9175: add missing fields in owlogger & tracker so that OW module can run independently

Makefile

@@ -52,3 +52,7 @@ mockgencache:
 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
+
+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

analytics/pubmatic/helper.go

@@ -2,42 +2,21 @@ package pubmatic
 
 import (
 	"encoding/json"
-	"errors"
-	"fmt"
 	"net/http"
 	"net/url"
 	"strconv"
+	"time"
 
-	"github.com/prebid/openrtb/v19/openrtb2"
+	"github.com/golang/glog"
+	"github.com/prebid/prebid-server/analytics/pubmatic/mhttp"
 	"github.com/prebid/prebid-server/modules/pubmatic/openwrap/models"
-	"github.com/prebid/prebid-server/openrtb_ext"
 )
 
-// Send method
-func Send(url string, headers http.Header) error {
-	mhc := NewMultiHttpContext()
-	hc, err := NewHttpCall(url, "")
-	if err != nil {
-		return err
-	}
-
-	for k, v := range headers {
-		if len(v) != 0 {
-			hc.AddHeader(k, v[0])
-		}
-	}
-
-	mhc.AddHttpCall(hc)
-	_, erc := mhc.Execute()
-	if erc != 0 {
-		return errors.New("error in sending logger pixel")
-	}
-
-	return nil
-}
-
 // PrepareLoggerURL returns the url for OW logger call
 func PrepareLoggerURL(wlog *WloggerRecord, loggerURL string, gdprEnabled int) string {
+	if wlog == nil {
+		return ""
+	}
 	v := url.Values{}
 
 	jsonString, err := json.Marshal(wlog.record)
@@ -56,87 +35,40 @@ func PrepareLoggerURL(wlog *WloggerRecord, loggerURL string, gdprEnabled int) st
 	return finalLoggerURL
 }
 
-func (wlog *WloggerRecord) logContentObject(content *openrtb2.Content) {
-	if nil == content {
-		return
-	}
-
-	wlog.Content = &Content{
-		ID:      content.ID,
-		Episode: int(content.Episode),
-		Title:   content.Title,
-		Series:  content.Series,
-		Season:  content.Season,
-		Cat:     content.Cat,
-	}
-}
-func getSizeForPlatform(width, height int64, platform string) string {
-	s := models.GetSize(width, height)
-	if platform == models.PLATFORM_VIDEO {
-		s = s + models.VideoSizeSuffix
+// getGdprEnabledFlag returns gdpr flag set in the partner config
+func getGdprEnabledFlag(partnerConfigMap map[int]map[string]string) int {
+	gdpr := 0
+	if val := partnerConfigMap[models.VersionLevelConfigID][models.GDPR_ENABLED]; val != "" {
+		gdpr, _ = strconv.Atoi(val)
 	}
-	return s
+	return gdpr
 }
 
-// set partnerRecord MetaData
-func (partnerRecord *PartnerRecord) setMetaDataObject(meta *openrtb_ext.ExtBidPrebidMeta) {
+// send function will send the owlogger to analytics endpoint
+func send(rCtx *models.RequestCtx, url string, headers http.Header, mhc mhttp.MultiHttpContextInterface) {
+	startTime := time.Now()
+	hc, _ := mhttp.NewHttpCall(url, "")
 
-	if meta.NetworkID != 0 || meta.AdvertiserID != 0 || len(meta.SecondaryCategoryIDs) > 0 {
-		partnerRecord.MetaData = &MetaData{
-			NetworkID:            meta.NetworkID,
-			AdvertiserID:         meta.AdvertiserID,
-			PrimaryCategoryID:    meta.PrimaryCategoryID,
-			AgencyID:             meta.AgencyID,
-			DemandSource:         meta.DemandSource,
-			SecondaryCategoryIDs: meta.SecondaryCategoryIDs,
+	for k, v := range headers {
+		if len(v) != 0 {
+			hc.AddHeader(k, v[0])
 		}
 	}
-	//NOTE : We Don't get following Data points in Response, whenever got from translator,
-	//they can be populated.
-	//partnerRecord.MetaData.NetworkName = meta.NetworkName
-	//partnerRecord.MetaData.AdvertiserName = meta.AdvertiserName
-	//partnerRecord.MetaData.AgencyName = meta.AgencyName
-	//partnerRecord.MetaData.BrandName = meta.BrandName
-	//partnerRecord.MetaData.BrandID = meta.BrandID
-	//partnerRecord.MetaData.DChain = meta.DChain (type is json.RawMessage)
-}
 
-// Harcode would be the optimal. We could make it configurable like _AU_@_W_x_H_:%s@%dx%d entries in pbs.yaml
-// mysql> SELECT DISTINCT key_gen_pattern FROM wrapper_mapping_template;
-// +----------------------+
-// | key_gen_pattern      |
-// +----------------------+
-// | _AU_@_W_x_H_         |
-// | _DIV_@_W_x_H_        |
-// | _W_x_H_@_W_x_H_      |
-// | _DIV_                |
-// | _AU_@_DIV_@_W_x_H_   |
-// | _AU_@_SRC_@_VASTTAG_ |
-// +----------------------+
-// 6 rows in set (0.21 sec)
-func GenerateSlotName(h, w int64, kgp, tagid, div, src string) string {
-	// func (H, W, Div), no need to validate, will always be non-nil
-	switch kgp {
-	case "_AU_": // adunitconfig
-		return tagid
-	case "_DIV_":
-		return div
-	case "_AU_@_W_x_H_":
-		return fmt.Sprintf("%s@%dx%d", tagid, w, h)
-	case "_DIV_@_W_x_H_":
-		return fmt.Sprintf("%s@%dx%d", div, w, h)
-	case "_W_x_H_@_W_x_H_":
-		return fmt.Sprintf("%dx%d@%dx%d", w, h, w, h)
-	case "_AU_@_DIV_@_W_x_H_":
-		if div == "" {
-			return fmt.Sprintf("%s@%s@s%dx%d", tagid, div, w, h)
-		}
-		return fmt.Sprintf("%s@%s@s%dx%d", tagid, div, w, h)
-	case "_AU_@_SRC_@_VASTTAG_":
-		return fmt.Sprintf("%s@%s@s_VASTTAG_", tagid, src) //TODO check where/how _VASTTAG_ is updated
-	default:
-		// TODO: check if we need to fallback to old generic flow (below)
-		// Add this cases in a map and read it from yaml file
+	if rCtx.KADUSERCookie != nil {
+		hc.AddCookie(models.KADUSERCOOKIE, rCtx.KADUSERCookie.Value)
+	}
+
+	mhc.AddHttpCall(hc)
+	_, erc := mhc.Execute()
+	if erc != 0 {
+		glog.Errorf("Failed to send the owlogger for pub:[%d], profile:[%d], version:[%d].",
+			rCtx.PubID, rCtx.ProfileID, rCtx.VersionID)
+
+		// we will not record at version level in prometheus metric
+		rCtx.MetricsEngine.RecordPublisherWrapperLoggerFailure(rCtx.PubIDStr, rCtx.ProfileIDStr, "")
+		return
 	}
-	return ""
+	rCtx.MetricsEngine.RecordSendLoggerDataTime(rCtx.Endpoint, rCtx.ProfileIDStr, time.Since(startTime))
+	// TODO: this will increment HB specific metric (ow_pbs_sshb_*), verify labels
 }

analytics/pubmatic/helper_test.go

@@ -0,0 +1,220 @@
+package pubmatic
+
+import (
+	"net/http"
+	"net/url"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/prebid/prebid-server/analytics/pubmatic/mhttp"
+	mock_mhttp "github.com/prebid/prebid-server/analytics/pubmatic/mhttp/mock"
+	mock_metrics "github.com/prebid/prebid-server/modules/pubmatic/openwrap/metrics/mock"
+	"github.com/prebid/prebid-server/modules/pubmatic/openwrap/models"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestPrepareLoggerURL(t *testing.T) {
+	type args struct {
+		wlog        *WloggerRecord
+		loggerURL   string
+		gdprEnabled int
+	}
+	tests := []struct {
+		name     string
+		args     args
+		owlogger string
+	}{
+		{
+			name: "nil_wlog",
+			args: args{
+				wlog:        nil,
+				loggerURL:   "http://t.pubmatic.com/wl",
+				gdprEnabled: 1,
+			},
+			owlogger: "",
+		},
+		{
+			name: "gdprEnabled=1",
+			args: args{
+				wlog: &WloggerRecord{
+					record: record{
+						PubID:     10,
+						ProfileID: "1",
+						VersionID: "0",
+					},
+				},
+				loggerURL:   "http://t.pubmatic.com/wl",
+				gdprEnabled: 1,
+			},
+			owlogger: `http://t.pubmatic.com/wl?gdEn=1&json={"pubid":10,"pid":"1","pdvid":"0","dvc":{},"ft":0}&pubid=10`,
+		},
+		{
+			name: "gdprEnabled=0",
+			args: args{
+				wlog: &WloggerRecord{
+					record: record{
+						PubID:     10,
+						ProfileID: "1",
+						VersionID: "0",
+					},
+				},
+				loggerURL:   "http://t.pubmatic.com/wl",
+				gdprEnabled: 0,
+			},
+			owlogger: `http://t.pubmatic.com/wl?json={"pubid":10,"pid":"1","pdvid":"0","dvc":{},"ft":0}&pubid=10`,
+		},
+		{
+			name: "private endpoint",
+			args: args{
+				wlog: &WloggerRecord{
+					record: record{
+						PubID:     5,
+						ProfileID: "5",
+						VersionID: "1",
+					},
+				},
+				loggerURL:   "http://10.172.141.11/wl",
+				gdprEnabled: 0,
+			},
+			owlogger: `http://10.172.141.11/wl?json={"pubid":5,"pid":"5","pdvid":"1","dvc":{},"ft":0}&pubid=5`,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			owlogger := PrepareLoggerURL(tt.args.wlog, tt.args.loggerURL, tt.args.gdprEnabled)
+			decodedOwlogger, _ := url.QueryUnescape(owlogger)
+			assert.Equal(t, tt.owlogger, decodedOwlogger, tt.name)
+		})
+	}
+}
+func TestGetGdprEnabledFlag(t *testing.T) {
+	tests := []struct {
+		name          string
+		partnerConfig map[int]map[string]string
+		gdprFlag      int
+	}{
+		{
+			name:          "Empty partnerConfig",
+			partnerConfig: make(map[int]map[string]string),
+			gdprFlag:      0,
+		},
+		{
+			name: "partnerConfig without versionlevel cfg",
+			partnerConfig: map[int]map[string]string{
+				2: {models.GDPR_ENABLED: "1"},
+			},
+			gdprFlag: 0,
+		},
+		{
+			name: "partnerConfig without GDPR_ENABLED",
+			partnerConfig: map[int]map[string]string{
+				models.VersionLevelConfigID: {"any": "1"},
+			},
+			gdprFlag: 0,
+		},
+		{
+			name: "partnerConfig with invalid GDPR_ENABLED",
+			partnerConfig: map[int]map[string]string{
+				models.VersionLevelConfigID: {models.GDPR_ENABLED: "non-int"},
+			},
+			gdprFlag: 0,
+		},
+		{
+			name: "partnerConfig with GDPR_ENABLED=1",
+			partnerConfig: map[int]map[string]string{
+				models.VersionLevelConfigID: {models.GDPR_ENABLED: "1"},
+			},
+			gdprFlag: 1,
+		},
+		{
+			name: "partnerConfig with GDPR_ENABLED=2",
+			partnerConfig: map[int]map[string]string{
+				models.VersionLevelConfigID: {models.GDPR_ENABLED: "2"},
+			},
+			gdprFlag: 2,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			gdprFlag := getGdprEnabledFlag(tt.partnerConfig)
+			assert.Equal(t, tt.gdprFlag, gdprFlag, tt.name)
+		})
+	}
+}
+func TestSendMethod(t *testing.T) {
+	// initialise global variables
+	mhttp.Init(1, 1, 1, 2000)
+	// init mock
+	ctrl := gomock.NewController(t)
+	defer ctrl.Finish()
+
+	type args struct {
+		rctx    *models.RequestCtx
+		url     string
+		headers http.Header
+	}
+	tests := []struct {
+		name                    string
+		args                    args
+		getMetricsEngine        func() *mock_metrics.MockMetricsEngine
+		getMockMultiHttpContext func() *mock_mhttp.MockMultiHttpContextInterface
+	}{
+		{
+			name: "send success",
+			args: args{
+				rctx: &models.RequestCtx{
+					PubIDStr:     "5890",
+					ProfileIDStr: "1",
+					Endpoint:     models.EndpointV25,
+				},
+				url: "http://10.172.11.11/wl",
+				headers: http.Header{
+					"key": []string{"val"},
+				},
+			},
+			getMetricsEngine: func() *mock_metrics.MockMetricsEngine {
+				mockEngine := mock_metrics.NewMockMetricsEngine(ctrl)
+				mockEngine.EXPECT().RecordSendLoggerDataTime(models.EndpointV25, "1", gomock.Any())
+				return mockEngine
+			},
+			getMockMultiHttpContext: func() *mock_mhttp.MockMultiHttpContextInterface {
+				mockHttpCtx := mock_mhttp.NewMockMultiHttpContextInterface(ctrl)
+				mockHttpCtx.EXPECT().AddHttpCall(gomock.Any())
+				mockHttpCtx.EXPECT().Execute().Return(0, 0)
+				return mockHttpCtx
+			},
+		},
+		{
+			name: "send fail",
+			args: args{
+				rctx: &models.RequestCtx{
+					PubIDStr:      "5890",
+					ProfileIDStr:  "1",
+					Endpoint:      models.EndpointV25,
+					KADUSERCookie: &http.Cookie{},
+				},
+				url: "http://10.172.11.11/wl",
+				headers: http.Header{
+					"key": []string{"val"},
+				},
+			},
+			getMetricsEngine: func() *mock_metrics.MockMetricsEngine {
+				mockEngine := mock_metrics.NewMockMetricsEngine(ctrl)
+				mockEngine.EXPECT().RecordPublisherWrapperLoggerFailure("5890", "1", "")
+				return mockEngine
+			},
+			getMockMultiHttpContext: func() *mock_mhttp.MockMultiHttpContextInterface {
+				mockHttpCtx := mock_mhttp.NewMockMultiHttpContextInterface(ctrl)
+				mockHttpCtx.EXPECT().AddHttpCall(gomock.Any())
+				mockHttpCtx.EXPECT().Execute().Return(0, 1)
+				return mockHttpCtx
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			tt.args.rctx.MetricsEngine = tt.getMetricsEngine()
+			send(tt.args.rctx, tt.args.url, tt.args.headers, tt.getMockMultiHttpContext())
+		})
+	}
+}