@streamlayer/feature-advertisement 1.1.1-rc.1345 → 1.1.1-rc.2.pf58ff685

package/lib/cjs/units/ssai-providers.js

@@ -2,9 +2,55 @@
 
 var sdkWebLogger = require('@streamlayer/sdk-web-logger');
 var vastClient = require('@dailymotion/vast-client');
+var ssaiLog = require('./ssai-log.js');
 
 const log = sdkWebLogger.createLogger('ssai:provider');
 const DEFAULT_CREATIVE_API_BASE = 'https://hls.next.streamlayer.io/api/creatives/';
+/**
+ * One creative-metadata round trip, on the narrative log: the request the SDK
+ * made and the body the ad service answered with, verbatim. This is the half of
+ * the story the manifest cannot tell — the ad's identity comes from the playout,
+ * its content comes from here.
+ */
+const fetchCreativeJson = async (providerId, url, signal) => {
+    // `adApiBase` is customer infrastructure and may carry a key in its query;
+    // the request uses the URL as given, the log gets it with such values masked.
+    const shown = maskUrlSecrets(url);
+    ssaiLog.ssaiq.info({ provider: providerId, url: shown }, `[GET] → ${shown}`);
+    let response;
+    try {
+        response = await fetch(url, { signal });
+    }
+    catch (error) {
+        // An abort is the SDK cancelling its own request (break ended, creative
+        // changed) — a note, not a failure.
+        if (error?.name === 'AbortError') {
+            ssaiLog.ssaiq.debug({ provider: providerId, url: shown }, `[GET] ✗ aborted ${shown}`);
+        }
+        else {
+            ssaiLog.ssaiq.warn({ provider: providerId, url: shown, error: String(error) }, `[GET] ✗ ${shown}`);
+        }
+        throw error;
+    }
+    if (!response.ok) {
+        ssaiLog.ssaiq.warn({ provider: providerId, url: shown, status: response.status }, `[GET] ✗ ${response.status} ${shown}`);
+        throw new Error(`${providerId} creative request failed: ${response.status}`);
+    }
+    let raw;
+    try {
+        raw = (await response.json());
+    }
+    catch (error) {
+        // A 200 with a body that is not JSON would otherwise leave the log looking
+        // like a request still in flight.
+        ssaiLog.ssaiq.warn({ provider: providerId, url: shown, error: String(error) }, `[GET] ✗ ${response.status} ${shown} — not JSON`);
+        throw error;
+    }
+    ssaiLog.ssaiq.info({ provider: providerId, status: response.status, body: raw }, `[GET] ← ${response.status} ad metadata — ${raw?.advertiser || raw?.title || raw?.creativeId || 'ad'}`);
+    return raw;
+};
+/** `?apiKey=…` → `?apiKey=«redacted»`, for URLs that go on a screen. Regex, not `URL`: this ships to 2016 TV engines. */
+const maskUrlSecrets = (url) => url.replace(/([?&][^=&]*(?:token|secret|password|key|authorization)[^=&]*=)[^&]*/gi, '$1«redacted»');
 /**
  * Shared low-level beacon helper. Prefers `navigator.sendBeacon` and falls back
  * to a no-cors `fetch`. Used by the default impression path and available to
@@ -103,12 +149,7 @@ const createStreamLayerProvider = (config = {}) => {
     return {
         id: 'streamlayer',
         resolve: async (creativeId, signal) => {
-            const url = buildCreativeUrl(creativeApiBase, creativeId);
-            const response = await fetch(url, { signal });
-            if (!response.ok) {
-                throw new Error(`creative request failed: ${response.status}`);
-            }
-            const raw = (await response.json());
+            const raw = await fetchCreativeJson('streamlayer', buildCreativeUrl(creativeApiBase, creativeId), signal);
             return mapApiResponse({ ...raw, creativeId: raw.creativeId || creativeId });
         },
         fireImpression: fireDefaultImpression,
@@ -152,11 +193,7 @@ const createQuortexProvider = (config = {}) => {
             if (!adApiBase) {
                 throw new Error('quortex provider is missing `adApiBase`');
             }
-            const response = await fetch(buildQuortexUrl(adApiBase, tenantName, adId), { signal });
-            if (!response.ok) {
-                throw new Error(`quortex creative request failed: ${response.status}`);
-            }
-            const raw = (await response.json());
+            const raw = await fetchCreativeJson('quortex', buildQuortexUrl(adApiBase, tenantName, adId), signal);
             return mapApiResponse({ ...raw, creativeId: raw.creativeId || adId });
         },
         fireImpression: fireDefaultImpression,

package/lib/classic/advertisement.js

@@ -1,6 +1,7 @@
 import { defineProperty as _defineProperty, objectSpread2 as _objectSpread2 } from './_virtual/_rollupPluginBabelHelpers.js';
 import 'core-js/modules/es.array.iterator.js';
 import 'core-js/modules/esnext.iterator.constructor.js';
+import 'core-js/modules/esnext.iterator.find.js';
 import 'core-js/modules/esnext.iterator.for-each.js';
 import 'core-js/modules/esnext.set.difference.v2.js';
 import 'core-js/modules/esnext.set.intersection.v2.js';
@@ -20,6 +21,7 @@ import { SsaiCreativeCache } from './units/ssai-creative.js';
 import { resolveProvider } from './units/ssai-providers.js';
 import { createSsaiDetector } from './units/ssai-detector.js';
 import { createSsaiAdBreakStore } from './units/ssai-ad-break.js';
+import { ssaiq } from './units/ssai-log.js';
 import { preloadCreativeAssets } from './units/ssai-preload.js';
 
 class Advertisement extends AbstractFeatureUnit {
@@ -165,10 +167,33 @@ class Advertisement extends AbstractFeatureUnit {
       const provider = resolveProvider(options.provider);
       const cache = new SsaiCreativeCache(provider);
       this.ssaiCache = cache;
+      /**
+       * Every beacon the SDK fires gets a line, with the URL it was fired at.
+       * The narrative log is read as a live trace of one ad, and "we called the
+       * ad server's own tracking URL" is as much of the story as the request
+       * that fetched the creative in the first place.
+       */
+      const logBeacon = (creativeId, event) => {
+        var _cache$peek;
+        const url = (_cache$peek = cache.peek(creativeId)) === null || _cache$peek === void 0 || (_cache$peek = _cache$peek.trackingEvents) === null || _cache$peek === void 0 || (_cache$peek = _cache$peek.find(entry => entry.event === event)) === null || _cache$peek === void 0 ? void 0 : _cache$peek.url;
+        ssaiq.info({
+          creativeId,
+          event,
+          url
+        }, `[beacon] ${event} fired — ${creativeId}`);
+      };
       this.fireSsaiImpression = creativeId => {
+        var _cache$peek2;
+        // The UI only calls this once the bar is actually rendered, so this is
+        // the moment the viewer saw the ad — not the moment it resolved.
+        ssaiq.info({
+          creativeId
+        }, `[ad] ad on screen — ${((_cache$peek2 = cache.peek(creativeId)) === null || _cache$peek2 === void 0 ? void 0 : _cache$peek2.advertiser) || creativeId}`);
+        logBeacon(creativeId, 'impression');
         cache.fireImpressionById(creativeId);
       };
       this.fireSsaiTracking = (creativeId, event) => {
+        logBeacon(creativeId, event);
         cache.fireTrackingById(creativeId, event);
       };
       this.fireSsaiCompanionClick = creativeId => {
@@ -186,10 +211,14 @@ class Advertisement extends AbstractFeatureUnit {
        * when the ad actually starts.
        */
       const prefetchCreative = creativeId => {
-        cache.resolve(creativeId).then(creative => preloadCreativeAssets(creative)).then(() => {
+        cache.resolve(creativeId).then(creative => preloadCreativeAssets(creative).then(() => creative)).then(creative => {
           preloadedIds.add(creativeId);
-        }).catch(error => {
-          this.log.debug(error, 'ssai creative prefetch failed');
+          ssaiq.info({
+            creativeId
+          }, `[ad] creative ready — ${creative.advertiser} (artwork preloaded)`);
+        }).catch(() => {
+          // Already on `ssaiq` from the provider; the break may still be
+          // minutes away, and `loadCreative` retries when it actually starts.
         });
       };
       const publishReady = (range, creative) => {
@@ -251,15 +280,9 @@ class Advertisement extends AbstractFeatureUnit {
         videoRef: options.videoRef,
         manifestUrl: options.manifestUrl,
         onAdDiscovered: creativeId => {
-          this.log.debug({
-            creativeId
-          }, 'ssai ad discovered, prefetching creative');
           prefetchCreative(creativeId);
         },
         onBreakStart: range => {
-          this.log.debug({
-            creativeId: range.creativeId
-          }, 'ssai break start');
           eventBus.emit('ssaiAdBreak', {
             action: 'breakStart',
             payload: {
@@ -269,9 +292,6 @@ class Advertisement extends AbstractFeatureUnit {
           loadCreative(range);
         },
         onCreativeChange: range => {
-          this.log.debug({
-            creativeId: range.creativeId
-          }, 'ssai creative change');
           loadCreative(range);
         },
         onAdEnding: range => {
@@ -286,14 +306,11 @@ class Advertisement extends AbstractFeatureUnit {
           }));
         },
         onProgress: (range, event) => {
-          this.log.debug({
-            creativeId: range.creativeId,
-            event
-          }, 'ssai progress');
+          // Logged by the detector as `progress:<event>` at the moment playback
+          // crosses the marker; nothing to add here.
           cache.fireTrackingById(range.creativeId, event);
         },
         onBreakEnd: () => {
-          this.log.debug('ssai break end');
           const current = this.ssaiAdBreak.get();
           eventBus.emit('ssaiAdBreak', {
             action: 'breakEnd',

package/lib/classic/cjs/advertisement.js

@@ -3,6 +3,7 @@
 var _rollupPluginBabelHelpers = require('./_virtual/_rollupPluginBabelHelpers.js');
 require('core-js/modules/es.array.iterator.js');
 require('core-js/modules/esnext.iterator.constructor.js');
+require('core-js/modules/esnext.iterator.find.js');
 require('core-js/modules/esnext.iterator.for-each.js');
 require('core-js/modules/esnext.set.difference.v2.js');
 require('core-js/modules/esnext.set.intersection.v2.js');
@@ -22,6 +23,7 @@ var ssaiCreative = require('./units/ssai-creative.js');
 var ssaiProviders = require('./units/ssai-providers.js');
 var ssaiDetector = require('./units/ssai-detector.js');
 var ssaiAdBreak = require('./units/ssai-ad-break.js');
+var ssaiLog = require('./units/ssai-log.js');
 var ssaiPreload = require('./units/ssai-preload.js');
 
 class Advertisement extends classic.AbstractFeatureUnit {
@@ -167,10 +169,33 @@ class Advertisement extends classic.AbstractFeatureUnit {
       const provider = ssaiProviders.resolveProvider(options.provider);
       const cache = new ssaiCreative.SsaiCreativeCache(provider);
       this.ssaiCache = cache;
+      /**
+       * Every beacon the SDK fires gets a line, with the URL it was fired at.
+       * The narrative log is read as a live trace of one ad, and "we called the
+       * ad server's own tracking URL" is as much of the story as the request
+       * that fetched the creative in the first place.
+       */
+      const logBeacon = (creativeId, event) => {
+        var _cache$peek;
+        const url = (_cache$peek = cache.peek(creativeId)) === null || _cache$peek === void 0 || (_cache$peek = _cache$peek.trackingEvents) === null || _cache$peek === void 0 || (_cache$peek = _cache$peek.find(entry => entry.event === event)) === null || _cache$peek === void 0 ? void 0 : _cache$peek.url;
+        ssaiLog.ssaiq.info({
+          creativeId,
+          event,
+          url
+        }, `[beacon] ${event} fired — ${creativeId}`);
+      };
       this.fireSsaiImpression = creativeId => {
+        var _cache$peek2;
+        // The UI only calls this once the bar is actually rendered, so this is
+        // the moment the viewer saw the ad — not the moment it resolved.
+        ssaiLog.ssaiq.info({
+          creativeId
+        }, `[ad] ad on screen — ${((_cache$peek2 = cache.peek(creativeId)) === null || _cache$peek2 === void 0 ? void 0 : _cache$peek2.advertiser) || creativeId}`);
+        logBeacon(creativeId, 'impression');
         cache.fireImpressionById(creativeId);
       };
       this.fireSsaiTracking = (creativeId, event) => {
+        logBeacon(creativeId, event);
         cache.fireTrackingById(creativeId, event);
       };
       this.fireSsaiCompanionClick = creativeId => {
@@ -188,10 +213,14 @@ class Advertisement extends classic.AbstractFeatureUnit {
        * when the ad actually starts.
        */
       const prefetchCreative = creativeId => {
-        cache.resolve(creativeId).then(creative => ssaiPreload.preloadCreativeAssets(creative)).then(() => {
+        cache.resolve(creativeId).then(creative => ssaiPreload.preloadCreativeAssets(creative).then(() => creative)).then(creative => {
           preloadedIds.add(creativeId);
-        }).catch(error => {
-          this.log.debug(error, 'ssai creative prefetch failed');
+          ssaiLog.ssaiq.info({
+            creativeId
+          }, `[ad] creative ready — ${creative.advertiser} (artwork preloaded)`);
+        }).catch(() => {
+          // Already on `ssaiq` from the provider; the break may still be
+          // minutes away, and `loadCreative` retries when it actually starts.
         });
       };
       const publishReady = (range, creative) => {
@@ -253,15 +282,9 @@ class Advertisement extends classic.AbstractFeatureUnit {
         videoRef: options.videoRef,
         manifestUrl: options.manifestUrl,
         onAdDiscovered: creativeId => {
-          this.log.debug({
-            creativeId
-          }, 'ssai ad discovered, prefetching creative');
           prefetchCreative(creativeId);
         },
         onBreakStart: range => {
-          this.log.debug({
-            creativeId: range.creativeId
-          }, 'ssai break start');
           classic.eventBus.emit('ssaiAdBreak', {
             action: 'breakStart',
             payload: {
@@ -271,9 +294,6 @@ class Advertisement extends classic.AbstractFeatureUnit {
           loadCreative(range);
         },
         onCreativeChange: range => {
-          this.log.debug({
-            creativeId: range.creativeId
-          }, 'ssai creative change');
           loadCreative(range);
         },
         onAdEnding: range => {
@@ -288,14 +308,11 @@ class Advertisement extends classic.AbstractFeatureUnit {
           }));
         },
         onProgress: (range, event) => {
-          this.log.debug({
-            creativeId: range.creativeId,
-            event
-          }, 'ssai progress');
+          // Logged by the detector as `progress:<event>` at the moment playback
+          // crosses the marker; nothing to add here.
           cache.fireTrackingById(range.creativeId, event);
         },
         onBreakEnd: () => {
-          this.log.debug('ssai break end');
           const current = this.ssaiAdBreak.get();
           classic.eventBus.emit('ssaiAdBreak', {
             action: 'breakEnd',

package/lib/classic/cjs/index.js

@@ -3,6 +3,7 @@
 var advertisement$1 = require('./advertisement.js');
 var externalPauseAd = require('./units/external-pause-ad.js');
 var pauseAdCard = require('./units/pause-ad-card.js');
+var sponsorLogo = require('./units/sponsor-logo.js');
 var gam = require('./units/gam.js');
 var vastTracker = require('./units/vast-tracker.js');
 require('core-js/modules/es.array.iterator.js');
@@ -29,6 +30,7 @@ const advertisement = (instance, _opts, done) => {
 
 exports.isFullbleedVideoTemplate = externalPauseAd.isFullbleedVideoTemplate;
 exports.INSIGHT_BODY_MAX_LENGTH = pauseAdCard.INSIGHT_BODY_MAX_LENGTH;
+exports.selectSponsorLogo = sponsorLogo.selectSponsorLogo;
 exports.gam = gam.gam;
 exports.createCompanionTracker = vastTracker.createCompanionTracker;
 exports.createVastTracker = vastTracker.createVastTracker;

package/lib/classic/cjs/units/ad-macros.js

@@ -0,0 +1,115 @@
+'use strict';
+
+require('core-js/modules/es.regexp.exec.js');
+require('core-js/modules/es.string.replace.js');
+
+/**
+ * Ad-tag macro substitution, for every ad server — not just GAM.
+ *
+ * Studio stores a programmatic tag verbatim (`gamRawUrl`, returned untouched by
+ * `processGamAdvertisement`), so whatever macros the ad server's own tag builder emitted reach the
+ * SDK literal. `gam()` used to fill only the GAM `[placeholder]` token, and only for
+ * `pubads.g.doubleclick.net` — every other vendor's tag went out with its macros unexpanded.
+ *
+ * That is not inert. Measured against the ADITION tag on event 11089
+ * (`…/banner?…&ts=[timestamp]&clickurl=[clickmacro]`): ADITION prepends the value of `clickurl` to
+ * its own redi URL, so a literal `[clickmacro]` came back inside `<CompanionClickThrough>` as
+ * `[clickmacro]https%3A%2F%2Fad1…` — a broken click-through. Sending `clickurl=` empty answers with
+ * a valid redi URL.
+ *
+ * **Two sources.** The cache buster is the SDK's own. The consent family — `${GDPR}` and
+ * `${GDPR_CONSENT_<gvlid>}`, IAB TCF, where the id is the vendor's Global Vendor List entry (39 is
+ * ADITION / Virtual Minds) — and the click macro come from the host app (`AdTagParams`, set through
+ * the `adTagParams` option or `sdk.setAdTagParams`). The SDK never reads a CMP and never guesses
+ * consent: a value the host did not pass goes out EMPTY, which ad servers read as "unknown" — never
+ * as `gdpr=0`. Empty rather than literal because a literal is not inert either: ADITION copied
+ * `${GDPR}` into its own redirect URL (`gdpr%3D%24%7BGDPR%7D`). See
+ * `docs/wiki/programmatic-ads-macros.md`.
+ *
+ * An unknown macro is left exactly as configured, which is what keeps the GAM `[placeholder]`
+ * tokens for the PAL path (`gam.ts` fills those per parameter, not per token).
+ */
+/**
+ * All three spellings in the wild — `[NAME]` (IAB / SpotX), `${NAME}` (Google) and bare `{NAME}` —
+ * each with its delimiters either literal or PERCENT-ENCODED.
+ *
+ * Neither half of that is theoretical. ADITION emitted `[timestamp]` / `[clickmacro]` for the
+ * campaign on event 11089 and `{CACHEBUSTER}` / `{GDPR}` for the one on 6203 — same ad server, same
+ * advertiser, different tag builder. And Studio stores the 6203 tag as `ts=%7BCACHEBUSTER%7D`, so
+ * matching only literal braces made the whole substitution a silent no-op on it: an unexpanded
+ * macro raises no error and the ad server still answers 200. `searchParams.get()` decodes on read,
+ * which is what hides the encoding from anyone inspecting the parsed URL.
+ *
+ * The `$` is optional rather than a fourth branch — an unowned `${NAME}` still returns its full
+ * matched text, `$` included, so the brace forms cannot corrupt each other.
+ */
+const MACRO_PATTERN = /(?:\[|%5B)([a-z0-9_]+)(?:\]|%5D)|(?:\$|%24)?(?:\{|%7B)([a-z0-9_]+)(?:\}|%7D)/gi;
+/**
+ * Every host value lands inside a query-string VALUE, so it is encoded exactly once. That matters
+ * most for the click URL, which carries its own `?`/`&`: sent raw it re-opens the tag's query, the
+ * way the malformed 6203 tag did (`clickurl` truncated, every following parameter duplicated).
+ */
+const hostValue = value => value ? encodeURIComponent(value) : '';
+const gdprConsent = ({
+  params
+}) => hostValue(params === null || params === void 0 ? void 0 : params.tcString);
+/**
+ * Macro name (lower-cased) → the value this SDK sends for it.
+ *
+ * `clickurl` / `clickmacro` take the host's click tracker, which the ad server PREPENDS to its own
+ * redirect — so the viewer's click passes host tracker → vendor redirect → landing page. The SDK
+ * does not fire that tracker itself; it would count the click twice. Without one it is empty, the
+ * documented "no player tracker" value. VAST click beacons are reported separately by
+ * `useSidebarVastTracker`.
+ */
+const MACRO_VALUES = {
+  // One family, one value: every name here means "make this request unique so nothing caches it".
+  // Epoch milliseconds satisfies that for all of them, and keeps the value already shipped for
+  // `timestamp` unchanged. (IAB defines `[CACHEBUSTING]` as a random 8-digit number and
+  // `[TIMESTAMP]` as ISO-8601, but those describe VAST *tracking* URLs; this substitution only
+  // ever touches the ad REQUEST url, where every ad server documents the parameter as a number.)
+  timestamp: ({
+    now
+  }) => String(now),
+  cachebuster: ({
+    now
+  }) => String(now),
+  cachebusting: ({
+    now
+  }) => String(now),
+  clickmacro: ({
+    params
+  }) => hostValue(params === null || params === void 0 ? void 0 : params.clickUrl),
+  clickurl: ({
+    params
+  }) => hostValue(params === null || params === void 0 ? void 0 : params.clickUrl),
+  // `1` / `0` only from an explicit boolean — an absent value is unknown, not "does not apply".
+  gdpr: ({
+    params
+  }) => (params === null || params === void 0 ? void 0 : params.gdprApplies) === undefined ? '' : params.gdprApplies ? '1' : '0',
+  gdpr_consent: gdprConsent
+};
+/** `GDPR_CONSENT_<gvlid>`: the vendor id names whose tag this is; the value is the same TC string. */
+const GDPR_CONSENT_FOR_VENDOR = /^gdpr_consent_\d+$/;
+const resolveMacro = name => {
+  var _MACRO_VALUES$name;
+  return (_MACRO_VALUES$name = MACRO_VALUES[name]) !== null && _MACRO_VALUES$name !== void 0 ? _MACRO_VALUES$name : GDPR_CONSENT_FOR_VENDOR.test(name) ? gdprConsent : undefined;
+};
+/**
+ * Fill the macros this SDK knows in an ad-tag URL. One timestamp per call, so a tag naming the macro
+ * twice stays self-consistent. `params` is read as given — the caller passes the host's CURRENT
+ * values at request time.
+ */
+const substituteAdTagMacros = (url, params) => {
+  const now = Date.now();
+  return url.replace(MACRO_PATTERN, (match, bracketed, braced) => {
+    var _ref;
+    const value = resolveMacro(((_ref = bracketed !== null && bracketed !== void 0 ? bracketed : braced) !== null && _ref !== void 0 ? _ref : '').toLowerCase());
+    return value ? value({
+      now,
+      params
+    }) : match;
+  });
+};
+
+exports.substituteAdTagMacros = substituteAdTagMacros;