feat: integrate GenStudio tracking (#4474)

Author: cwjwisse

libs/scripts/delayed.js

@@ -77,6 +77,19 @@ export const loadAriaAutomation = async () => {
   addAriaLabels();
 };
 
+export const addRUMCampaignTrackingParameters = ({ sampleRUM }) => {
+  const usp = new URLSearchParams(window.location.search);
+  [
+    { key: 'sdid', utmKey: 'utm_campaign' },
+    { key: 'mv', utmKey: 'utm_source' },
+    { key: 'mv2', utmKey: 'utm_medium' },
+  ].forEach(({ key, utmKey }) => {
+    const val = usp.get(key);
+    if (!val || (key === 'sdid' && val.length > 8)) return;
+    sampleRUM('utm', { source: utmKey, target: val });
+  });
+};
+
 /**
  * Executes everything that happens a lot later, without impacting the user experience.
  */
@@ -100,7 +113,10 @@ const loadDelayed = ([
     } else {
       resolve(null);
     }
-    import('../utils/samplerum.js').then(({ sampleRUM }) => sampleRUM());
+    import('../utils/samplerum.js').then(({ sampleRUM }) => {
+      sampleRUM();
+      addRUMCampaignTrackingParameters({ sampleRUM });
+    });
   }, DELAY);
 });
 

test/scripts/delayed.test.js

@@ -1,6 +1,6 @@
 import sinon from 'sinon';
 import { expect } from '@esm-bundle/chai';
-import loadDelayed, { loadPrivacy, loadJarvisChat, loadGoogleLogin } from '../../libs/scripts/delayed.js';
+import loadDelayed, { loadPrivacy, loadJarvisChat, loadGoogleLogin, addRUMCampaignTrackingParameters } from '../../libs/scripts/delayed.js';
 import { getMetadata, getConfig, setConfig, loadIms } from '../../libs/utils/utils.js';
 
 describe('Delayed', () => {
@@ -61,3 +61,46 @@ describe('Delayed', () => {
     clock.restore();
   });
 });
+
+describe('addRUMCampaignTrackingParameters', () => {
+  const originalURLSearchParams = window.URLSearchParams;
+  const setURLSearchParamsStub = (params) => {
+    window.URLSearchParams = sinon.stub().returns({ get: (key) => params[key] });
+  };
+
+  afterEach(() => {
+    window.URLSearchParams = originalURLSearchParams;
+  });
+
+  it('should call sampleRUM for valid sdid, mv, and mv2', () => {
+    setURLSearchParamsStub({
+      sdid: '12345678',
+      mv: 'foo',
+      mv2: 'bar',
+    });
+    const sampleRUM = sinon.stub();
+    addRUMCampaignTrackingParameters({ sampleRUM });
+    expect(sampleRUM.calledThrice).to.be.true;
+    expect(sampleRUM.getCall(0).args).to.deep.equal(['utm', { source: 'utm_campaign', target: '12345678' }]);
+    expect(sampleRUM.getCall(1).args).to.deep.equal(['utm', { source: 'utm_source', target: 'foo' }]);
+    expect(sampleRUM.getCall(2).args).to.deep.equal(['utm', { source: 'utm_medium', target: 'bar' }]);
+  });
+
+  it('should NOT call sampleRUM for sdid if too long', () => {
+    setURLSearchParamsStub({
+      sdid: '123456789012345',
+      mv: 'foo',
+    });
+    const sampleRUM = sinon.stub();
+    addRUMCampaignTrackingParameters({ sampleRUM });
+    expect(sampleRUM.calledOnce).to.be.true;
+    expect(sampleRUM.getCall(0).args).to.deep.equal(['utm', { source: 'utm_source', target: 'foo' }]);
+  });
+
+  it('should skip missing params', () => {
+    setURLSearchParamsStub({ irrelevant: 'x' });
+    const sampleRUM = sinon.stub();
+    addRUMCampaignTrackingParameters({ sampleRUM });
+    expect(sampleRUM.notCalled).to.be.true;
+  });
+});