new BIDDER_ERROR event and new onBidderError function called when aja…

…x call fail (#7438)
prebid · Oct 18, 2021 · 0e50635 · 0e50635
1 parent 38b9816
commit 0e50635
Show file tree

Hide file tree

Showing 5 changed files with 102 additions and 4 deletions.
diff --git a/src/adapterManager.js b/src/adapterManager.js
@@ -621,4 +621,9 @@ adapterManager.callBidViewableBidder = function(bidder, bid) {
   tryCallBidderMethod(bidder, 'onBidViewable', bid);
 };
 
+adapterManager.callBidderError = function(bidder, error, bidderRequest) {
+  const param = { error, bidderRequest };
+  tryCallBidderMethod(bidder, 'onBidderError', param);
+};
+
 export default adapterManager;
diff --git a/src/adapters/bidderFactory.js b/src/adapters/bidderFactory.js
@@ -335,10 +335,11 @@ export function newBidder(spec) {
 
         // If the server responds with an error, there's not much we can do. Log it, and make sure to
         // call onResponse() so that we're one step closer to calling done().
-        function onFailure(err) {
+        function onFailure(errorMessage, error) {
           onTimelyResponse(spec.code);
-
-          logError(`Server call for ${spec.code} failed: ${err}. Continuing without bids.`);
+          adapterManager.callBidderError(spec.code, error, bidderRequest)
+          events.emit(CONSTANTS.EVENTS.BIDDER_ERROR, { error, bidderRequest });
+          logError(`Server call for ${spec.code} failed: ${errorMessage} ${error.status}. Continuing without bids.`);
           onResponse();
         }
       }

diff --git a/src/constants.json b/src/constants.json
@@ -32,6 +32,7 @@
     "NO_BID": "noBid",
     "BID_WON": "bidWon",
     "BIDDER_DONE": "bidderDone",
+    "BIDDER_ERROR": "bidderError",
     "SET_TARGETING": "setTargeting",
     "BEFORE_REQUEST_BIDS": "beforeRequestBids",
     "BEFORE_BIDDER_HTTP": "beforeBidderHttp",

diff --git a/test/spec/unit/core/adapterManager_spec.js b/test/spec/unit/core/adapterManager_spec.js
@@ -436,6 +436,37 @@ describe('adapterManager tests', function () {
     });
   }); // end onBidViewable
 
