bug - not sending AD_RENDER_FAILED when using safeFrame

[mkendall07]

Type of issue

Bug

Description

As pointed out by @patmmccann we currently don't emit the AD_RENDER_FAILED event if the safeFrame path is used to render the creative (https://github.com/prebid/Prebid.js/blob/master/src/secureCreatives.js#L81)

Expected results

We should emit all the same events regardless of the render path (safeFrame or non safeFrame)

[dgirardi]

AD_RENDER_SUCCEEDED is also not emitted.

[dgirardi]

The AD_RENDER_SUCCEEDED event carries doc as one of its arguments:

https://docs.prebid.org/dev-docs/publisher-api-reference/getEvents.html

Object containing the document containing the ad, the bid, and the adId

For pbjs.renderAd, this is the contentDocument of the iframe around the ad, which is not available for cross-origin iframes.

Proposal: AD_RENDER_SUCCEEDED events for cross-origin iframes will have doc: null. This is also the value of contentDocument when accessed from the parent window's DOM.

Since a publisher can attach any code to that event, and the document so far has always been defined, this is potentially a breaking change.

Within Prebid itself the only explicit use of the AD_RENDER_SUCCEEDED event is in the Zeta Global analytics adapter, which sends it out over the network (with the document):

Prebid.js/modules/zeta_global_sspAnalyticsAdapter.js

Lines 29 to 34 in 55b9d66

	function adRenderSucceededHandler(args) {
	let eventType = CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED
	logInfo(LOG_PREFIX + 'handle ' + eventType + ' event');
	sendEvent(eventType, args);
	}

However any analytics adapter that does not explicitly filter out events it is not interested in is receiving this data, a quick grep reveals these:

demetrio@pbws:~/src/Prebid.js$ find modules -name '*Analytics*.js' | sort > ~/tmp/analytics
demetrio@pbws:~/src/Prebid.js$ cat ~/tmp/analytics | xargs grep -l '\btrack\b' | sort > ~/tmp/analytics-tracking
demetrio@pbws:~/src/Prebid.js$ comm ~/tmp/analytics ~/tmp/analytics-tracking -2 -3
modules/appnexusAnalyticsAdapter.js
modules/datablocksAnalyticsAdapter.js
modules/googleAnalyticsAdapter.js
modules/kargoAnalyticsAdapter.js
modules/optimonAnalyticsAdapter.js
modules/pubperfAnalyticsAdapter.js
modules/pubstackAnalyticsAdapter.js
modules/pulsepointAnalyticsAdapter.js

[bretg]

From a publisher's perspective, the change here would be:

If they have a custom handler listening for the AD_RENDER_SUCCEEDED event:

    pbjs.onEvent('**adRenderSucceeded**', function() {...});

That handler would be need to be able to deal with the scenario where the first "doc" parameter is null. Currently that parameter always has a value, but in the case of safeframes fixed here, the param would be null.

I think this is ok as long as we update the pub API doc https://docs.prebid.org/dev-docs/publisher-api-reference/getEvents.html to note the possibility of this being null.

Adding @patmmccann for a publisher perspective. Basically, I think we can make this change now and not way for 7.0