feat: session marker (#12634)

Co-authored-by: rufiange <sebastien@rufiange.com>

Author: sebastienrufiange

modules/contxtfulRtdProvider.js

@@ -15,6 +15,7 @@ import {
   isEmpty,
   buildUrl,
   isArray,
+  generateUUID,
 } from '../src/utils.js';
 import { loadExternalScript } from '../src/adloader.js';
 import { getStorageManager } from '../src/storageManager.js';
@@ -26,13 +27,17 @@ const MODULE = `${MODULE_NAME}RtdProvider`;
 const CONTXTFUL_HOSTNAME_DEFAULT = 'api.receptivity.io';
 const CONTXTFUL_DEFER_DEFAULT = 0;
 
+let _sm;
+function sm() {
+  return _sm ??= generateUUID();
+}
+
 const storageManager = getStorageManager({
   moduleType: MODULE_TYPE_RTD,
   moduleName: MODULE_NAME,
 });
 
 let rxApi = null;
-let isFirstBidRequestCall = true;
 
 /**
  * Return current receptivity value for the requester.
@@ -150,7 +155,7 @@ function initCustomer(config) {
 
   addConnectorEventListener(customer, config);
 
-  const loadScript = () => loadExternalScript(CONNECTOR_URL, MODULE_TYPE_RTD, MODULE_NAME);
+  const loadScript = () => loadExternalScript(CONNECTOR_URL, MODULE_TYPE_RTD, MODULE_NAME, undefined, undefined, { 'data-sm': sm() });
   // Optionally defer the loading of the script
   if (Number.isFinite(defer) && defer > 0) {
     setTimeout(loadScript, defer);
@@ -228,9 +233,6 @@ function getTargetingData(adUnits, config, _userConsent) {
  */
 function getBidRequestData(reqBidsConfigObj, onDone, config, userConsent) {
   function onReturn() {
-    if (isFirstBidRequestCall) {
-      isFirstBidRequestCall = false;
-    }
     onDone();
   }
 
@@ -245,16 +247,10 @@ function getBidRequestData(reqBidsConfigObj, onDone, config, userConsent) {
   let fromStorage = prepareBatch(bidders, (bidder) => loadSessionReceptivity(`${config?.params?.customer}_${bidder}`));
 
   let sources = [fromStorage, fromApi];
-  if (isFirstBidRequestCall) {
-    sources.reverse();
-  }
 
   let rxBatch = Object.assign(...sources);
 
-  let singlePointEvents;
-  if (isEmpty(rxBatch)) {
-    singlePointEvents = btoa(JSON.stringify({ ui: getUiEvents() }));
-  }
+  let singlePointEvents = btoa(JSON.stringify({ ui: getUiEvents() }));
 
   bidders
     .forEach(bidderCode => {
@@ -266,6 +262,7 @@ function getBidRequestData(reqBidsConfigObj, onDone, config, userConsent) {
               ext: {
                 rx: rxBatch[bidderCode],
                 events: singlePointEvents,
+                sm: sm(),
                 params: {
                   ev: config.params?.version,
                   ci: config.params?.customer,

test/spec/modules/contxtfulRtdProvider_spec.js

@@ -4,12 +4,15 @@ import { loadExternalScriptStub } from 'test/mocks/adloaderStub.js';
 import { getStorageManager } from '../../../src/storageManager.js';
 import { MODULE_TYPE_UID } from '../../../src/activities/modules.js';
 import * as events from '../../../src/events';
+import * as utils from 'src/utils.js';
 import Sinon from 'sinon';
+import { deepClone } from '../../../src/utils.js';
 
 const MODULE_NAME = 'contxtful';
 
 const VERSION = 'v1';
 const CUSTOMER = 'CUSTOMER';
+const SM = 'SM';
 const CONTXTFUL_CONNECTOR_ENDPOINT = `https://api.receptivity.io/${VERSION}/prebid/${CUSTOMER}/connector/rxConnector.js`;
 
 const RX_FROM_SESSION_STORAGE = { ReceptivityState: 'Receptive', test_info: 'rx_from_session_storage' };
@@ -62,6 +65,8 @@ describe('contxtfulRtdProvider', function () {
 
     eventsEmitSpy = sandbox.spy(events, ['emit']);
 
+    sandbox.stub(utils, 'generateUUID').returns(SM);
+
     let tagId = CUSTOMER;
     sessionStorage.clear();
   });
@@ -534,6 +539,7 @@ describe('contxtfulRtdProvider', function () {
         name: 'contxtful',
         ext: {
           rx: RX_FROM_API,
+          sm: SM,
           params: {
             ev: config.params?.version,
             ci: config.params?.customer,
@@ -549,11 +555,40 @@ describe('contxtfulRtdProvider', function () {
 
         expect(data.name).to.deep.equal(expectedData.name);
         expect(data.ext.rx).to.deep.equal(expectedData.ext.rx);
+        expect(data.ext.sm).to.deep.equal(expectedData.ext.sm);
         expect(data.ext.params).to.deep.equal(expectedData.ext.params);
         done();
       }, TIMEOUT);
     });
 
+    it('does not change the sm', function (done) {
+      let config = buildInitConfig(VERSION, CUSTOMER);
+      contxtfulSubmodule.init(config);
+      window.dispatchEvent(RX_CONNECTOR_IS_READY_EVENT);
+
+      let firstReqBidsConfigObj = {
+        ortb2Fragments: {
+          global: {},
+          bidder: {},
+        },
+      };
+
+      let secondReqBidsConfigObj = deepClone(firstReqBidsConfigObj);
+
+      setTimeout(() => {
+        const onDoneSpy = sinon.spy();
+        contxtfulSubmodule.getBidRequestData(firstReqBidsConfigObj, onDoneSpy, config);
+        contxtfulSubmodule.getBidRequestData(secondReqBidsConfigObj, onDoneSpy, config);
+
+        let firstData = firstReqBidsConfigObj.ortb2Fragments.bidder[config.params.bidders[0]].user.data[0];
+        let secondData = secondReqBidsConfigObj.ortb2Fragments.bidder[config.params.bidders[0]].user.data[0];
+
+        expect(firstData.ext.sm).to.equal(secondData.ext.sm);
+
+        done();
+      }, TIMEOUT);
+    });
+
     describe('before rxApi is loaded', function () {
       const moveEventTheories = [
         [
@@ -628,7 +663,7 @@ describe('contxtfulRtdProvider', function () {
   });
 
   describe('after rxApi is loaded', function () {
-    it('does not add event', function (done) {
+    it('should add event', function (done) {
       let config = buildInitConfig(VERSION, CUSTOMER);
       contxtfulSubmodule.init(config);
       window.dispatchEvent(RX_CONNECTOR_IS_READY_EVENT);
@@ -648,7 +683,7 @@ describe('contxtfulRtdProvider', function () {
 
         let events = ext.events;
 
-        expect(events).to.be.undefined;
+        expect(events).to.be.not.undefined;
         done();
       }, TIMEOUT);
     });