PBS Bid Adapter : add BEFORE_PBS_HTTP event

modules/prebidServerBidAdapter/index.js

@@ -503,14 +503,17 @@ export const processPBSRequest = hook('sync', function (s2sBidRequest, bidReques
     .filter(uniques);
 
   const request = s2sBidRequest.metrics.measureTime('buildRequests', () => buildPBSRequest(s2sBidRequest, bidRequests, adUnits, requestedBidders));
-  const requestJson = request && JSON.stringify(request);
-  logInfo('BidRequest: ' + requestJson);
-  const endpointUrl = getMatchingConsentUrl(s2sBidRequest.s2sConfig.endpoint, gdprConsent);
-  const customHeaders = s2sBidRequest?.s2sConfig?.customHeaders ?? {};
-  if (request && requestJson && endpointUrl) {
+  const requestData = {
+    endpointUrl: getMatchingConsentUrl(s2sBidRequest.s2sConfig.endpoint, gdprConsent),
+    requestJson: request && JSON.stringify(request),
+    customHeaders: s2sBidRequest?.s2sConfig?.customHeaders ?? {},
+  };
+  events.emit(EVENTS.BEFORE_PBS_HTTP, requestData)
+  logInfo('BidRequest: ' + requestData);
+  if (request && requestData.requestJson && requestData.endpointUrl) {
     const networkDone = s2sBidRequest.metrics.startTiming('net');
     ajax(
-      endpointUrl,
+      requestData.endpointUrl,
       {
         success: function (response) {
           networkDone();
@@ -537,12 +540,12 @@ export const processPBSRequest = hook('sync', function (s2sBidRequest, bidReques
           onError.apply(this, arguments);
         }
       },
-      requestJson,
+      requestData.requestJson,
       {
         contentType: 'text/plain',
         withCredentials: true,
         browsingTopics: isActivityAllowed(ACTIVITY_TRANSMIT_UFPD, s2sActivityParams(s2sBidRequest.s2sConfig)),
-        customHeaders
+        customHeaders: requestData.customHeaders
       }
     );
   } else {

src/constants.js

@@ -48,6 +48,7 @@ export const EVENTS = {
   PAAPI_BID: 'paapiBid',
   PAAPI_NO_BID: 'paapiNoBid',
   PAAPI_ERROR: 'paapiError',
+  BEFORE_PBS_HTTP: 'beforePBSHttp',
   BROWSI_INIT: 'browsiInit',
   BROWSI_DATA: 'browsiData',
 };

test/spec/modules/prebidServerBidAdapter_spec.js

@@ -3270,8 +3270,8 @@ describe('S2S Adapter', function () {
       adapter.callBids(REQUEST, BID_REQUESTS, addBidResponse, done, ajax);
       server.requests[0].respond(200, {}, JSON.stringify(RESPONSE_OPENRTB));
 
-      sinon.assert.calledOnce(events.emit);
-      const event = events.emit.firstCall.args;
+      sinon.assert.calledTwice(events.emit);
+      const event = events.emit.secondCall.args;
       expect(event[0]).to.equal(EVENTS.BIDDER_DONE);
       expect(event[1].bids[0]).to.have.property('serverResponseTimeMs', 8);
 
@@ -3302,7 +3302,7 @@ describe('S2S Adapter', function () {
       const responding = deepClone(nonbidResponse);
       Object.assign(responding.ext.seatnonbid, [{auctionId: 2}])
       server.requests[0].respond(200, {}, JSON.stringify(responding));
-      const event = events.emit.secondCall.args;
+      const event = events.emit.thirdCall.args;
       expect(event[0]).to.equal(EVENTS.SEAT_NON_BID);
       expect(event[1].seatnonbid[0]).to.have.property('auctionId', 2);
       expect(event[1].requestedBidders).to.deep.equal(['appnexus']);
@@ -3319,7 +3319,7 @@ describe('S2S Adapter', function () {
       const responding = deepClone(nonbidResponse);
       Object.assign(responding.ext.seatnonbid, [{auctionId: 2}])
       server.requests[0].respond(200, {}, JSON.stringify(responding));
-      const event = events.emit.thirdCall.args;
+      const event = events.emit.getCall(3).args;
       expect(event[0]).to.equal(EVENTS.PBS_ANALYTICS);
       expect(event[1].seatnonbid[0]).to.have.property('auctionId', 2);
       expect(event[1].requestedBidders).to.deep.equal(['appnexus']);
@@ -3336,12 +3336,26 @@ describe('S2S Adapter', function () {
       const responding = deepClone(atagResponse);
       Object.assign(responding.ext.prebid.analytics.tags, ['stuff'])
       server.requests[0].respond(200, {}, JSON.stringify(responding));
-      const event = events.emit.secondCall.args;
+      const event = events.emit.thirdCall.args;
       expect(event[0]).to.equal(EVENTS.PBS_ANALYTICS);
       expect(event[1].atag[0]).to.deep.equal('stuff');
       expect(event[1].response).to.deep.equal(responding);
     });
 
+    it('emits the BEFORE_PBS_HTTP event and captures responses', function () {
+      config.setConfig({ CONFIG });
+
+      adapter.callBids(REQUEST, BID_REQUESTS, addBidResponse, done, ajax);
+      server.requests[0].respond(200, {}, JSON.stringify(RESPONSE_OPENRTB));
+
+      sinon.assert.calledTwice(events.emit);
+      const event = events.emit.firstCall.args;
+      expect(event[0]).to.equal(EVENTS.BEFORE_PBS_HTTP);
+      expect(event[1]).to.have.property('requestJson', server.requests[0].requestBody);
+      expect(event[1]).to.have.property('endpointUrl', CONFIG.endpoint.p1Consent);
+      expect(event[1].customHeaders).to.deep.equal({});
+    });
+
     it('respects defaultTtl', function () {
       const s2sConfig = Object.assign({}, CONFIG, {
         defaultTtl: 30
@@ -3353,7 +3367,7 @@ describe('S2S Adapter', function () {
       adapter.callBids(s2sBidRequest, BID_REQUESTS, addBidResponse, done, ajax);
       server.requests[0].respond(200, {}, JSON.stringify(RESPONSE_OPENRTB));
 
-      sinon.assert.calledOnce(events.emit);
+      sinon.assert.calledTwice(events.emit);
       const event = events.emit.firstCall.args;
       sinon.assert.calledOnce(addBidResponse);
       const response = addBidResponse.firstCall.args[1];