Core: fix missing AD_RENDER_SUCCEDED for outstream renderers (#11073)

prebid · Feb 8, 2024 · 3548745 · 3548745
1 parent 61ba3fe
commit 3548745
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 9 deletions.
diff --git a/src/adRendering.js b/src/adRendering.js
@@ -19,7 +19,10 @@ const {AD_RENDER_FAILED, AD_RENDER_SUCCEEDED, STALE_RENDER, BID_WON} = constants
  */
 export function emitAdRenderFail({ reason, message, bid, id }) {
   const data = { reason, message };
-  if (bid) data.bid = bid;
+  if (bid) {
+    data.bid = bid;
+    data.adId = bid.adId;
+  }
   if (id) data.adId = id;
 
   logError(`Error rendering ad (id: ${id}): ${message}`);
@@ -64,6 +67,7 @@ export function handleRender(renderFn, {adId, options, bidResponse, doc}) {
     // rendering for outstream safeframe
     if (isRendererRequired(renderer)) {
       executeRenderer(renderer, bidResponse, doc);
+      emitAdRenderSucceeded({doc, bid: bidResponse, id: adId})
     } else if (adId) {
       if (mediaType === VIDEO) {
         emitAdRenderFail({

diff --git a/test/spec/unit/secureCreatives_spec.js b/test/spec/unit/secureCreatives_spec.js
@@ -15,6 +15,16 @@ import {handleRender} from '../../../src/adRendering.js';
 var CONSTANTS = require('src/constants.json');
 
 describe('secureCreatives', () => {
+  let sandbox;
+
+  beforeEach(() => {
+    sandbox = sinon.sandbox.create();
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+  });
+
   function makeEvent(ev) {
     return Object.assign({origin: 'mock-origin', ports: []}, ev)
   }
@@ -63,14 +73,44 @@ describe('secureCreatives', () => {
       }
     });
 
-    it('does not invoke renderFn, but the renderer instead, if the ad has one', () => {
-      const renderer = {
-        url: 'some-custom-renderer',
-        render: sinon.spy()
-      }
-      handleRender(renderFn, {bidResponse: {renderer}});
-      sinon.assert.notCalled(renderFn);
-      sinon.assert.called(renderer.render);
+    describe('when the ad has a renderer', () => {
+      let bidResponse;
+      beforeEach(() => {
+        sandbox.stub(events, 'emit');
+        bidResponse = {
+          adId: 'mock-ad-id',
+          renderer: {
+            url: 'some-custom-renderer',
+            render: sinon.stub()
+          }
+        }
+      });
+
+      it('does not invoke renderFn, but the renderer instead', () => {
+        handleRender(renderFn, {bidResponse});
+        sinon.assert.notCalled(renderFn);
+        sinon.assert.called(bidResponse.renderer.render);
+      });
+
+      it('emits AD_RENDER_SUCCEDED', () => {
+        handleRender(renderFn, {bidResponse});
+        sinon.assert.calledWith(events.emit, CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED, sinon.match({
+          bid: bidResponse,
+          adId: bidResponse.adId
+        }));
+      });
+
+      it('emits AD_RENDER_FAILED', () => {
+        const err = new Error('error message');
+        bidResponse.renderer.render.throws(err);
+        handleRender(renderFn, {bidResponse});
+        sinon.assert.calledWith(events.emit, CONSTANTS.EVENTS.AD_RENDER_FAILED, sinon.match({
+          bid: bidResponse,
+          adId: bidResponse.adId,
+          reason: CONSTANTS.AD_RENDER_FAILED_REASON.EXCEPTION,
+          message: err.message
+        }));
+      })
     });
 
     ['ad', 'adUrl'].forEach((prop) => {