@schibsted/pulse-sdk 8.0.0-rc.2 → 8.0.0-rc.20

package/dist/ejs/leaveTrackingTpaas/index.js

@@ -1,6 +1,6 @@
-import { isBrowser, isFunction, throttle } from '@schibsted/pulse-utils';
 import * as logger from 'loglevel';
-import { DEFAULT_ACTIVITY_DURATION, DEFAULT_PAGE_LEAVE_EVENT } from './constants';
+import { isBrowser, isFunction, throttle } from '../utils';
+import { ACTIVITY_DURATION_LIMIT_MS, DEFAULT_PAGE_LEAVE_EVENT } from './constants';
 import { BrowserEvents } from './types';
 let currentLeaveSchema;
 let currentTrackMethod;
@@ -9,19 +9,44 @@ let updateViewedContentListeners = [];
 let activityListeners = [];
 let resizeObserver = null;
 let throttledUpdateFn = throttle(() => undefined, 0);
-let startTime = 0;
-let activityDuration = DEFAULT_ACTIVITY_DURATION();
+let durationStartTime = 0;
+let previousActivityTime = 0;
+let activityDurationMs = 0;
 let currentLeaveEvent = DEFAULT_PAGE_LEAVE_EVENT();
 let additionalHeightBuilder;
+/**
+ * Resolves a DOM element from either a CSS selector string or an Element instance.
+ */
+function resolveDomElement(element) {
+    try {
+        return typeof element === 'string' ? document.querySelector(element) : element || null;
+    }
+    catch (e) {
+        logger.error('Error while resolving DOM element', e);
+        return null;
+    }
+}
 /*
  Add leave tracking
  */
 export function addTpaasLeaveTracking({ objectElement, pageElement, schema, objectResizable, heightBuilder, trackMethod, }) {
     function _addLeaveTracking() {
+        const objectDomElement = resolveDomElement(objectElement);
+        if (objectDomElement == null) {
+            logger.error('Could not find object element for leave tracking');
+            return;
+        }
+        let pageDomElement = resolveDomElement(pageElement);
+        if (pageDomElement == null) {
+            logger.warn('Could not find page element for leave tracking, defaulting to document.body');
+            pageDomElement = document.body;
+        }
         additionalHeightBuilder = heightBuilder;
         addTpaasLeaveListeners();
-        addUpdateEventListeners(objectElement, pageElement || document.body, objectResizable);
-        startTime = resetTime();
+        addUpdateEventListeners(objectDomElement, pageDomElement, objectResizable);
+        previousActivityTime = resetTime();
+        durationStartTime = resetTime();
+        activityDurationMs = 0;
         currentLeaveSchema = schema;
         currentTrackMethod = trackMethod;
         logger.debug('addLeaveTracking:after:state', currentLeaveEvent);
@@ -113,12 +138,9 @@ function removeUpdateEventListeners() {
  */
 const resetEventDefaults = () => {
     currentLeaveEvent = DEFAULT_PAGE_LEAVE_EVENT();
-    startTime = resetTime();
-    activityDuration = resetActivityDuration();
-};
-const resetActivityDuration = () => {
-    clearInterval(activityDuration.interval);
-    return DEFAULT_ACTIVITY_DURATION();
+    durationStartTime = resetTime();
+    previousActivityTime = resetTime();
+    activityDurationMs = 0;
 };
 export const resetTpaasViewedContent = () => {
     currentLeaveEvent = DEFAULT_PAGE_LEAVE_EVENT();
@@ -126,34 +148,43 @@ export const resetTpaasViewedContent = () => {
 const resetTime = () => Date.now();
 /*
  Send a Leave event only if Page Leave tracking is active in the SDK
- The event that is ultimately sent is a merge between the default event
- saved in this file and the event supplied by the brand, with preference going
- to the brand event. After the event has been sent, leave page tracking is removed
+ The event that is ultimately sent is the View event saved in the currentTrackMethod callback.
+ After the event has been sent, leave page tracking is removed
  and must be explicitly re-added if needed.
 */
-export function trackTpaasActiveLeave() {
+export async function trackTpaasActiveLeave() {
     if (leaveTpaasTrackingIsActive()) {
-        trackTpaasLeave();
+        await trackTpaasLeave();
     }
 }
 /*
  Send a Leave event regardless of whether Page Leave tracking is active in the SDK
- The event that is ultimately sent is a merge between the default event
- saved in this file and the event supplied by the brand, with preference going
- to the brand event. After the event has been sent, leave page tracking is removed
+ The event that is ultimately sent is the View event saved in the currentTrackMethod callback.
+ After the event has been sent, leave page tracking is removed
  and must be explicitly re-added if needed.
  */
-export function trackTpaasLeave() {
+export async function trackTpaasLeave() {
     const leave = getTpaasLeaveObject();
-    currentTrackMethod(leave);
+    // Capture currentTrackMethod and remove tracking synchronously before awaiting.
+    // If removal happened after the await, a new trackView* call arriving during the async
+    // gap would see tracking still active with the same schema and silently discard its
+    // new callback (e.g. a fresh leaveAudioBuilder), causing the next leave event to
+    // never fire or to use the wrong builder.
+    const trackMethod = currentTrackMethod;
     removeTpaasLeaveTracking();
+    await trackMethod(leave);
 }
 export function getTpaasLeaveObject() {
     const endTime = Date.now();
-    const duration = endTime - startTime;
+    // TPaaS leave event requires duration/activity to be at least 1ms, otherwise the event is rejected
+    // also, in practice, it's almost impossible to have an activity or duration of 0ms
+    // We don't call increaseActivityDuration here because it's possible to call getTpaasLeaveObject multiple times
+    // without any activity events in between, which would incorrectly increase the activity duration.
+    const durationMs = Math.max(endTime - durationStartTime, 1);
+    const lastActivityDuration = calculateActivityGap(endTime);
     const leave = {
-        durationMs: duration,
-        activityDurationMs: activityDuration.value,
+        durationMs,
+        activityDurationMs: Math.max(activityDurationMs + lastActivityDuration, 1),
         ...currentLeaveEvent,
     };
     logger.debug('trackTpaasLeave: event', leave);
@@ -226,18 +257,10 @@ export const calculateScrollPosition = (element) => Math.abs(Math.min(element.ge
  'mousedown', 'mousemove', 'keydown', 'scroll' and/or 'touchstart' browser events.
  */
 function addUpdateActivityDurationListeners() {
-    if (activityDuration.interval !== undefined) {
-        // If the interval is already set, do not set it again
+    // if there are already listeners for activity, do not add more
+    if (activityListeners.length > 0) {
         return;
     }
-    const interval = 1000;
-    const activityTimeout = 30 * 1000;
-    activityDuration.interval = window.setInterval(() => {
-        activityDuration.timeSinceLastActivity += interval;
-        if (activityDuration.timeSinceLastActivity < activityTimeout) {
-            activityDuration.value += interval;
-        }
-    }, interval);
     const activityEvents = [
         BrowserEvents.SCROLL,
         BrowserEvents.MOUSEDOWN,
@@ -246,14 +269,15 @@ function addUpdateActivityDurationListeners() {
         BrowserEvents.TOUCHSTART,
     ];
     activityListeners = addEventListeners(activityEvents, () => {
-        activityDuration = resetLastActivity(activityDuration);
+        increaseActivityDuration(Date.now());
     }, { passive: true });
 }
-function resetLastActivity(activityDuration) {
-    return {
-        ...activityDuration,
-        timeSinceLastActivity: 0,
-    };
+function calculateActivityGap(activityEndTime) {
+    return Math.min(activityEndTime - previousActivityTime, ACTIVITY_DURATION_LIMIT_MS);
+}
+function increaseActivityDuration(activityEndTime) {
+    activityDurationMs += calculateActivityGap(activityEndTime);
+    previousActivityTime = resetTime();
 }
 /*
  Add listeners to a set of browser events.

package/dist/ejs/network-browser.js

@@ -1,4 +1,4 @@
-import { isBrowser } from '@schibsted/pulse-utils';
+import { isBrowser } from './utils';
 const supportsBeacon = () => isBrowser && Boolean(window.navigator.sendBeacon);
 export default function send(url, data, sdkConfig) {
     // if there is as large number of events, only send 10 in each request

package/dist/ejs/remoteConfig/index.js

@@ -1,5 +1,5 @@
-import { isString, webApi } from '@schibsted/pulse-utils';
 import logger from 'loglevel';
+import { isString, webApi } from '../utils';
 const CIS_KEY = 'cis';
 const COLLECTOR_KEY = 'collector';
 const getRemoteConfigStorageKey = '_pulse.internal.remote.config';

package/dist/ejs/tpaas-builders/builders/catalogVersion.js

@@ -0,0 +1,6 @@
+import { CATALOG_VERSION } from '../../tpaas-schemas';
+export function builder() {
+    return {
+        catalogVersion: CATALOG_VERSION,
+    };
+}

package/{node_modules/@schibsted/tpaas-event-builder/dist/ejs → dist/ejs/tpaas-builders}/builders/device.js

@@ -1,6 +1,6 @@
-import { isBrowser } from '@schibsted/pulse-utils';
 import * as logger from 'loglevel';
 import { UAParser } from 'ua-parser-js';
+import { isBrowser } from '../../utils';
 // Cache the UAParser result to avoid re-parsing on subsequent calls
 let cachedUAParser;
 function getUAParser() {
@@ -102,16 +102,22 @@ function getOperatingSystem(uaParser) {
     if (osName.includes('windows')) {
         return 'Windows';
     }
-    if (osName.includes('macos')) {
+    if (osName.includes('macos') || osName.includes('mac os')) {
         return 'Mac';
     }
-    // some flavors of Linux might not be captured by this
+    if (osName.includes('android')) {
+        return 'Android';
+    }
+    if (osName.includes('ios')) {
+        return 'iOS';
+    }
+    // some flavours of Linux might not be captured by this
     // do we need a better detection, based on a list?
     // for example (Gentoo - https://docs.uaparser.dev/info/os/name.html)
     if (osName.includes('linux')) {
         return 'Linux';
     }
-    // the TPaaS `device` template is missing Android, iOS, iPadOS and maybe others?
+    // the TPaaS `device` template is missing iPadOS and maybe others?
     logger.log(`Unknown operating system: ${osName}. Defaulting to 'other'.`);
     // default value
     return 'Other';

package/{node_modules/@schibsted/tpaas-event-builder/dist/ejs → dist/ejs/tpaas-builders}/builders/navigationType.js

@@ -12,12 +12,11 @@ export const builder = (eventNavigationType) => {
         },
     };
 };
-// In practice they use the same values, but for future proofing we keep them separate and mapped
+// In practice, they use the same values, but for future proofing we keep them separate and mapped
 const modernNavigationMap = {
     navigate: 'Navigate',
     reload: 'Reload',
     back_forward: 'BackForward',
-    prerender: 'Prerender',
 };
 const legacyNavigationMap = {
     0: 'Navigate',
@@ -25,7 +24,7 @@ const legacyNavigationMap = {
     2: 'BackForward',
 };
 const getModernNavigationType = (entryType) => {
-    return modernNavigationMap[entryType];
+    return modernNavigationMap[entryType] || 'Navigate';
 };
 const getLegacyNavigationType = (entryType) => {
     return legacyNavigationMap[entryType] || 'Navigate';

package/dist/ejs/tpaas-builders/builders/pageContent.js

@@ -0,0 +1,3 @@
+export const builder = (content) => ({
+    page: content ? { content } : {},
+});

package/{node_modules/@schibsted/tpaas-event-builder/dist/ejs → dist/ejs/tpaas-builders}/builders/pageInfo.js

@@ -1,4 +1,4 @@
-import { isBrowser } from '@schibsted/pulse-utils';
+import { isBrowser } from '../../utils';
 export const builder = (currentPage) => {
     // if something happens and there was no View Page type of event sent before, we need a fallback
     if (!currentPage) {

package/dist/ejs/tpaas-builders/builders/pageSports.js

@@ -0,0 +1,3 @@
+export const builder = (sports) => ({
+    page: sports ?? {},
+});

package/dist/ejs/tpaas-builders/builders/provider.js

@@ -0,0 +1,16 @@
+const generateProviderSDRN = (providerId) => `sdrn:schibsted:client:${providerId}`;
+export function builder(providerId, providerStage, providerProduct, providerVersion, component, componentVersion, providerName, providerGroup) {
+    return {
+        provider: {
+            providerId,
+            providerSdrn: generateProviderSDRN(providerId),
+            ...(component !== undefined && { component }),
+            ...(componentVersion !== undefined && { componentVersion }),
+            ...(providerGroup !== undefined && { group: providerGroup }),
+            ...(providerName !== undefined && { name: providerName }),
+            stage: providerStage,
+            product: providerProduct,
+            version: providerVersion,
+        },
+    };
+}

package/dist/ejs/tpaas-builders/builders/referrer.js

@@ -0,0 +1,13 @@
+const hasReferrerData = (referrer) => Boolean(referrer.pageId || referrer.url || referrer.pageType);
+export const builder = (referrer) => {
+    if (!hasReferrerData(referrer)) {
+        return {
+            page: {},
+        };
+    }
+    return {
+        page: {
+            referrer,
+        },
+    };
+};

package/{node_modules/@schibsted/tpaas-event-builder/dist/ejs → dist/ejs/tpaas-builders}/builders/session.js

@@ -1,7 +1,8 @@
-import { cookieConfig, getRootDomain, isBrowser, readCookie, webApi, writeCookie } from '@schibsted/pulse-utils';
 import { v4 as uuid } from 'uuid';
+import { cookieConfig, getRootDomain, getXDomainId, readCookie, SESSION_SDRN_PREFIX, webApi, writeCookie, } from '../../utils';
 const { USE_LOCALSTORAGE } = cookieConfig;
 const SESSION_STORAGE_KEY = '_pulsesession';
+const generateSessionSDRN = (sessionId) => `${SESSION_SDRN_PREFIX}${sessionId}`;
 // 1. there are pros and cons to outputting { session: ISession } instead of just ISession
 // this allows us to always have the session builde populate the same property (in this case '.session')
 // if in the future we want the session builder to populate other properties, we should just output ISession and move the mapping logic in index.ts, as part of buildersByEventType
@@ -21,15 +22,6 @@ export const builder = (createdAt) => {
         },
     };
 };
-// TODO: do we need to save this in the session, as part of the localStorage?
-// or should we just read it from the URL params every time?
-const getXDomainId = () => {
-    if (!isBrowser) {
-        return;
-    }
-    const urlParams = new URLSearchParams(window?.location?.search ?? '');
-    return urlParams.get('x_domain_id') || undefined;
-};
 // Return parsed json from cookie (or localStorage if enabled), or undefined.
 // exported for testing purposes.
 export const readAndParse = (storageKey) => {
@@ -60,7 +52,14 @@ export const readSession = () => {
             lastEventTime &&
             !Number.isNaN(startTime.getTime()) &&
             !Number.isNaN(lastEventTime.getTime())) {
-            return { sessionId, startTime: startTime.toISOString(), lastEventTime, isFirstEvent: false };
+            return {
+                // to ensure backwards compatibility between the new TPaaS sessionId format and old sessions
+                // we need to remove the SDRN prefix from old sessionIds before using it
+                sessionId: sessionId.replace(SESSION_SDRN_PREFIX, ''),
+                startTime: startTime.toISOString(),
+                lastEventTime,
+                isFirstEvent: false,
+            };
         }
     }
     return undefined;
@@ -68,8 +67,15 @@ export const readSession = () => {
 // Write session data to localStorage
 const writeSession = (session) => {
     const { sessionId, startTime, lastEventTime } = session;
+    // SDK v8 (supporting TPaaS events) needs to be compatible with legacy events AND older SDK versions
+    // as a result, we can't store just the sessionId, we need the full SDRN in there
+    const sessionSdrn = generateSessionSDRN(sessionId);
     try {
-        const sessionToStore = [sessionId, new Date(startTime).getTime(), lastEventTime.getTime()];
+        const sessionToStore = [
+            sessionSdrn,
+            new Date(startTime).getTime(),
+            lastEventTime.getTime(),
+        ];
         const halfHourInDays = 1.0 / (24 * 2);
         writeCookie(SESSION_STORAGE_KEY, JSON.stringify(sessionToStore), getRootDomain(), halfHourInDays);
         // Delete old localStorage-based session if needed
@@ -99,9 +105,6 @@ const updateSession = (eventCreationDate, session) => {
     }
     return {
         ...session,
-        // to ensure backwards compatibility between the new sessionId format and old sessions
-        // we need to remove the SDRN prefix from old sessionIds
-        sessionId: session.sessionId.replace('sdrn:schibsted:session:', ''),
         isFirstEvent: false,
         lastEventTime: eventCreationDate,
     };

package/dist/ejs/tpaas-builders/builders/trackerBuilder.js

@@ -0,0 +1,10 @@
+export const builder = ({ isHybrid, routingStage, version, }) => {
+    return {
+        tracker: {
+            isHybrid,
+            routingStage,
+            trackerType: 'JS',
+            version,
+        },
+    };
+};

package/{node_modules/@schibsted/tpaas-event-builder/dist/ejs → dist/ejs/tpaas-builders}/builders/user.js

@@ -4,7 +4,7 @@ export const builder = (user) => {
         return {};
     }
     const { hasAnySubscription, region, id, realm } = user;
-    if (!id || !id.toString().trim()) {
+    if (!id?.toString().trim()) {
         // the user is anonymous (logged out)
         return {};
     }

package/{node_modules/@schibsted/tpaas-event-builder/dist/ejs → dist/ejs/tpaas-builders}/builders/utm.js

@@ -1,5 +1,5 @@
-import { isBrowser } from '@schibsted/pulse-utils';
-import { UTM_MEDIUM_VALUES } from '@schibsted/tpaas-schemas';
+import { UTM_MEDIUM_VALUES } from '../../tpaas-schemas';
+import { isBrowser } from '../../utils';
 export const builder = () => {
     if (!isBrowser) {
         return {