+  describe('onBidderError', function () {
+    const bidder = 'appnexus';
+    const appnexusSpec = { onBidderError: sinon.stub() };
+    const appnexusAdapter = {
+      bidder,
+      getSpec: function() { return appnexusSpec; },
+    }
+    before(function () {
+      config.setConfig({s2sConfig: { enabled: false }});
+    });
+
+    beforeEach(function () {
+      adapterManager.bidderRegistry[bidder] = appnexusAdapter;
+    });
+
+    afterEach(function () {
+      delete adapterManager.bidderRegistry[bidder];
+    });
+
+    it('should call spec\'s onBidderError callback when callBidderError is called', function () {
+      const bidderRequest = getBidRequests().find(bidRequest => bidRequest.bidderCode === bidder);
+      const xhrErrorMock = {
+        status: 500,
+        statusText: 'Internal Server Error'
+      };
+      adapterManager.callBidderError(bidder, xhrErrorMock, bidderRequest);
+      sinon.assert.calledOnce(appnexusSpec.onBidderError);
+      sinon.assert.calledWithExactly(appnexusSpec.onBidderError, { error: xhrErrorMock, bidderRequest });
+    });
+  }); // end onBidderError
+
   describe('S2S tests', function () {
     beforeEach(function () {
       config.setConfig({s2sConfig: CONFIG});

diff --git a/test/spec/unit/core/bidderFactory_spec.js b/test/spec/unit/core/bidderFactory_spec.js
@@ -552,17 +552,27 @@ describe('bidders created by newBidder', function () {
 
   describe('when the ajax call fails', function () {
     let ajaxStub;
+    let callBidderErrorStub;
+    let eventEmitterStub;
+    let xhrErrorMock = {
+      status: 500,
+      statusText: 'Internal Server Error'
+    };
 
     beforeEach(function () {
       ajaxStub = sinon.stub(ajax, 'ajax').callsFake(function(url, callbacks) {
-        callbacks.error('ajax call failed.');
+        callbacks.error('ajax call failed.', xhrErrorMock);
       });
+      callBidderErrorStub = sinon.stub(adapterManager, 'callBidderError');
+      eventEmitterStub = sinon.stub(events, 'emit');
       addBidResponseStub.reset();
       doneStub.reset();
     });
 
     afterEach(function () {
       ajaxStub.restore();
+      callBidderErrorStub.restore();
+      eventEmitterStub.restore();
     });
 
     it('should not spec.interpretResponse()', function () {
@@ -580,6 +590,14 @@ describe('bidders created by newBidder', function () {
 
       expect(spec.interpretResponse.called).to.equal(false);
       expect(doneStub.calledOnce).to.equal(true);
+      expect(callBidderErrorStub.calledOnce).to.equal(true);
+      expect(callBidderErrorStub.firstCall.args[0]).to.equal(CODE);
+      expect(callBidderErrorStub.firstCall.args[1]).to.equal(xhrErrorMock);
+      expect(callBidderErrorStub.firstCall.args[2]).to.equal(MOCK_BIDS_REQUEST);
+      sinon.assert.calledWith(eventEmitterStub, CONSTANTS.EVENTS.BIDDER_ERROR, {
+        error: xhrErrorMock,
+        bidderRequest: MOCK_BIDS_REQUEST
+      });
     });
 
     it('should not add bids for each adunit code into the auction', function () {
@@ -598,6 +616,14 @@ describe('bidders created by newBidder', function () {
 
       expect(addBidResponseStub.callCount).to.equal(0);
       expect(doneStub.calledOnce).to.equal(true);
+      expect(callBidderErrorStub.calledOnce).to.equal(true);
+      expect(callBidderErrorStub.firstCall.args[0]).to.equal(CODE);
+      expect(callBidderErrorStub.firstCall.args[1]).to.equal(xhrErrorMock);
+      expect(callBidderErrorStub.firstCall.args[2]).to.equal(MOCK_BIDS_REQUEST);
+      sinon.assert.calledWith(eventEmitterStub, CONSTANTS.EVENTS.BIDDER_ERROR, {
+        error: xhrErrorMock,
+        bidderRequest: MOCK_BIDS_REQUEST
+      });
     });
 
     it('should call spec.getUserSyncs() with no responses', function () {
@@ -616,6 +642,40 @@ describe('bidders created by newBidder', function () {
       expect(spec.getUserSyncs.calledOnce).to.equal(true);
       expect(spec.getUserSyncs.firstCall.args[1]).to.deep.equal([]);
       expect(doneStub.calledOnce).to.equal(true);
+      expect(callBidderErrorStub.calledOnce).to.equal(true);
+      expect(callBidderErrorStub.firstCall.args[0]).to.equal(CODE);
+      expect(callBidderErrorStub.firstCall.args[1]).to.equal(xhrErrorMock);
+      expect(callBidderErrorStub.firstCall.args[2]).to.equal(MOCK_BIDS_REQUEST);
+      sinon.assert.calledWith(eventEmitterStub, CONSTANTS.EVENTS.BIDDER_ERROR, {
+        error: xhrErrorMock,
+        bidderRequest: MOCK_BIDS_REQUEST
+      });
+    });
+
+    it('should call spec.getUserSyncs() with no responses', function () {
+      const bidder = newBidder(spec);
+
+      spec.isBidRequestValid.returns(true);
+      spec.buildRequests.returns({
+        method: 'POST',
+        url: 'test.url.com',
+        data: {}
+      });
+      spec.getUserSyncs.returns([]);
+
+      bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+
+      expect(spec.getUserSyncs.calledOnce).to.equal(true);
+      expect(spec.getUserSyncs.firstCall.args[1]).to.deep.equal([]);
+      expect(doneStub.calledOnce).to.equal(true);
+      expect(callBidderErrorStub.calledOnce).to.equal(true);
+      expect(callBidderErrorStub.firstCall.args[0]).to.equal(CODE);
+      expect(callBidderErrorStub.firstCall.args[1]).to.equal(xhrErrorMock);
+      expect(callBidderErrorStub.firstCall.args[2]).to.equal(MOCK_BIDS_REQUEST);
+      sinon.assert.calledWith(eventEmitterStub, CONSTANTS.EVENTS.BIDDER_ERROR, {
+        error: xhrErrorMock,
+        bidderRequest: MOCK_BIDS_REQUEST
+      });
     });
   });
 });