fix: Update Rokt Click ID (#1008)

Author: alexs-mparticle

src/integrationCapture.ts

@@ -105,11 +105,17 @@ const integrationMapping: IntegrationIdMapping = {
 
     // Rokt
     // https://docs.rokt.com/developers/integration-guides/web/advanced/rokt-id-tag/
+    // https://go.mparticle.com/work/SQDSDKS-7167
     rtid: {
         mappedKey: 'passbackconversiontrackingid',
         output: IntegrationOutputs.INTEGRATION_ATTRIBUTES,
         moduleId: 1277,
     },
+    rclid: {
+        mappedKey: 'passbackconversiontrackingid',
+        output: IntegrationOutputs.INTEGRATION_ATTRIBUTES,
+        moduleId: 1277,
+    },
     RoktTransactionId: {
         mappedKey: 'passbackconversiontrackingid',
         output: IntegrationOutputs.INTEGRATION_ATTRIBUTES,
@@ -158,27 +164,41 @@ export default class IntegrationCapture {
         const cookies = this.captureCookies() || {};
         const localStorage = this.captureLocalStorage() || {};
 
+        // Facebook Rules
         // Exclude _fbc if fbclid is present
         // https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc#retrieve-from-fbclid-url-query-parameter
         if (queryParams['fbclid'] && cookies['_fbc']) {
             delete cookies['_fbc'];
         }
 
-        // If both rtid and RoktTransactionId are present, prioritize rtid
+        // ROKT Rules
+        // If both rtid or rclid and RoktTransactionId are present, prioritize rtid/rclid
         // If RoktTransactionId is present in both cookies and localStorage,
         // prioritize localStorage
-        if (queryParams['rtid'] && localStorage['RoktTransactionId'] && cookies['RoktTransactionId']) {
-            delete localStorage['RoktTransactionId'];
-            delete cookies['RoktTransactionId'];
-        } else if (queryParams['rtid'] && localStorage['RoktTransactionId']) {
-            delete localStorage['RoktTransactionId'];
-        } else if (queryParams['rtid'] && cookies['RoktTransactionId']) {
-            delete cookies['RoktTransactionId'];
-        } else if (localStorage['RoktTransactionId'] && cookies['RoktTransactionId']) {
+        const hasQueryParamId = queryParams['rtid'] || queryParams['rclid'];
+        const hasLocalStorageId = localStorage['RoktTransactionId'];
+        const hasCookieId = cookies['RoktTransactionId'];
+
+        if (hasQueryParamId) {
+            // Query param takes precedence, remove both localStorage and cookie if present
+            if (hasLocalStorageId) {
+                delete localStorage['RoktTransactionId'];
+            }
+            if (hasCookieId) {
+                delete cookies['RoktTransactionId'];
+            }
+        } else if (hasLocalStorageId && hasCookieId) {
+            // No query param, but both localStorage and cookie exist
+            // localStorage takes precedence over cookie
             delete cookies['RoktTransactionId'];
         }
 
-        this.clickIds = { ...this.clickIds, ...queryParams, ...localStorage, ...cookies };
+        this.clickIds = {
+            ...this.clickIds,
+            ...queryParams,
+            ...localStorage,
+            ...cookies
+        };
     }
 
     /**

test/jest/integration-capture.spec.ts

@@ -34,7 +34,11 @@ describe('Integration Capture', () => {
         it('should initialize with a filtered list of integration attribute mappings', () => {
             const integrationCapture = new IntegrationCapture();
             const mappings = integrationCapture.filteredIntegrationAttributeMappings;
-            expect(Object.keys(mappings)).toEqual(['rtid', 'RoktTransactionId']);
+            expect(Object.keys(mappings)).toEqual([
+                'rtid',
+                'rclid', 
+                'RoktTransactionId'
+            ]);
         });
     });
 
@@ -80,6 +84,7 @@ describe('Integration Capture', () => {
                 'gbraid=67890',
                 'wbraid=09876',
                 'rtid=84324',
+                'rclid=7183717',
                 'ScCid=1234'
             ].join('&');
 
@@ -102,6 +107,7 @@ describe('Integration Capture', () => {
                 gclid: '54321',
                 gbraid: '67890',
                 rtid: '84324',
+                rclid: '7183717',
                 wbraid: '09876',
                 ScCid:'1234'
             }); 
@@ -241,6 +247,20 @@ describe('Integration Capture', () => {
                 });
             });
 
+            it('should capture rclid via url param', () => {
+                const url = new URL('https://www.example.com/?rclid=7183717');
+
+                window.location.href = url.href;
+                window.location.search = url.search;
+
+                const integrationCapture = new IntegrationCapture();
+                integrationCapture.capture();
+
+                expect(integrationCapture.clickIds).toEqual({
+                    rclid: '7183717',
+                });
+            });
+
             it('should capture RoktTransactionId via cookies', () => {
                 window.document.cookie = 'RoktTransactionId=12345';
 
@@ -293,6 +313,24 @@ describe('Integration Capture', () => {
                 });
             });
 
+            it('should prioritize rclid over RoktTransactionId via cookies', () => {
+                jest.spyOn(Date, 'now').mockImplementation(() => 42);
+
+                const url = new URL('https://www.example.com/?rclid=7183717');
+
+                window.document.cookie = 'RoktTransactionId=12345';
+
+                window.location.href = url.href;
+                window.location.search = url.search;
+
+                const integrationCapture = new IntegrationCapture();
+                integrationCapture.capture();
+
+                expect(integrationCapture.clickIds).toEqual({
+                    rclid: '7183717',
+                });
+            });
+
             it('should prioritize rtid over RoktTransactionId via local storage', () => {
                 jest.spyOn(Date, 'now').mockImplementation(() => 42);
 
@@ -311,6 +349,24 @@ describe('Integration Capture', () => {
                 });
             });
 
+            it('should prioritize rclid over RoktTransactionId via local storage', () => {
+                jest.spyOn(Date, 'now').mockImplementation(() => 42);
+
+                const url = new URL('https://www.example.com/?rclid=7183717');
+                
+                window.location.href = url.href;
+                window.location.search = url.search;
+
+                localStorage.setItem('RoktTransactionId', '12345');
+
+                const integrationCapture = new IntegrationCapture();
+                integrationCapture.capture();
+
+                expect(integrationCapture.clickIds).toEqual({
+                    rclid: '7183717',
+                });
+            });
+
             it('should prioritize local storage over cookies', () => {
                 jest.spyOn(Date, 'now').mockImplementation(() => 42);
 
@@ -356,7 +412,7 @@ describe('Integration Capture', () => {
             jest.spyOn(Date, 'now').mockImplementation(() => 42);
 
             const url = new URL(
-                'https://www.example.com/?ttclid=12345&fbclid=67890&gclid=54321'
+                'https://www.example.com/?ttclid=12345&fbclid=67890&gclid=54321&rclid=7183717&rtid=54321'
             );
 
             window.location.href = url.href;
@@ -369,6 +425,8 @@ describe('Integration Capture', () => {
                 fbclid: 'fb.2.42.67890',
                 gclid: '54321',
                 ttclid: '12345',
+                rclid: '7183717',
+                rtid: '54321',
             });
         });
 

test/src/tests-integration-capture.ts

@@ -50,6 +50,7 @@ describe('Integration Capture', () => {
             gclid: '234',
             gbraid: '6574',
             rtid: '45670808',
+            rclid: '7183717',
             wbraid: '1234111',
             ScCid: '1234',
         });