OTT-1168: support for traffic shaping based on country code

.gitignore

@@ -59,4 +59,4 @@ analytics/filesystem/testFiles/
 *.swp
 *.swo
 pbsimage
-manual_build
+manual_build

Makefile

@@ -7,7 +7,7 @@ all: deps test build-modules build
 # deps will clean out the vendor directory and use go mod for a fresh install
 deps:
 	GOPROXY="https://proxy.golang.org" go mod vendor -v && go mod tidy -v
-	
+
 # test will ensure that all of our dependencies are available and run validate.sh
 test: deps
 # If there is no indentation, Make will treat it as a directive for itself; otherwise, it's regarded as a shell script.
@@ -37,10 +37,10 @@ format:
 # formatcheck runs format for diagnostics, without modifying the code
 formatcheck:
 	./scripts/format.sh -f false
-	
+
 mockgen: mockgeninstall mockgendb mockgencache mockgenmetrics mockgenlogger mockgenpublisherfeature
 
-# export GOPATH=~/go ; GOBIN=~/go/bin; export PATH=$PATH:$GOBIN   
+# export GOPATH=~/go ; GOBIN=~/go/bin; export PATH=$PATH:$GOBIN
 mockgeninstall:
 	go install github.com/golang/mock/[email protected]
 
@@ -57,6 +57,10 @@ mockgenmetrics:
 	mkdir -p modules/pubmatic/openwrap/metrics/mock
 	mockgen github.com/PubMatic-OpenWrap/prebid-server/v2/modules/pubmatic/openwrap/metrics MetricsEngine > modules/pubmatic/openwrap/metrics/mock/mock.go
 
+mockgengeodb:
+	mkdir -p modules/pubmatic/openwrap/geodb/mock
+	mockgen github.com/PubMatic-OpenWrap/prebid-server/v2/modules/pubmatic/openwrap/geodb Geography > modules/pubmatic/openwrap/geodb/mock/mock.go
+
 mockgenlogger:
 	mkdir -p analytics/pubmatic/mhttp/mock
 	mockgen github.com/PubMatic-OpenWrap/prebid-server/v2/analytics/pubmatic/mhttp HttpCallInterface,MultiHttpContextInterface > analytics/pubmatic/mhttp/mock/mock.go

analytics/pubmatic/logger.go

@@ -15,6 +15,7 @@ import (
 	"github.com/prebid/prebid-server/v2/hooks/hookexecution"
 	"github.com/prebid/prebid-server/v2/modules/pubmatic/openwrap/customdimensions"
 	"github.com/prebid/prebid-server/v2/modules/pubmatic/openwrap/models"
+	"github.com/prebid/prebid-server/v2/modules/pubmatic/openwrap/models/nbr"
 	"github.com/prebid/prebid-server/v2/modules/pubmatic/openwrap/utils"
 	"github.com/prebid/prebid-server/v2/openrtb_ext"
 	uuid "github.com/satori/go.uuid"
@@ -30,6 +31,11 @@ var GetUUID = func() string {
 	return uuid.NewV4().String()
 }
 
+var blockListedNBR = map[openrtb3.NoBidReason]struct{}{
+	nbr.RequestBlockedPartnerThrottle: {},
+	nbr.RequestBlockedPartnerFiltered: {},
+}
+
 // 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 || rCtx.LoggerDisabled {
@@ -395,6 +401,12 @@ func getPartnerRecordsByImp(ao analytics.AuctionObject, rCtx *models.RequestCtx)
 				nbr = bidExt.Nbr // valid-bids + default-bids + dropped-bids
 			}
 
