TID activity (#3012)

* Passed activity control to video endpoint * TID activity * Minor refactoring * Added exchange end-to-end tests
prebid · Aug 21, 2023 · 2023f4c · 2023f4c
1 parent 66c38fa
commit 2023f4c
Show file tree

Hide file tree

Showing 8 changed files with 282 additions and 7 deletions.
diff --git a/endpoints/openrtb2/video_auction.go b/endpoints/openrtb2/video_auction.go
@@ -21,6 +21,7 @@ import (
 	"github.com/prebid/prebid-server/hooks"
 	"github.com/prebid/prebid-server/hooks/hookexecution"
 	"github.com/prebid/prebid-server/ortb"
+	"github.com/prebid/prebid-server/privacy"
 	jsonpatch "gopkg.in/evanphx/json-patch.v4"
 
 	accountService "github.com/prebid/prebid-server/account"
@@ -302,6 +303,15 @@ func (deps *endpointDeps) VideoAuctionEndpoint(w http.ResponseWriter, r *http.Re
 		return
 	}
 
+	activities, activitiesErr := privacy.NewActivityControl(account.Privacy)
+	if activitiesErr != nil {
+		errL = append(errL, activitiesErr)
+		if errortypes.ContainsFatalError(errL) {
+			handleError(&labels, w, errL, &vo, &debugLog)
+			return
+		}
+	}
+
 	secGPC := r.Header.Get("Sec-GPC")
 	auctionRequest := &exchange.AuctionRequest{
 		BidRequestWrapper:          bidReqWrapper,
@@ -314,6 +324,7 @@ func (deps *endpointDeps) VideoAuctionEndpoint(w http.ResponseWriter, r *http.Re
 		PubID:                      labels.PubID,
 		HookExecutor:               hookexecution.EmptyHookExecutor{},
 		TmaxAdjustments:            deps.tmaxAdjustments,
+		Activities:                 activities,
 	}
 
 	auctionResponse, err := deps.ex.HoldAuction(ctx, auctionRequest, &debugLog)

diff --git a/endpoints/openrtb2/video_auction_test.go b/endpoints/openrtb2/video_auction_test.go
@@ -65,6 +65,20 @@ func TestVideoEndpointImpressionsNumber(t *testing.T) {
 	assert.Equal(t, resp.AdPods[0].Targeting[0].HbDeal, "ABC_123", "If DealID exists in bid response, hb_deal targeting needs to be added to resp")
 }
 
+func TestVideoEndpointInvalidPrivacyConfig(t *testing.T) {
+	ex := &mockExchangeVideo{}
+	reqBody := readVideoTestFile(t, "sample-requests/video/video_valid_sample.json")
+	req := httptest.NewRequest("POST", "/openrtb2/video", strings.NewReader(reqBody))
+	recorder := httptest.NewRecorder()
+
+	deps := mockDepsInvalidPrivacy(t, ex)
+	deps.VideoAuctionEndpoint(recorder, req, nil)
+
+	respBytes := recorder.Body.Bytes()
+	expectedErrorMessage := "Critical error while running the video endpoint:  unable to parse condition: bidderA.BidderB.bidderC"
+	assert.Equal(t, expectedErrorMessage, string(respBytes), "error message is incorrect")
+}
+
 func TestVideoEndpointImpressionsDuration(t *testing.T) {
 	ex := &mockExchangeVideo{}
 	reqBody := readVideoTestFile(t, "sample-requests/video/video_valid_sample_different_durations.json")
@@ -1275,6 +1289,40 @@ func mockDeps(t *testing.T, ex *mockExchangeVideo) *endpointDeps {
 	}
 }
 
+func mockDepsInvalidPrivacy(t *testing.T, ex *mockExchangeVideo) *endpointDeps {
+	return &endpointDeps{
+		fakeUUIDGenerator{},
+		ex,
+		mockBidderParamValidator{},
+		&mockVideoStoredReqFetcher{},
+		&mockVideoStoredReqFetcher{},
+		&mockAccountFetcher{data: mockVideoAccountData},
+		&config.Configuration{MaxRequestSize: maxSize,
+			AccountDefaults: config.Account{
+				Privacy: &config.AccountPrivacy{
+					AllowActivities: config.AllowActivities{
+						TransmitPreciseGeo: config.Activity{Rules: []config.ActivityRule{
+							{Condition: config.ActivityCondition{ComponentName: []string{"bidderA.BidderB.bidderC"}}},
+						}},
+					},
+				},
+			},
+		},
+		&metricsConfig.NilMetricsEngine{},
+		analyticsConf.NewPBSAnalytics(&config.Analytics{}),
+		map[string]string{},
+		false,
+		[]byte{},
+		openrtb_ext.BuildBidderMap(),
+		ex.cache,
+		regexp.MustCompile(`[<>]`),
+		hardcodedResponseIPValidator{response: true},
+		empty_fetcher.EmptyFetcher{},
+		hooks.EmptyPlanBuilder{},
+		nil,
+	}
+}
+
 func mockDepsAppendBidderNames(t *testing.T, ex *mockExchangeAppendBidderNames) *endpointDeps {
 	deps := &endpointDeps{
 		fakeUUIDGenerator{},

diff --git a/exchange/exchange_test.go b/exchange/exchange_test.go
@@ -37,6 +37,7 @@ import (
 	metricsConfig "github.com/prebid/prebid-server/metrics/config"
 	"github.com/prebid/prebid-server/openrtb_ext"
 	pbc "github.com/prebid/prebid-server/prebid_cache_client"
+	"github.com/prebid/prebid-server/privacy"
 	"github.com/prebid/prebid-server/stored_requests"
 	"github.com/prebid/prebid-server/stored_requests/backends/file_fetcher"
 	"github.com/prebid/prebid-server/usersync"
@@ -2351,6 +2352,11 @@ func runSpec(t *testing.T, filename string, spec *exchangeSpec) {
 		impExtInfoMap[impID] = ImpExtInfo{}
 	}
 
+	activityControl, err := privacy.NewActivityControl(spec.AccountPrivacy)
+	if err != nil {
+		t.Errorf("%s: Exchange returned an unexpected error. Got %s", filename, err.Error())
+	}
+
 	auctionRequest := &AuctionRequest{
 		BidRequestWrapper: &openrtb_ext.RequestWrapper{BidRequest: &spec.IncomingRequest.OrtbRequest},
 		Account: config.Account{
@@ -2366,6 +2372,7 @@ func runSpec(t *testing.T, filename string, spec *exchangeSpec) {
 		ImpExtInfoMap: impExtInfoMap,
 		HookExecutor:  &hookexecution.EmptyHookExecutor{},
 		TCF2Config:    gdpr.NewTCF2Config(privacyConfig.GDPR.TCF2, config.AccountGDPR{}),
+		Activities:    activityControl,
 	}
 
 	if spec.MultiBid != nil {
@@ -5187,6 +5194,7 @@ type exchangeSpec struct {
 	FledgeEnabled              bool                   `json:"fledge_enabled,omitempty"`
 	MultiBid                   *multiBidSpec          `json:"multiBid,omitempty"`
 	Server                     exchangeServer         `json:"server,omitempty"`
+	AccountPrivacy             *config.AccountPrivacy `json:"accountPrivacy,omitempty"`
 }
 
 type multiBidSpec struct {

diff --git a/exchange/exchangetest/activity-tid-off.json b/exchange/exchangetest/activity-tid-off.json
@@ -0,0 +1,85 @@
+{
+    "accountPrivacy": {
+        "allowactivities": {
+            "transmitTid": {
+                "default": true,
+                "rules": [
+                    {
+                        "allow": true,
+                        "condition": {
+                            "componentName": ["appnexus"],
+                            "componentType":["bidder"]
+                        }
+                    }
+                ]
+            }
+        }
+    },
+    "incomingRequest": {
+        "ortbRequest": {
+            "id": "some-request-id",
+            "site": {
+                "page": "test.somepage.com"
+            },
+            "imp": [
+                {
+                    "id": "my-imp-id",
+                    "video": {
+                        "mimes": [
+                            "video/mp4"
+                        ]
+                    },
+                    "ext": {
+                        "tid": "extTestTID",
+                        "prebid": {
+                            "bidder": {
+                                "appnexus": {
+                                    "placementId": 1
+                                }
+                            }
+                        }
+                    }
+                }
+            ],
+            "source": {
+                "tid": "sourceTestTID"
+            }
+        }
+    },
+    "outgoingRequests": {
+        "appnexus": {
+            "expectRequest": {
+                "ortbRequest": {
+                    "id": "some-request-id",
+                    "site": {
+                        "page": "test.somepage.com"
+                    },
+                    "imp": [
+                        {
+                            "id": "my-imp-id",
+                            "video": {
+                                "mimes": [
+                                    "video/mp4"
+                                ]
+                            },
+                            "ext": {
+                                "tid": "extTestTID",
+                                "bidder": {
+                                    "placementId": 1
+                                }
+                            }
+                        }
+                    ],
+                    "source": {
+                        "tid": "sourceTestTID"
+                    }
+                }
+            },
+            "mockResponse": {
+                "errors": [
+                    "appnexus-error"
+                ]
+            }
+        }
+    }
+}
diff --git a/exchange/exchangetest/activity-tid-on.json b/exchange/exchangetest/activity-tid-on.json
@@ -0,0 +1,82 @@
+{
+    "accountPrivacy": {
+        "allowactivities": {
+            "transmitTid": {
+                "default": true,
+                "rules": [
+                    {
+                        "allow": false,
+                        "condition": {
+                            "componentName": ["appnexus"],
+                            "componentType":["bidder"]
+                        }
+                    }
+                ]
+            }
+        }
+    },
+    "incomingRequest": {
+        "ortbRequest": {
+            "id": "some-request-id",
+            "site": {
+                "page": "test.somepage.com"
+            },
+            "imp": [
+                {
+                    "id": "my-imp-id",
+                    "video": {
+                        "mimes": [
+                            "video/mp4"
+                        ]
+                    },
+                    "ext": {
+                        "tid": "extTestTID",
+                        "prebid": {
+                            "bidder": {
+                                "appnexus": {
+                                    "placementId": 1
+                                }
+                            }
+                        }
+                    }
+                }
+            ],
+            "source": {
+                "tid": "sourceTestTID"
+            }
+        }
+    },
+    "outgoingRequests": {
+        "appnexus": {
+            "expectRequest": {
+                "ortbRequest": {
+                    "id": "some-request-id",
+                    "site": {
+                        "page": "test.somepage.com"
+                    },
+                    "imp": [
+                        {
+                            "id": "my-imp-id",
+                            "video": {
+                                "mimes": [
+                                    "video/mp4"
+                                ]
+                            },
+                            "ext": {
+                                "bidder": {
+                                    "placementId": 1
+                                }
+                            }
+                        }
+                    ],
+                    "source": {}
+                }
+            },
+            "mockResponse": {
+                "errors": [
+                    "appnexus-error"
+                ]
+            }
+        }
+    }
+}
diff --git a/exchange/utils.go b/exchange/utils.go
@@ -212,6 +212,8 @@ func (rs *requestSplitter) cleanOpenRTBRequests(ctx context.Context,
 			applyFPD(auctionReq.FirstPartyData[bidderRequest.BidderName], bidderRequest.BidRequest)
 		}
 
+		privacyEnforcement.TID = !auctionReq.Activities.Allow(privacy.ActivityTransmitTids, scopedName)
+
 		privacyEnforcement.Apply(bidderRequest.BidRequest)
 		allowedBidderRequests = append(allowedBidderRequests, bidderRequest)