@schibsted/pulse-sdk 8.0.0-rc.5 → 8.0.0-rc.6

package/dist/ejs/Tracker.js

@@ -428,7 +428,6 @@ export default class Tracker {
         };
     }
     /**
-     *
      * @private
      * @category TPaaS Tracking
      */
@@ -748,14 +747,13 @@ export default class Tracker {
         const event = buildViewHealthPageEvent(input, dependencies);
         const result = this.sendTpaasEvent(event);
         if (shouldEnableLeaveTracking(options.leaveTracking)) {
-            const { objectElement, pageElement, heightBuilder, objectResizable } = options.leaveTracking;
-            // HealthView Page is a bit special, in the sense that in doesn't have a dedicated Leave event.
-            // Instead, we need to reuse the generic Leave Page event, but adapt the input accordingly.
-            // This means omitting some fields from HealthView Page that are not part of Leave Page schema.
-            const { experiments, metrics, object, ...restInput } = input;
-            const { category, custom, intent, name, tags, ...restObject } = input.object;
-            const leavePageCallback = (leave) => {
-                this.trackLeavePage({
+            const leavePageCallback = async (leave) => {
+                // HealthView Page is a bit special, in the sense that in doesn't have a dedicated Leave event.
+                // Instead, we need to reuse the generic Leave Page event, but adapt the input accordingly.
+                // This means omitting some fields from HealthView Page that are not part of Leave Page schema.
+                const { experiments, metrics, object, origin, ...restInput } = input;
+                const { category, custom, intent, name, tags, ...restObject } = input.object;
+                await this.trackLeavePage({
                     leave,
                     ...restInput,
                     object: {
@@ -765,10 +763,7 @@ export default class Tracker {
                 });
             };
             addTpaasLeaveTracking({
-                objectElement,
-                pageElement,
-                objectResizable,
-                heightBuilder,
+                ...options.leaveTracking,
                 schema: LeavePage.object.objectType,
                 trackMethod: leavePageCallback,
             });
@@ -792,18 +787,15 @@ export default class Tracker {
         const event = buildViewPageEvent(input, dependencies);
         const result = this.sendTpaasEvent(event);
         if (shouldEnableLeaveTracking(options.leaveTracking)) {
-            const { objectElement, pageElement, heightBuilder, objectResizable } = options.leaveTracking;
-            const leavePageCallback = (leave) => {
-                this.trackLeavePage({
+            const leavePageCallback = async (leave) => {
+                const { metrics, ...rest } = input; // metrics are not part of LeavePage schema, so we need to omit them
+                await this.trackLeavePage({
                     leave,
-                    ...input,
+                    ...rest,
                 });
             };
             addTpaasLeaveTracking({
-                objectElement,
-                pageElement,
-                objectResizable,
-                heightBuilder,
+                ...options.leaveTracking,
                 schema: LeavePage.object.objectType,
                 trackMethod: leavePageCallback,
             });
@@ -822,18 +814,14 @@ export default class Tracker {
         const event = buildViewSportsPageEvent(input, dependencies);
         const result = this.sendTpaasEvent(event);
         if (shouldEnableLeaveTracking(options.leaveTracking)) {
-            const { objectElement, pageElement, heightBuilder, objectResizable } = options.leaveTracking;
-            const leaveSportsPageCallback = (leave) => {
-                this.trackLeaveSportsPage({
+            const leaveSportsPageCallback = async (leave) => {
+                await this.trackLeaveSportsPage({
                     leave,
                     ...input,
                 });
             };
             addTpaasLeaveTracking({
-                objectElement,
-                pageElement,
-                objectResizable,
-                heightBuilder,
+                ...options.leaveTracking,
                 schema: LeaveSportsPage.object.objectType,
                 trackMethod: leaveSportsPageCallback,
             });
@@ -873,18 +861,17 @@ export default class Tracker {
         const event = buildViewArticleEvent(input, dependencies);
         const result = this.sendTpaasEvent(event);
         if (shouldEnableLeaveTracking(options.leaveTracking)) {
-            const { objectElement, pageElement, heightBuilder, objectResizable } = options.leaveTracking;
-            const leaveArticleCallback = (leave) => {
-                this.trackLeaveArticle({
+            const leaveArticleCallback = async (leave) => {
+                // omit these properties from LeaveArticle because they're not part of the LeaveArticle schema
+                const { authors, hotness, lifetime, sponsor, wordCount, ...rest } = input.object;
+                await this.trackLeaveArticle({
                     leave,
                     ...input,
+                    object: rest,
                 });
             };
             addTpaasLeaveTracking({
-                objectElement,
-                pageElement,
-                heightBuilder,
-                objectResizable,
+                ...options.leaveTracking,
                 schema: LeaveArticle.object.objectType,
                 trackMethod: leaveArticleCallback,
             });
@@ -938,15 +925,15 @@ export default class Tracker {
         const event = buildViewAudioPageEvent(input, dependencies);
         const result = this.sendTpaasEvent(event);
         if (shouldEnableLeaveTracking(options.leaveTracking)) {
-            const { objectElement, pageElement, heightBuilder, objectResizable, leaveAudioBuilder } = options.leaveTracking;
-            const leaveAudioPageCallback = (leave) => {
+            const { leaveAudioBuilder, ...restLeaveTrackingOptions } = options.leaveTracking;
+            const leaveAudioPageCallback = async (leave) => {
                 const leaveAudioInput = leaveAudioBuilder?.() ?? {
                     audioCompleted: 0,
                     audioStarted: 0,
                     maxPlaylistPosition: 0,
                     playlistPositionPercentage: 0,
                 };
-                this.trackLeaveAudioPage({
+                await this.trackLeaveAudioPage({
                     leave,
                     leaveAudio: {
                         ...leaveAudioInput,
@@ -957,10 +944,7 @@ export default class Tracker {
                 });
             };
             addTpaasLeaveTracking({
-                objectElement,
-                pageElement,
-                heightBuilder,
-                objectResizable,
+                ...restLeaveTrackingOptions,
                 schema: LeaveAudioPage.object.objectType,
                 trackMethod: leaveAudioPageCallback,
             });
@@ -979,18 +963,14 @@ export default class Tracker {
         const event = buildViewErrorEvent(input, dependencies);
         const result = this.sendTpaasEvent(event);
         if (shouldEnableLeaveTracking(options.leaveTracking)) {
-            const { objectElement, pageElement, heightBuilder, objectResizable } = options.leaveTracking;
-            const leaveErrorCallback = (leave) => {
-                this.trackLeaveError({
+            const leaveErrorCallback = async (leave) => {
+                await this.trackLeaveError({
                     leave,
                     ...input,
                 });
             };
             addTpaasLeaveTracking({
-                objectElement,
-                pageElement,
-                heightBuilder,
-                objectResizable,
+                ...options.leaveTracking,
                 schema: LeaveError.object.objectType,
                 trackMethod: leaveErrorCallback,
             });
@@ -1054,18 +1034,15 @@ export default class Tracker {
         const event = buildViewFrontpageEvent(input, dependencies);
         const result = this.sendTpaasEvent(event);
         if (shouldEnableLeaveTracking(options.leaveTracking)) {
-            const { objectElement, pageElement, heightBuilder, objectResizable } = options.leaveTracking;
-            const leaveFrontpageCallback = (leave) => {
-                this.trackLeaveFrontpage({
+            const leaveFrontpageCallback = async (leave) => {
+                const { metrics, ...rest } = input; // metrics are not part of LeaveFrontpage schema, so we need to omit them
+                await this.trackLeaveFrontpage({
                     leave,
-                    ...input,
+                    ...rest,
                 });
             };
             addTpaasLeaveTracking({
-                objectElement,
-                pageElement,
-                objectResizable,
-                heightBuilder,
+                ...options.leaveTracking,
                 schema: LeaveFrontpage.object.objectType,
                 trackMethod: leaveFrontpageCallback,
             });
@@ -1084,18 +1061,14 @@ export default class Tracker {
         const event = buildViewLandingpageEvent(input, dependencies);
         const result = this.sendTpaasEvent(event);
         if (shouldEnableLeaveTracking(options.leaveTracking)) {
-            const { objectElement, pageElement, heightBuilder, objectResizable } = options.leaveTracking;
-            const leaveLandingpageCallback = (leave) => {
-                this.trackLeaveLandingpage({
+            const leaveLandingpageCallback = async (leave) => {
+                await this.trackLeaveLandingpage({
                     leave,
                     ...input,
                 });
             };
             addTpaasLeaveTracking({
-                objectElement,
-                pageElement,
-                heightBuilder,
-                objectResizable,
+                ...options.leaveTracking,
                 schema: LeaveLandingpage.object.objectType,
                 trackMethod: leaveLandingpageCallback,
             });
@@ -1114,18 +1087,14 @@ export default class Tracker {
         const event = buildViewListingEvent(input, dependencies);
         const result = this.sendTpaasEvent(event);
         if (shouldEnableLeaveTracking(options.leaveTracking)) {
-            const { objectElement, pageElement, heightBuilder, objectResizable } = options.leaveTracking;
-            const leaveListingCallback = (leave) => {
-                this.trackLeaveListing({
+            const leaveListingCallback = async (leave) => {
+                await this.trackLeaveListing({
                     leave,
                     ...input,
                 });
             };
             addTpaasLeaveTracking({
-                objectElement,
-                pageElement,
-                heightBuilder,
-                objectResizable,
+                ...options.leaveTracking,
                 schema: LeaveListing.object.objectType,
                 trackMethod: leaveListingCallback,
             });
@@ -1144,18 +1113,17 @@ export default class Tracker {
         const event = buildViewLockedArticleEvent(input, dependencies);
         const result = this.sendTpaasEvent(event);
         if (shouldEnableLeaveTracking(options.leaveTracking)) {
-            const { objectElement, pageElement, heightBuilder, objectResizable } = options.leaveTracking;
-            const leaveLockedArticleCallback = (leave) => {
-                this.trackLeaveLockedArticle({
+            const leaveLockedArticleCallback = async (leave) => {
+                // omit these properties because they're not part of the LeaveLockedArticle schema
+                const { authors, hotness, lifetime, sponsor, wordCount, ...rest } = input.object;
+                await this.trackLeaveLockedArticle({
                     leave,
                     ...input,
+                    object: rest,
                 });
             };
             addTpaasLeaveTracking({
-                objectElement,
-                pageElement,
-                objectResizable,
-                heightBuilder,
+                ...options.leaveTracking,
                 schema: LeaveLockedArticle.object.objectType,
                 trackMethod: leaveLockedArticleCallback,
             });
@@ -1174,18 +1142,14 @@ export default class Tracker {
         const event = buildViewLockedAudioPageEvent(input, dependencies);
         const result = this.sendTpaasEvent(event);
         if (shouldEnableLeaveTracking(options.leaveTracking)) {
-            const { objectElement, pageElement, heightBuilder, objectResizable } = options.leaveTracking;
-            const leaveLockedAudioPageCallback = (leave) => {
-                this.trackLeaveLockedAudioPage({
+            const leaveLockedAudioPageCallback = async (leave) => {
+                await this.trackLeaveLockedAudioPage({
                     leave,
                     ...input,
                 });
             };
             addTpaasLeaveTracking({
-                objectElement,
-                pageElement,
-                heightBuilder,
-                objectResizable,
+                ...options.leaveTracking,
                 schema: LeaveLockedAudioPage.object.objectType,
                 trackMethod: leaveLockedAudioPageCallback,
             });
@@ -1204,18 +1168,14 @@ export default class Tracker {
         const event = buildViewLockedVideoPageEvent(input, dependencies);
         const result = this.sendTpaasEvent(event);
         if (shouldEnableLeaveTracking(options.leaveTracking)) {
-            const { objectElement, pageElement, heightBuilder, objectResizable } = options.leaveTracking;
-            const leaveLockedVideoPageCallback = (leave) => {
-                this.trackLeaveLockedVideoPage({
+            const leaveLockedVideoPageCallback = async (leave) => {
+                await this.trackLeaveLockedVideoPage({
                     leave,
                     ...input,
                 });
             };
             addTpaasLeaveTracking({
-                objectElement,
-                pageElement,
-                heightBuilder,
-                objectResizable,
+                ...options.leaveTracking,
                 schema: LeaveLockedVideoPage.object.objectType,
                 trackMethod: leaveLockedVideoPageCallback,
             });
@@ -1271,10 +1231,10 @@ export default class Tracker {
         const event = buildViewVideoPageEvent(input, dependencies);
         const result = this.sendTpaasEvent(event);
         if (shouldEnableLeaveTracking(options.leaveTracking)) {
-            const { objectElement, pageElement, heightBuilder, objectResizable, leaveStoriesBuilder } = options.leaveTracking;
-            const leaveVideoCallback = (leave) => {
+            const { leaveStoriesBuilder, ...restLeaveTrackingOptions } = options.leaveTracking;
+            const leaveVideoCallback = async (leave) => {
                 const leaveStoriesInput = leaveStoriesBuilder?.();
-                this.trackLeaveVideoPage({
+                await this.trackLeaveVideoPage({
                     leave,
                     leaveStories: leaveStoriesInput && {
                         ...leaveStoriesInput,
@@ -1285,10 +1245,7 @@ export default class Tracker {
                 });
             };
             addTpaasLeaveTracking({
-                objectElement,
-                pageElement,
-                heightBuilder,
-                objectResizable,
+                ...restLeaveTrackingOptions,
                 schema: LeaveVideoPage.object.objectType,
                 trackMethod: leaveVideoCallback,
             });
@@ -1307,18 +1264,16 @@ export default class Tracker {
         const event = buildViewWeatherEvent(input, dependencies);
         const result = this.sendTpaasEvent(event);
         if (shouldEnableLeaveTracking(options.leaveTracking)) {
-            const { objectElement, pageElement, heightBuilder, objectResizable } = options.leaveTracking;
-            const leaveWeatherCallback = (leave) => {
-                this.trackLeaveWeather({
+            const leaveWeatherCallback = async (leave) => {
+                // omit object and page from input because they're not part of the LeaveWeather schema
+                const { object, page, ...rest } = input;
+                await this.trackLeaveWeather({
                     leave,
-                    ...input,
+                    ...rest,
                 });
             };
             addTpaasLeaveTracking({
-                objectElement,
-                pageElement,
-                heightBuilder,
-                objectResizable,
+                ...options.leaveTracking,
                 schema: LeaveWeather.object.objectType,
                 trackMethod: leaveWeatherCallback,
             });
@@ -2157,8 +2112,8 @@ export default class Tracker {
      * with the added guarantee that a second Leave event will not be triggered if one already has been sent.
      * @category TPaaS Leave Tracking
      */
-    trackTpaasActiveLeave() {
-        trackTpaasActiveLeave();
+    async trackTpaasActiveLeave() {
+        await trackTpaasActiveLeave();
     }
     /**
      * Check if leave tracking is enabled (if an event will be sent when the user leaves the page)

package/dist/ejs/leaveTrackingTpaas/constants.js

@@ -1,8 +1,3 @@
-export const DEFAULT_ACTIVITY_DURATION = () => ({
-    value: 0,
-    interval: undefined,
-    timeSinceLastActivity: 0,
-});
 export const DEFAULT_PAGE_LEAVE_EVENT = () => ({
     objectViewPercentage: 0,
     maxObjectViewPercentage: 0,
@@ -11,3 +6,4 @@ export const DEFAULT_PAGE_LEAVE_EVENT = () => ({
     pageScrollPosition: 0,
     maxPageScrollPosition: 0,
 });
+export const ACTIVITY_DURATION_LIMIT_MS = 30000;

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 { ACTIVITY_DURATION_LIMIT_MS, DEFAULT_PAGE_LEAVE_EVENT } from './constants';
 import { BrowserEvents } from './types';
 let currentLeaveSchema;
 let currentTrackMethod;
@@ -9,19 +9,42 @@ let updateViewedContentListeners = [];
 let activityListeners = [];
 let resizeObserver = null;
 let throttledUpdateFn = throttle(() => undefined, 0);
-let startTime = 0;
-let activityDuration = DEFAULT_ACTIVITY_DURATION();
+let durationStartTime = 0;
+let activityStartTime = 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);
+        activityStartTime = resetTime();
+        durationStartTime = resetTime();
         currentLeaveSchema = schema;
         currentTrackMethod = trackMethod;
         logger.debug('addLeaveTracking:after:state', currentLeaveEvent);
@@ -113,12 +136,8 @@ function removeUpdateEventListeners() {
  */
 const resetEventDefaults = () => {
     currentLeaveEvent = DEFAULT_PAGE_LEAVE_EVENT();
-    startTime = resetTime();
-    activityDuration = resetActivityDuration();
-};
-const resetActivityDuration = () => {
-    clearInterval(activityDuration.interval);
-    return DEFAULT_ACTIVITY_DURATION();
+    durationStartTime = resetTime();
+    activityStartTime = resetTime();
 };
 export const resetTpaasViewedContent = () => {
     currentLeaveEvent = DEFAULT_PAGE_LEAVE_EVENT();
@@ -126,34 +145,41 @@ 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
+    const durationMs = Math.max(endTime - durationStartTime, 1);
+    const activityDurationMs = Math.max(Math.min(endTime - activityStartTime, ACTIVITY_DURATION_LIMIT_MS), 1);
     const leave = {
-        durationMs: duration,
-        activityDurationMs: activityDuration.value,
+        durationMs,
+        activityDurationMs,
         ...currentLeaveEvent,
     };
     logger.debug('trackTpaasLeave: event', leave);
@@ -226,18 +252,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,15 +264,9 @@ function addUpdateActivityDurationListeners() {
         BrowserEvents.TOUCHSTART,
     ];
     activityListeners = addEventListeners(activityEvents, () => {
-        activityDuration = resetLastActivity(activityDuration);
+        activityStartTime = resetTime();
     }, { passive: true });
 }
-function resetLastActivity(activityDuration) {
-    return {
-        ...activityDuration,
-        timeSinceLastActivity: 0,
-    };
-}
 /*
  Add listeners to a set of browser events.
  */

package/dist/ejs/tracker-proxy/consts.js

@@ -35,6 +35,7 @@ export const TPAAS_ALLOWED_METHODS = [
     'trackLeaveLockedAudioPage',
     'trackLeaveLockedVideoPage',
     'trackLeavePage',
+    'trackLeaveSportsPage',
     'trackLeaveVideoPage',
     'trackLeaveWeather',
     'trackViewArticle',
@@ -48,6 +49,7 @@ export const TPAAS_ALLOWED_METHODS = [
     'trackViewLockedAudioPage',
     'trackViewLockedVideoPage',
     'trackViewPage',
+    'trackViewSportsPage',
     'trackViewTitle',
     'trackViewVideoPage',
     'trackViewWeather',

package/dist/ejs/version.js

@@ -1,2 +1,2 @@
 // This file is auto-generated by bin/generate-version.js. Do not edit manually.
-export const SDK_VERSION = '8.0.0-rc.5';
+export const SDK_VERSION = '8.0.0-rc.6';