+			if nbr != nil {
+				if _, ok := blockListedNBR[*nbr]; ok {
+					continue
+				}
+			}
+
 			pr := PartnerRecord{
 				PartnerID:         partnerID,                           // prebid biddercode
 				BidderCode:        seat,                                // pubmatic biddercode: pubmatic2

analytics/pubmatic/logger_test.go

@@ -7,6 +7,7 @@ import (
 	"testing"
 
 	"github.com/prebid/openrtb/v20/openrtb2"
+	"github.com/prebid/openrtb/v20/openrtb3"
 	"github.com/prebid/prebid-server/v2/analytics"
 	"github.com/prebid/prebid-server/v2/exchange"
 	"github.com/prebid/prebid-server/v2/hooks/hookanalytics"
@@ -114,9 +115,9 @@ func TestConvertNonBidToBid(t *testing.T) {
 			nonBid: openrtb_ext.NonBid{
 				StatusCode: int(exchange.ResponseRejectedBelowFloor),
 				ImpId:      "imp1",
-				Ext: openrtb_ext.NonBidExt{
-					Prebid: openrtb_ext.ExtResponseNonBidPrebid{
-						Bid: openrtb_ext.NonBidObject{
+				Ext: openrtb_ext.ExtNonBid{
+					Prebid: openrtb_ext.ExtNonBidPrebid{
+						Bid: openrtb_ext.ExtNonBidPrebidBid{
 							Price:             10,
 							ADomain:           []string{"abc.com"},
 							DealID:            "d1",
@@ -1059,9 +1060,9 @@ func TestGetPartnerRecordsByImpForDefaultBids(t *testing.T) {
 								{
 									ImpId:      "imp1",
 									StatusCode: int(exchange.ResponseRejectedBelowFloor),
-									Ext: openrtb_ext.NonBidExt{
-										Prebid: openrtb_ext.ExtResponseNonBidPrebid{
-											Bid: openrtb_ext.NonBidObject{
+									Ext: openrtb_ext.ExtNonBid{
+										Prebid: openrtb_ext.ExtNonBidPrebid{
+											Bid: openrtb_ext.ExtNonBidPrebidBid{
 												ID: "bid-id-2",
 											},
 										},
@@ -1141,9 +1142,9 @@ func TestGetPartnerRecordsByImpForDefaultBids(t *testing.T) {
 								{
 									ImpId:      "imp1",
 									StatusCode: int(exchange.ResponseRejectedBelowFloor),
-									Ext: openrtb_ext.NonBidExt{
-										Prebid: openrtb_ext.ExtResponseNonBidPrebid{
-											Bid: openrtb_ext.NonBidObject{
+									Ext: openrtb_ext.ExtNonBid{
+										Prebid: openrtb_ext.ExtNonBidPrebid{
+											Bid: openrtb_ext.ExtNonBidPrebidBid{
 												ID: "bid-id-1",
 											},
 										},
@@ -1313,9 +1314,9 @@ func TestGetPartnerRecordsByImpForSeatNonBid(t *testing.T) {
 								{
 									ImpId:      "imp1",
 									StatusCode: int(exchange.ResponseRejectedBelowDealFloor),
-									Ext: openrtb_ext.NonBidExt{
-										Prebid: openrtb_ext.ExtResponseNonBidPrebid{
-											Bid: openrtb_ext.NonBidObject{
+									Ext: openrtb_ext.ExtNonBid{
+										Prebid: openrtb_ext.ExtNonBidPrebid{
+											Bid: openrtb_ext.ExtNonBidPrebidBid{
 												Price: 10,
 											},
 										},
@@ -1343,9 +1344,9 @@ func TestGetPartnerRecordsByImpForSeatNonBid(t *testing.T) {
 								{
 									ImpId:      "imp1",
 									StatusCode: int(exchange.ResponseRejectedBelowFloor),
-									Ext: openrtb_ext.NonBidExt{
-										Prebid: openrtb_ext.ExtResponseNonBidPrebid{
-											Bid: openrtb_ext.NonBidObject{
+									Ext: openrtb_ext.ExtNonBid{
+										Prebid: openrtb_ext.ExtNonBidPrebid{
+											Bid: openrtb_ext.ExtNonBidPrebidBid{
 												Price:          10,
 												ID:             "bid-id-1",
 												W:              10,
@@ -1444,9 +1445,9 @@ func TestGetPartnerRecordsByImpForSeatNonBidForFloors(t *testing.T) {
 								{
 									ImpId:      "imp1",
 									StatusCode: int(exchange.ResponseRejectedBelowFloor),
-									Ext: openrtb_ext.NonBidExt{
-										Prebid: openrtb_ext.ExtResponseNonBidPrebid{
-											Bid: openrtb_ext.NonBidObject{
+									Ext: openrtb_ext.ExtNonBid{
+										Prebid: openrtb_ext.ExtNonBidPrebid{
+											Bid: openrtb_ext.ExtNonBidPrebidBid{
 												Price: 10,
 												ID:    "bid-id-1",
 												Floors: &openrtb_ext.ExtBidPrebidFloors{
@@ -1509,10 +1510,10 @@ func TestGetPartnerRecordsByImpForSeatNonBidForFloors(t *testing.T) {
 							NonBid: []openrtb_ext.NonBid{
 								{
 									ImpId:      "imp1",
-									StatusCode: int((exchange.ResponseRejectedBelowFloor)),
-									Ext: openrtb_ext.NonBidExt{
-										Prebid: openrtb_ext.ExtResponseNonBidPrebid{
-											Bid: openrtb_ext.NonBidObject{
+									StatusCode: int(exchange.ResponseRejectedBelowFloor),
+									Ext: openrtb_ext.ExtNonBid{
+										Prebid: openrtb_ext.ExtNonBidPrebid{
+											Bid: openrtb_ext.ExtNonBidPrebidBid{
 												Price: 10,
 												ID:    "bid-id-1",
 												Floors: &openrtb_ext.ExtBidPrebidFloors{
@@ -1575,10 +1576,10 @@ func TestGetPartnerRecordsByImpForSeatNonBidForFloors(t *testing.T) {
 							NonBid: []openrtb_ext.NonBid{
 								{
 									ImpId:      "imp1",
-									StatusCode: int((exchange.ResponseRejectedBelowFloor)),
-									Ext: openrtb_ext.NonBidExt{
-										Prebid: openrtb_ext.ExtResponseNonBidPrebid{
-											Bid: openrtb_ext.NonBidObject{
+									StatusCode: int(exchange.ResponseRejectedBelowFloor),
+									Ext: openrtb_ext.ExtNonBid{
+										Prebid: openrtb_ext.ExtNonBidPrebid{
+											Bid: openrtb_ext.ExtNonBidPrebidBid{
 												Price: 10,
 												ID:    "bid-id-1",
 												Floors: &openrtb_ext.ExtBidPrebidFloors{
@@ -1642,9 +1643,9 @@ func TestGetPartnerRecordsByImpForSeatNonBidForFloors(t *testing.T) {
 								{
 									ImpId:      "imp1",
 									StatusCode: int(exchange.ResponseRejectedBelowFloor),
-									Ext: openrtb_ext.NonBidExt{
-										Prebid: openrtb_ext.ExtResponseNonBidPrebid{
-											Bid: openrtb_ext.NonBidObject{
+									Ext: openrtb_ext.ExtNonBid{
+										Prebid: openrtb_ext.ExtNonBidPrebid{
+											Bid: openrtb_ext.ExtNonBidPrebidBid{
 												Price: 10,
 												ID:    "bid-id-1",
 											},
@@ -1702,9 +1703,9 @@ func TestGetPartnerRecordsByImpForSeatNonBidForFloors(t *testing.T) {
 								{
 									ImpId:      "imp1",
 									StatusCode: int(exchange.ResponseRejectedBelowFloor),
-									Ext: openrtb_ext.NonBidExt{
-										Prebid: openrtb_ext.ExtResponseNonBidPrebid{
-											Bid: openrtb_ext.NonBidObject{
+									Ext: openrtb_ext.ExtNonBid{
+										Prebid: openrtb_ext.ExtNonBidPrebid{
+											Bid: openrtb_ext.ExtNonBidPrebidBid{
 												Price: 10,
 												ID:    "bid-id-1",
 											},
@@ -1765,9 +1766,9 @@ func TestGetPartnerRecordsByImpForSeatNonBidForFloors(t *testing.T) {
 								{
 									ImpId:      "imp1",
 									StatusCode: int(exchange.ResponseRejectedBelowFloor),
-									Ext: openrtb_ext.NonBidExt{
-										Prebid: openrtb_ext.ExtResponseNonBidPrebid{
-											Bid: openrtb_ext.NonBidObject{
+									Ext: openrtb_ext.ExtNonBid{
+										Prebid: openrtb_ext.ExtNonBidPrebid{
+											Bid: openrtb_ext.ExtNonBidPrebidBid{
 												Price: 10,
 												ID:    "bid-id-1",
 												Floors: &openrtb_ext.ExtBidPrebidFloors{
@@ -2186,9 +2187,9 @@ func TestGetPartnerRecordsByImpForBidIDCollisions(t *testing.T) {
 								{
 									ImpId:      "imp1",
 									StatusCode: int(nbr.LossBidLostToDealBid),
-									Ext: openrtb_ext.NonBidExt{
-										Prebid: openrtb_ext.ExtResponseNonBidPrebid{
-											Bid: openrtb_ext.NonBidObject{
+									Ext: openrtb_ext.ExtNonBid{
+										Prebid: openrtb_ext.ExtNonBidPrebid{
+											Bid: openrtb_ext.ExtNonBidPrebidBid{
 												Price: 10,
 												ID:    "bid-id-1",
 												BidId: "uuid",
@@ -2485,8 +2486,8 @@ func TestGetPartnerRecordsByImpForBidExtFailure(t *testing.T) {
 							NonBid: []openrtb_ext.NonBid{
 								{
 									ImpId:      "imp1",
-									StatusCode: int(nbr.LossBidLostToDealBid),
-									Ext:        openrtb_ext.NonBidExt{},
+									StatusCode: int(exchange.ResponseRejectedBelowDealFloor),
+									Ext:        openrtb_ext.ExtNonBid{},
 								},
 							},
 						},
@@ -2511,7 +2512,10 @@ func TestGetPartnerRecordsByImpForBidExtFailure(t *testing.T) {
 						NetECPM:     0,
 						GrossECPM:   0,
 						OriginalCur: models.USD,
-						Nbr:         nbr.LossBidLostToDealBid.Ptr(),
+						Nbr: func() *openrtb3.NoBidReason {
+							a := exchange.ResponseRejectedBelowDealFloor
+							return &a
+						}(),
 					},
 				},
 			},

analytics/pubstack/pubstack_module_test.go

@@ -99,7 +99,7 @@ func TestNewModuleSuccess(t *testing.T) {
 								{
 									ImpId:      "123",
 									StatusCode: 34,
-									Ext:        openrtb_ext.NonBidExt{Prebid: openrtb_ext.ExtResponseNonBidPrebid{Bid: openrtb_ext.NonBidObject{}}},
+									Ext:        openrtb_ext.ExtNonBid{Prebid: openrtb_ext.ExtNonBidPrebid{Bid: openrtb_ext.ExtNonBidPrebidBid{}}},
 								},
 							},
 						},