identityLinkSubmodule: add additional check on retrieving the envelope (

#10355) * IdentityLinkIdSystem - liveramp - add additional logic to get envelope from storage if ats is not present on a page * IdentityLinkIdSystem - liveramp - fix unit test
prebid · Aug 15, 2023 · 507b5a0 · 507b5a0
1 parent 3cc9175
commit 507b5a0
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 3 deletions.
diff --git a/modules/identityLinkIdSystem.js b/modules/identityLinkIdSystem.js
@@ -15,6 +15,8 @@ const MODULE_NAME = 'identityLink';
 
 export const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME});
 
+const liverampEnvelopeName = '_lr_env';
+
 /** @type {Submodule} */
 export const identityLinkSubmodule = {
   /**
@@ -74,7 +76,14 @@ export const identityLinkSubmodule = {
           }
         });
       } else {
-        getEnvelope(url, callback, configParams);
+        // try to get envelope directly from storage if ats lib is not present on a page
+        let envelope = getEnvelopeFromStorage();
+        if (envelope) {
+          utils.logInfo('identityLink: LiveRamp envelope successfully retrieved from storage!');
+          callback(JSON.parse(envelope).envelope);
+        } else {
+          getEnvelope(url, callback, configParams);
+        }
       }
     };
 
@@ -127,4 +136,9 @@ function setEnvelopeSource(src) {
   storage.setCookie('_lr_env_src_ats', src, now.toUTCString());
 }
 
+export function getEnvelopeFromStorage() {
+  let rawEnvelope = storage.getCookie(liverampEnvelopeName) || storage.getDataFromLocalStorage(liverampEnvelopeName);
+  return rawEnvelope ? window.atob(rawEnvelope) : undefined;
+}
+
 submodule('userId', identityLinkSubmodule);
diff --git a/test/spec/modules/identityLinkIdSystem_spec.js b/test/spec/modules/identityLinkIdSystem_spec.js
@@ -1,13 +1,22 @@
-import {identityLinkSubmodule} from 'modules/identityLinkIdSystem.js';
+import {getEnvelopeFromStorage, identityLinkSubmodule} from 'modules/identityLinkIdSystem.js';
 import * as utils from 'src/utils.js';
 import {server} from 'test/mocks/xhr.js';
 import {getCoreStorageManager} from '../../../src/storageManager.js';
+import {stub} from 'sinon';
 
 const storage = getCoreStorageManager();
 
 const pid = '14';
 let defaultConfigParams;
-const responseHeader = {'Content-Type': 'application/json'}
+const responseHeader = {'Content-Type': 'application/json'};
+const testEnvelope = 'eyJ0aW1lc3RhbXAiOjE2OTEwNjU5MzQwMTcsInZlcnNpb24iOiIxLjIuMSIsImVudmVsb3BlIjoiQWhIenUyMFN3WHZ6T0hPd3c2bkxaODAtd2hoN2Nnd0FqWllNdkQ0UjBXT25xRVc1N21zR2Vral9QejU2b1FwcGdPOVB2aFJFa3VHc2lMdG56c3A2aG13eDRtTTRNLTctRy12NiJ9';
+const testEnvelopeValue = '{"timestamp":1691065934017,"version":"1.2.1","envelope":"AhHzu20SwXvzOHOww6nLZ80-whh7cgwAjZYMvD4R0WOnqEW57msGekj_Pz56oQppgO9PvhREkuGsiLtnzsp6hmwx4mM4M-7-G-v6"}';
+
+function setTestEnvelopeCookie () {
+  let now = new Date();
+  now.setTime(now.getTime() + 3000);
+  storage.setCookie('_lr_env', testEnvelope, now.toUTCString());
+}
 
 describe('IdentityLinkId tests', function () {
   let logErrorStub;
@@ -17,6 +26,7 @@ describe('IdentityLinkId tests', function () {
     logErrorStub = sinon.stub(utils, 'logError');
     // remove _lr_retry_request cookie before test
     storage.setCookie('_lr_retry_request', 'true', 'Thu, 01 Jan 1970 00:00:01 GMT');
+    storage.setCookie('_lr_env', testEnvelope, 'Thu, 01 Jan 1970 00:00:01 GMT');
   });
 
   afterEach(function () {
@@ -163,4 +173,43 @@ describe('IdentityLinkId tests', function () {
     let request = server.requests[0];
     expect(request).to.be.eq(undefined);
   });
+
+  it('should get envelope from storage if ats is not present on a page and pass it to callback', function () {
+    setTestEnvelopeCookie();
+    let envelopeValueFromStorage = getEnvelopeFromStorage();
+    let callBackSpy = sinon.spy();
+    let submoduleCallback = identityLinkSubmodule.getId(defaultConfigParams).callback;
+    submoduleCallback(callBackSpy);
+    expect(envelopeValueFromStorage).to.be.a('string');
+    expect(callBackSpy.calledOnce).to.be.true;
+  })
+
+  it('if there is no envelope in storage and ats is not present on a page try to call 3p url', function () {
+    let envelopeValueFromStorage = getEnvelopeFromStorage();
+    let callBackSpy = sinon.spy();
+    let submoduleCallback = identityLinkSubmodule.getId(defaultConfigParams).callback;
+    submoduleCallback(callBackSpy);
+    let request = server.requests[0];
+    expect(request.url).to.be.eq('https://api.rlcdn.com/api/identity/envelope?pid=14');
+    request.respond(
+      204,
+      responseHeader,
+    );
+    expect(envelopeValueFromStorage).to.be.a('undefined');
+    expect(callBackSpy.calledOnce).to.be.true;
+  })
+
+  it('if ats is present on a page, and envelope is generated and stored in storage, call a callback', function () {
+    setTestEnvelopeCookie();
+    let envelopeValueFromStorage = getEnvelopeFromStorage();
+    window.ats = {retrieveEnvelope: function() {
+    }}
+    // mock ats.retrieveEnvelope to return envelope
+    stub(window.ats, 'retrieveEnvelope').callsFake(function() { return envelopeValueFromStorage })
+    let callBackSpy = sinon.spy();
+    let submoduleCallback = identityLinkSubmodule.getId(defaultConfigParams).callback;
+    submoduleCallback(callBackSpy);
+    expect(envelopeValueFromStorage).to.be.a('string');
+    expect(envelopeValueFromStorage).to.be.eq(testEnvelopeValue);
+  })
 });