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

analytics/pubmatic/helper.go

@@ -2,40 +2,13 @@ package pubmatic
 
 import (
 	"encoding/json"
-	"errors"
 	"fmt"
-	"net/http"
 	"net/url"
 	"strconv"
 
-	"github.com/prebid/openrtb/v19/openrtb2"
 	"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 {
 	v := url.Values{}
@@ -56,20 +29,6 @@ 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 {
@@ -78,27 +37,11 @@ func getSizeForPlatform(width, height int64, platform string) string {
 	return s
 }
 
-// set partnerRecord MetaData
-func (partnerRecord *PartnerRecord) setMetaDataObject(meta *openrtb_ext.ExtBidPrebidMeta) {
-
-	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,
-		}
+func convertBoolToInt(val bool) int {
+	if val {
+		return 1
 	}
-	//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)
+	return 0
 }
 
 // Harcode would be the optimal. We could make it configurable like _AU_@_W_x_H_:%s@%dx%d entries in pbs.yaml

analytics/pubmatic/helper_test.go

@@ -0,0 +1,256 @@
+package pubmatic
+
+import (
+	"net/url"
+	"testing"
+
+	"github.com/prebid/prebid-server/modules/pubmatic/openwrap/models"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestGetSizeForPlatform(t *testing.T) {
+	type args struct {
+		width, height int64
+		platform      string
+	}
+	tests := []struct {
+		name string
+		args args
+		size string
+	}{
+		{
+			name: "in-app platform",
+			args: args{
+				width:    100,
+				height:   10,
+				platform: models.PLATFORM_APP,
+			},
+			size: "100x10",
+		},
+		{
+			name: "video platform",
+			args: args{
+				width:    100,
+				height:   10,
+				platform: models.PLATFORM_VIDEO,
+			},
+			size: "100x10v",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			size := getSizeForPlatform(tt.args.width, tt.args.height, tt.args.platform)
+			assert.Equal(t, tt.size, size, tt.name)
+		})
+	}
+}
+
+func TestPrepareLoggerURL(t *testing.T) {
+	type args struct {
+		wlog        *WloggerRecord
+		loggerURL   string
+		gdprEnabled int
+	}
+	tests := []struct {
+		name     string
+		args     args
+		owlogger string
+	}{
+		{
+			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, decodedOwlogger, tt.owlogger, tt.name)
+		})
+	}
+}
+
+// TODO - remove this
+func TestGenerateSlotName(t *testing.T) {
+	type args struct {
+		h     int64
+		w     int64
+		kgp   string
+		tagid string
+		div   string
+		src   string
+	}
+	tests := []struct {
+		name string
+		args args
+		want string
+	}{
+		{
+			name: "_AU_",
+			args: args{
+				h:     100,
+				w:     200,
+				kgp:   "_AU_",
+				tagid: "/15671365/Test_Adunit",
+				div:   "Div1",
+				src:   "test.com",
+			},
+			want: "/15671365/Test_Adunit",
+		},
+		{
+			name: "_DIV_",
+			args: args{
+				h:     100,
+				w:     200,
+				kgp:   "_DIV_",
+				tagid: "/15671365/Test_Adunit",
+				div:   "Div1",
+				src:   "test.com",
+			},
+			want: "Div1",
+		},
+		{
+			name: "_AU_",
+			args: args{
+				h:     100,
+				w:     200,
+				kgp:   "_AU_",
+				tagid: "/15671365/Test_Adunit",
+				div:   "Div1",
+				src:   "test.com",
+			},
+			want: "/15671365/Test_Adunit",
+		},
+		{
+			name: "_AU_@_W_x_H_",
+			args: args{
+				h:     100,
+				w:     200,
+				kgp:   "_AU_@_W_x_H_",
+				tagid: "/15671365/Test_Adunit",
+				div:   "Div1",
+				src:   "test.com",
+			},
+			want: "/15671365/Test_Adunit@200x100",
+		},
+		{
+			name: "_DIV_@_W_x_H_",
+			args: args{
+				h:     100,
+				w:     200,
+				kgp:   "_DIV_@_W_x_H_",
+				tagid: "/15671365/Test_Adunit",
+				div:   "Div1",
+				src:   "test.com",
+			},
+			want: "Div1@200x100",
+		},
+		{
+			name: "_W_x_H_@_W_x_H_",
+			args: args{
+				h:     100,
+				w:     200,
+				kgp:   "_W_x_H_@_W_x_H_",
+				tagid: "/15671365/Test_Adunit",
+				div:   "Div1",
+				src:   "test.com",
+			},
+			want: "200x100@200x100",
+		},
+		// {
+		// 	name: "_AU_@_DIV_@_W_x_H_",
+		// 	args: args{
+		// 		h:     100,
+		// 		w:     200,
+		// 		kgp:   "_AU_@_DIV_@_W_x_H_",
+		// 		tagid: "/15671365/Test_Adunit",
+		// 		div:   "Div1",
+		// 		src:   "test.com",
+		// 	},
+		// 	want: "/15671365/Test_Adunit@Div1@200x100",
+		// },
+		// {
+		// 	name: "_AU_@_SRC_@_VASTTAG_",
+		// 	args: args{
+		// 		h:     100,
+		// 		w:     200,
+		// 		kgp:   "_AU_@_SRC_@_VASTTAG_",
+		// 		tagid: "/15671365/Test_Adunit",
+		// 		div:   "Div1",
+		// 		src:   "test.com",
+		// 	},
+		// 	want: "/15671365/[email protected]@_VASTTAG_",
+		// },
+		{
+			name: "empty_kgp",
+			args: args{
+				h:     100,
+				w:     200,
+				kgp:   "",
+				tagid: "/15671365/Test_Adunit",
+				div:   "Div1",
+				src:   "test.com",
+			},
+			want: "",
+		},
+		{
+			name: "random_kgp",
+			args: args{
+				h:     100,
+				w:     200,
+				kgp:   "fjkdfhk",
+				tagid: "/15671365/Test_Adunit",
+				div:   "Div1",
+				src:   "test.com",
+			},
+			want: "",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := GenerateSlotName(tt.args.h, tt.args.w, tt.args.kgp, tt.args.tagid, tt.args.div, tt.args.src)
+			assert.Equal(t, tt.want, got)
+		})
+	}
+}

analytics/pubmatic/http_util.go

@@ -9,6 +9,7 @@ package pubmatic
 
 import (
 	"bytes"
+	"errors"
 	"io/ioutil"
 
 	//"log"
@@ -216,3 +217,30 @@ func (hc *HttpCall) submit(wg *sync.WaitGroup) {
 	hc.respBody = string(body)
 	hc.err = err
 }
+
+// Send method
+func Send(url string, headers http.Header, cookies map[string]string) 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])
+		}
+	}
+
+	for k, v := range cookies {
+		hc.AddCookie(k, v)
+	}
+
+	mhc.AddHttpCall(hc)
+	_, erc := mhc.Execute()
+	if erc != 0 {
+		return errors.New("error in sending logger pixel")
+	}
+
+	return nil
+}