21444465511

Committed 28 Jan 2026 03:32PM UTC coverage: 96.22% (+0.003%) from 96.217%

Build # 21444465511

Build Type

push

github

Committed by

web-flow

Commit Message

Taboola support extra signals (#14299)

* add deferredBilling support using onBidBillable

* update burl setting

* support nurl firing logic

* add extra signals to taboola request

* add extra ad signals

* fix missing semicolon

* use Prebid's built-in counters

* updated detectBot logic

Run Details

41716 of 51289 branches covered (81.34%)

216 of 221 new or added lines in 2 files covered. (97.74%)

130 existing lines in 9 files now uncovered.

209165 of 217382 relevant lines covered (96.22%)

71.73 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

91.11

/src/secureCreatives.js

/* Secure Creatives
  Provides support for rendering creatives into cross domain iframes such as SafeFrame to prevent
   access to a publisher page from creative payloads.
 */

import {getAllAssetsMessage, getAssetMessage} from './native.js';
import {BID_STATUS, MESSAGES} from './constants.js';
import {isApnGetTagDefined, isGptPubadsDefined, logError, logWarn} from './utils.js';
import {
  deferRendering,
  getBidToRender,
  handleCreativeEvent,
  handleNativeMessage,
  handleRender,
  markWinner
} from './adRendering.js';
import {getCreativeRendererSource, PUC_MIN_VERSION} from './creativeRenderers.js';
import {PbPromise} from './utils/promise.js';

const { REQUEST, RESPONSE, NATIVE, EVENT } = MESSAGES;

const HANDLER_MAP = {
  [REQUEST]: handleRenderRequest,
  [EVENT]: handleEventRequest,
};

if (FEATURES.NATIVE) {
  Object.assign(HANDLER_MAP, {
    [NATIVE]: handleNativeRequest,
  });
}

export function listenMessagesFromCreative() {
  window.addEventListener('message', function (ev) {
    receiveMessage(ev);
  }, false);
}

export function getReplier(ev) {
  if (ev.origin == null && ev.ports.length === 0) {
    return function () {
      const msg = 'Cannot post message to a frame with null origin. Please update creatives to use MessageChannel, see https://github.com/prebid/Prebid.js/issues/7870';
      logError(msg);
      throw new Error(msg);
    };
  } else if (ev.ports.length > 0) {
    return function (message) {
      ev.ports[0].postMessage(JSON.stringify(message));
    };
  } else {
    return function (message) {
      ev.source.postMessage(JSON.stringify(message), ev.origin);
    };
  }
}

function ensureAdId(adId, reply) {
  return function (data, ...args) {
    return reply(Object.assign({}, data, {adId}), ...args);
  }
}

export function receiveMessage(ev, cb) {
  var key = ev.message ? 'message' : 'data';
  var data = {};
  try {
    data = JSON.parse(ev[key]);
  } catch (e) {
    return;
  }

  if (data && data.adId && data.message && HANDLER_MAP.hasOwnProperty(data.message)) {
    return getBidToRender(data.adId, data.message === MESSAGES.REQUEST, (adObject) => {
      HANDLER_MAP[data.message](ensureAdId(data.adId, getReplier(ev)), data, adObject);
      cb && cb();
    });
  }
}

function getResizer(adId, bidResponse) {
  // in some situations adId !== bidResponse.adId
  // the first is the one that was requested and is tied to the element
  // the second is the one that is being rendered (sometimes different, e.g. in some paapi setups)
  return function (width, height) {
    resizeRemoteCreative({...bidResponse, width, height, adId});
  }
}
function handleRenderRequest(reply, message, bidResponse) {
  handleRender({
    renderFn(adData) {
      reply(Object.assign({
        message: RESPONSE,
        renderer: getCreativeRendererSource(bidResponse),
        rendererVersion: PUC_MIN_VERSION
      }, adData));
    },
    resizeFn: getResizer(message.adId, bidResponse),
    options: message.options,
    adId: message.adId,
    bidResponse
  });
}

function handleNativeRequest(reply, data, adObject) {
  // handle this script from native template in an ad server
  // window.parent.postMessage(JSON.stringify({
  //   message: 'Prebid Native',
  //   adId: '%%PATTERN:hb_adid%%'
  // }), '*');
  if (adObject == null) {
    logError(`Cannot find ad for x-origin event request: '${data.adId}'`);
    return;
  }
  switch (data.action) {
    case 'assetRequest':
      deferRendering(adObject, () => reply(getAssetMessage(data, adObject)));
      break;
    case 'allAssetRequest':
      deferRendering(adObject, () => reply(getAllAssetsMessage(data, adObject)));
      break;
    default:
      handleNativeMessage(data, adObject, {resizeFn: getResizer(data.adId, adObject)});
      markWinner(adObject);
  }
}

function handleEventRequest(reply, data, adObject) {
  if (adObject == null) {
    logError(`Cannot find ad '${data.adId}' for x-origin event request`);
    return;
  }
  if (adObject.status !== BID_STATUS.RENDERED) {
    logWarn(`Received x-origin event request without corresponding render request for ad '${adObject.adId}'`);
    return;
  }
  return handleCreativeEvent(data, adObject);
}

function getDimension(value) {
  return value ? value + 'px' : '100%';
}

export function resizeAnchor(ins, width, height) {
  /**
   * Special handling for google anchor ads
   * For anchors, the element to resize is an <ins> element that is an ancestor of the creative iframe
   * On desktop this is sized to the creative dimensions;
   * on mobile one dimension is fixed to 100%.
   */
  return new PbPromise((resolve, reject) => {
    let tryCounter = 10;
    // wait until GPT has set dimensions on the ins, otherwise our changes will be overridden
    const resizer = setInterval(() => {
      let done = false;
      Object.entries({width, height})
        .forEach(([dimension, newValue]) => {
          if (/\d+px/.test(ins.style[dimension])) {
            ins.style[dimension] = getDimension(newValue);
            done = true;
          }
        })
      if (done || (tryCounter-- === 0)) {
        clearInterval(resizer);
        done ? resolve() : reject(new Error('Could not resize anchor'))
      }
    }, 50)
  })
}

export function resizeRemoteCreative({instl, adId, adUnitCode, width, height}) {
  // do not resize interstitials - the creative frame takes the full screen and sizing of the ad should
  // be handled within it.
  if (instl) return;

  function resize(element) {
    if (element) {
      const elementStyle = element.style;
      elementStyle.width = getDimension(width)
      elementStyle.height = getDimension(height);
    } else {
      logError(`Unable to locate matching page element for adUnitCode ${adUnitCode}.  Can't resize it to ad's dimensions.  Please review setup.`);
    }
  }

  // not select element that gets removed after dfp render
  const iframe = getElementByAdUnit('iframe:not([style*="display: none"])');
  resize(iframe);
  const anchorIns = iframe?.closest('ins[data-anchor-status]');
  anchorIns ? resizeAnchor(anchorIns, width, height) : resize(iframe?.parentElement);

  function getElementByAdUnit(elmType) {
    const id = getElementIdBasedOnAdServer(adId, adUnitCode);
    const parentDivEle = document.getElementById(id);
    return parentDivEle && parentDivEle.querySelector(elmType);
  }

  function getElementIdBasedOnAdServer(adId, adUnitCode) {
    if (isGptPubadsDefined()) {
      const dfpId = getDfpElementId(adId);
      if (dfpId) {
        return dfpId;
      }
    }
    if (isApnGetTagDefined()) {
      const apnId = getAstElementId(adUnitCode);
      if (apnId) {
        return apnId;
      }
    }
    return adUnitCode;
  }

  function getDfpElementId(adId) {
    const slot = window.googletag.pubads().getSlots().find(slot => {
      return slot.getTargetingKeys().find(key => {
        return slot.getTargeting(key).includes(adId);
      });
    });
    return slot ? slot.getSlotElementId() : null;
  }

  function getAstElementId(adUnitCode) {
    const astTag = window.apntag.getTag(adUnitCode);
    return astTag && astTag.targetId;
  }
}

1	/* Secure Creatives
2	Provides support for rendering creatives into cross domain iframes such as SafeFrame to prevent
3	access to a publisher page from creative payloads.
4	*/
5
6	import {getAllAssetsMessage, getAssetMessage} from './native.js';
7	import {BID_STATUS, MESSAGES} from './constants.js';
8	import {isApnGetTagDefined, isGptPubadsDefined, logError, logWarn} from './utils.js';
9	import {
10	deferRendering,
11	getBidToRender,
12	handleCreativeEvent,
13	handleNativeMessage,
14	handleRender,
15	markWinner
16	} from './adRendering.js';
17	import {getCreativeRendererSource, PUC_MIN_VERSION} from './creativeRenderers.js';
18	import {PbPromise} from './utils/promise.js';
19
20	const { REQUEST, RESPONSE, NATIVE, EVENT } = MESSAGES;	8✔
21
22	const HANDLER_MAP = {	8✔
23	[REQUEST]: handleRenderRequest,
24	[EVENT]: handleEventRequest,
25	};
26
27	if (FEATURES.NATIVE) {	8✔
28	Object.assign(HANDLER_MAP, {	8✔
29	[NATIVE]: handleNativeRequest,
30	});
31	}
32
33	export function listenMessagesFromCreative() {
34	window.addEventListener('message', function (ev) {	1✔
35	receiveMessage(ev);	×
36	}, false);
37	}
38
39	export function getReplier(ev) {
40	if (ev.origin == null && ev.ports.length === 0) {	21✔
41	return function () {	1✔
42	const msg = 'Cannot post message to a frame with null origin. Please update creatives to use MessageChannel, see https://github.com/prebid/Prebid.js/issues/7870';	1✔
43	logError(msg);	1✔
44	throw new Error(msg);	1✔
45	};
46	} else if (ev.ports.length > 0) {	20✔
47	return function (message) {	1✔
48	ev.ports[0].postMessage(JSON.stringify(message));	1✔
49	};
50	} else {
51	return function (message) {	19✔
52	ev.source.postMessage(JSON.stringify(message), ev.origin);	7✔
53	};
54	}
55	}
56
57	function ensureAdId(adId, reply) {
58	return function (data, ...args) {	18!
59	return reply(Object.assign({}, data, {adId}), ...args);	6✔
60	}
61	}
62
63	export function receiveMessage(ev, cb) {
64	var key = ev.message ? 'message' : 'data';	18!
65	var data = {};	18✔
66	try {	18✔
67	data = JSON.parse(ev[key]);	18✔
68	} catch (e) {
69	return;	×
70	}
71
72	if (data && data.adId && data.message && HANDLER_MAP.hasOwnProperty(data.message)) {	18✔
73	return getBidToRender(data.adId, data.message === MESSAGES.REQUEST, (adObject) => {	18✔
74	HANDLER_MAP[data.message](ensureAdId(data.adId, getReplier(ev)), data, adObject);	18✔
75	cb && cb();	18✔
76	});
77	}
78	}
79
80	function getResizer(adId, bidResponse) {
81	// in some situations adId !== bidResponse.adId
82	// the first is the one that was requested and is tied to the element
83	// the second is the one that is being rendered (sometimes different, e.g. in some paapi setups)
84	return function (width, height) {	11✔
85	resizeRemoteCreative({...bidResponse, width, height, adId});	2✔
86	}
87	}
88	function handleRenderRequest(reply, message, bidResponse) {
89	handleRender({	9✔
90	renderFn(adData) {
91	reply(Object.assign({	3✔
92	message: RESPONSE,
93	renderer: getCreativeRendererSource(bidResponse),
94	rendererVersion: PUC_MIN_VERSION
95	}, adData));
96	},
97	resizeFn: getResizer(message.adId, bidResponse),
98	options: message.options,
99	adId: message.adId,
100	bidResponse
101	});
102	}
103
104	function handleNativeRequest(reply, data, adObject) {
105	// handle this script from native template in an ad server
106	// window.parent.postMessage(JSON.stringify({
107	// message: 'Prebid Native',
108	// adId: '%%PATTERN:hb_adid%%'
109	// }), '*');
110	if (adObject == null) {	5!
111	logError(`Cannot find ad for x-origin event request: '${data.adId}'`);	×
UNCOV 112	return;	×
113	}
114	switch (data.action) {	5!
115	case 'assetRequest':
116	deferRendering(adObject, () => reply(getAssetMessage(data, adObject)));	×
UNCOV 117	break;	×
118	case 'allAssetRequest':
119	deferRendering(adObject, () => reply(getAllAssetsMessage(data, adObject)));	3✔
120	break;	3✔
121	default:
122	handleNativeMessage(data, adObject, {resizeFn: getResizer(data.adId, adObject)});	2✔
123	markWinner(adObject);	2✔
124	}
125	}
126
127	function handleEventRequest(reply, data, adObject) {
128	if (adObject == null) {	4!
129	logError(`Cannot find ad '${data.adId}' for x-origin event request`);	×
UNCOV 130	return;	×
131	}
132	if (adObject.status !== BID_STATUS.RENDERED) {	4✔
133	logWarn(`Received x-origin event request without corresponding render request for ad '${adObject.adId}'`);	2✔
134	return;	2✔
135	}
136	return handleCreativeEvent(data, adObject);	2✔
137	}
138
139	function getDimension(value) {
140	return value ? value + 'px' : '100%';	9!
141	}
142
143	export function resizeAnchor(ins, width, height) {
144	/**
145	* Special handling for google anchor ads
146	* For anchors, the element to resize is an <ins> element that is an ancestor of the creative iframe
147	* On desktop this is sized to the creative dimensions;
148	* on mobile one dimension is fixed to 100%.
149	*/
150	return new PbPromise((resolve, reject) => {	4✔
151	let tryCounter = 10;	4✔
152	// wait until GPT has set dimensions on the ins, otherwise our changes will be overridden
153	const resizer = setInterval(() => {	4✔
154	let done = false;	22✔
155	Object.entries({width, height})	22✔
156	.forEach(([dimension, newValue]) => {	44✔
157	if (/\d+px/.test(ins.style[dimension])) {	44✔
158	ins.style[dimension] = getDimension(newValue);	5✔
159	done = true;	5✔
160	}
161	})
162	if (done \|\| (tryCounter-- === 0)) {	22✔
163	clearInterval(resizer);	4✔
164	done ? resolve() : reject(new Error('Could not resize anchor'))	4✔
165	}
166	}, 50)
167	})
168	}
169
170	export function resizeRemoteCreative({instl, adId, adUnitCode, width, height}) {	7✔
171	// do not resize interstitials - the creative frame takes the full screen and sizing of the ad should
172	// be handled within it.
173	if (instl) return;	7✔
174
175	function resize(element) {
176	if (element) {	12✔
177	const elementStyle = element.style;	2✔
178	elementStyle.width = getDimension(width)	2✔
179	elementStyle.height = getDimension(height);	2✔
180	} else {
181	logError(`Unable to locate matching page element for adUnitCode ${adUnitCode}. Can't resize it to ad's dimensions. Please review setup.`);	10✔
182	}
183	}
184
185	// not select element that gets removed after dfp render
186	const iframe = getElementByAdUnit('iframe:not([style*="display: none"])');	6✔
187	resize(iframe);	6✔
188	const anchorIns = iframe?.closest('ins[data-anchor-status]');	6✔
189	anchorIns ? resizeAnchor(anchorIns, width, height) : resize(iframe?.parentElement);	6!
190
191	function getElementByAdUnit(elmType) {
192	const id = getElementIdBasedOnAdServer(adId, adUnitCode);	6✔
193	const parentDivEle = document.getElementById(id);	6✔
194	return parentDivEle && parentDivEle.querySelector(elmType);	6✔
195	}
196
197	function getElementIdBasedOnAdServer(adId, adUnitCode) {
198	if (isGptPubadsDefined()) {	6✔
199	const dfpId = getDfpElementId(adId);	5✔
200	if (dfpId) {	5✔
201	return dfpId;	1✔
202	}
203	}
204	if (isApnGetTagDefined()) {	5✔
205	const apnId = getAstElementId(adUnitCode);	4✔
206	if (apnId) {	4✔
207	return apnId;	1✔
208	}
209	}
210	return adUnitCode;	4✔
211	}
212
213	function getDfpElementId(adId) {
214	const slot = window.googletag.pubads().getSlots().find(slot => {	5✔
215	return slot.getTargetingKeys().find(key => {	13✔
216	return slot.getTargeting(key).includes(adId);	3✔
217	});
218	});
219	return slot ? slot.getSlotElementId() : null;	5✔
220	}
221
222	function getAstElementId(adUnitCode) {
223	const astTag = window.apntag.getTag(adUnitCode);	4✔
224	return astTag && astTag.targetId;	4✔
225	}
226	}

prebid / Prebid.js / 21444465511

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous