OTT-1726: analytics throttling based on feature and vault configurati…

…on (#778)

Co-authored-by: Viral Vala <viral.vala@pubmatic.com>

Makefile

@@ -38,7 +38,7 @@ format:
 formatcheck:
 	./scripts/format.sh -f false
 
-mockgen: mockgeninstall mockgendb mockgencache mockgenmetrics
+mockgen: mockgeninstall mockgendb mockgencache mockgenmetrics mockgenlogger mockgenpublisherfeature
 
 # export GOPATH=~/go ; GOBIN=~/go/bin; export PATH=$PATH:$GOBIN   
 mockgeninstall:

analytics/pubmatic/logger.go

@@ -32,7 +32,7 @@ var getUUID = func() string {
 
 // GetLogAuctionObjectAsURL will form the owlogger-url and http-headers
 func GetLogAuctionObjectAsURL(ao analytics.AuctionObject, rCtx *models.RequestCtx, logInfo, forRespExt bool) (string, http.Header) {
-	if ao.RequestWrapper == nil || ao.RequestWrapper.BidRequest == nil || rCtx == nil || rCtx.PubID == 0 {
+	if ao.RequestWrapper == nil || ao.RequestWrapper.BidRequest == nil || rCtx == nil || rCtx.PubID == 0 || rCtx.LoggerDisabled {
 		return "", nil
 	}
 

analytics/pubmatic/logger_test.go

@@ -3368,6 +3368,28 @@ func TestGetLogAuctionObjectAsURL(t *testing.T) {
 		args args
 		want want
 	}{
+		{
+			name: "logger_disabled",
+			args: args{
+				ao: analytics.AuctionObject{
+					RequestWrapper: &openrtb_ext.RequestWrapper{
+						BidRequest: &openrtb2.BidRequest{},
+					},
+					Response: &openrtb2.BidResponse{},
+				},
+				rCtx: &models.RequestCtx{
+					Endpoint:       models.EndpointV25,
+					LoggerDisabled: true,
+					PubID:          5890,
+				},
+				logInfo:    true,
+				forRespExt: true,
+			},
+			want: want{
+				logger: "",
+				header: nil,
+			},
+		},
 		{
 			name: "do not prepare owlogger if pubid is missing",
 			args: args{

analytics/pubmatic/pubmatic.go

@@ -54,6 +54,11 @@ func (ow HTTPLogger) LogAuctionObject(ao *analytics.AuctionObject) {
 		return
 	}
 
+	if rCtx.LoggerDisabled {
+		// logger disabled explicitly for publisher,profile request
+		return
+	}
+
 	url, headers := GetLogAuctionObjectAsURL(*ao, rCtx, false, false)
 	if url == "" {
 		glog.Errorf("Failed to prepare the owlogger for pub:[%d], profile:[%d], version:[%d].",

analytics/pubmatic/pubmatic_test.go

@@ -72,6 +72,38 @@ func TestLogAuctionObject(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "logger_disabled",
+			ao: &analytics.AuctionObject{
+				HookExecutionOutcome: []hookexecution.StageOutcome{
+					{
+						Groups: []hookexecution.GroupOutcome{
+							{
+								InvocationResults: []hookexecution.HookOutcome{
+									{
+										AnalyticsTags: hookanalytics.Analytics{
+											Activities: []hookanalytics.Activity{
+												{
+													Results: []hookanalytics.Result{
+														{
+															Values: map[string]interface{}{
+																"request-ctx": &models.RequestCtx{
+																	LoggerDisabled: true,
+																},
+															},
+														},
+													},
+												},
+											},
+										},
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+		},
 	}
 	for _, tt := range tests {
 		HTTPLogger{}.LogAuctionObject(tt.ao)

exchange/events.go

@@ -19,6 +19,7 @@ type eventTracking struct {
 	accountID          string
 	enabledForAccount  bool
 	enabledForRequest  bool
+	enabledVideoEvents bool //TODO: OPENWRAP Video Events Flag
 	auctionTimestampMs int64
 	integrationType    string
 	bidderInfos        config.BidderInfos
@@ -31,6 +32,7 @@ func getEventTracking(requestExtPrebid *openrtb_ext.ExtRequestPrebid, ts time.Ti
 		accountID:          account.ID,
 		enabledForAccount:  account.Events.Enabled,
 		enabledForRequest:  requestExtPrebid != nil && requestExtPrebid.Events != nil,
+		enabledVideoEvents: requestExtPrebid == nil || !requestExtPrebid.ExtOWRequestPrebid.TrackerDisabled,
 		auctionTimestampMs: ts.UnixNano() / 1e+6,
 		integrationType:    getIntegrationType(requestExtPrebid),
 		bidderInfos:        bidderInfos,
@@ -79,9 +81,11 @@ func (ev *eventTracking) modifyBidVAST(pbsBid *entities.PbsOrtbBid, bidderName o
 		}
 	}
 
-	// always inject event  trackers without checkign isModifyingVASTXMLAllowed
-	if newVastXML, injected, _ := events.InjectVideoEventTrackers(trackerURL, vastXML, bid, bidID, bidderName.String(), bidderCoreName.String(), ev.accountID, ev.auctionTimestampMs, req); injected {
-		bid.AdM = string(newVastXML)
+	if ev.enabledVideoEvents {
+		// always inject event  trackers without checkign isModifyingVASTXMLAllowed
+		if newVastXML, injected, _ := events.InjectVideoEventTrackers(trackerURL, vastXML, bid, bidID, bidderName.String(), bidderCoreName.String(), ev.accountID, ev.auctionTimestampMs, req); injected {
+			bid.AdM = string(newVastXML)
+		}
 	}
 }
 

exchange/events_test.go

@@ -197,8 +197,9 @@ func Test_isEventAllowed(t *testing.T) {
 
 func TestModifyBidVAST(t *testing.T) {
 	type args struct {
-		bidReq *openrtb2.BidRequest
-		bid    *openrtb2.Bid
+		enabledVideoEvents bool
+		bidReq             *openrtb2.BidRequest
+		bid                *openrtb2.Bid
 	}
 	type want struct {
 		tags []string
@@ -211,6 +212,7 @@ func TestModifyBidVAST(t *testing.T) {
 		{
 			name: "empty_adm", // expect adm contain vast tag with tracking events and  VASTAdTagURI nurl contents
 			args: args{
+				enabledVideoEvents: true,
 				bidReq: &openrtb2.BidRequest{
 					Imp: []openrtb2.Imp{{ID: "123", Video: &openrtb2.Video{}}},
 				},
@@ -242,6 +244,7 @@ func TestModifyBidVAST(t *testing.T) {
 		{
 			name: "adm_containing_url", // expect adm contain vast tag with tracking events and  VASTAdTagURI adm url (previous value) contents
 			args: args{
+				enabledVideoEvents: true,
 				bidReq: &openrtb2.BidRequest{
 					Imp: []openrtb2.Imp{{ID: "123", Video: &openrtb2.Video{}}},
 				},
@@ -279,6 +282,7 @@ func TestModifyBidVAST(t *testing.T) {
 						ModifyingVastXmlAllowed: false,
 					},
 				},
+				enabledVideoEvents: tc.args.enabledVideoEvents,
 			}
 			ev.modifyBidVAST(&entities.PbsOrtbBid{
 				Bid:     tc.args.bid,