From 625d4df57aa279550c428f0e01b12a874b48ef0c Mon Sep 17 00:00:00 2001
From: Mark Conrad <mconrad@lotame.com>
Date: Wed, 25 Nov 2020 10:40:47 -0500
Subject: [PATCH 1/7] Fix the userId example so the page will load

---
 integrationExamples/gpt/userId_example.html | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/integrationExamples/gpt/userId_example.html b/integrationExamples/gpt/userId_example.html
index 7375293fdf0..e7541289037 100644
--- a/integrationExamples/gpt/userId_example.html
+++ b/integrationExamples/gpt/userId_example.html
@@ -71,10 +71,12 @@
                 t.async = false;
                 t.src = 'http://acdn.adnxs.com/cmp/cmp.bundle.js';
                 var tag = document.getElementsByTagName('head')[0];
-                tag.appendChild(t);
+                tag.appendChild(t);                
             }
         })(window, document);
         // window.__cmp('showConsentTool');
+
+        function getHashedEmail() {}
     </script>
 
     <script>
@@ -323,7 +325,7 @@
 </head>
 
 <body>
-<h2>Rubicon Project Prebid</h2>
+<h2>Prebid User ID Example</h2>
 
 <div id='test-div'>
     <script>

From 7d3e79be9d9b092f75f3dd1a43a2de6d957f2cd0 Mon Sep 17 00:00:00 2001
From: Mark Conrad <mconrad@lotame.com>
Date: Wed, 25 Nov 2020 10:41:56 -0500
Subject: [PATCH 2/7] LotamePanoramaIdSystem: Fix parseInt typo; store cookies
 on the root domain; the expiry cookie's expiry to match its value

---
 modules/lotamePanoramaIdSystem.js | 47 +++++++++++++++++++++++++++----
 1 file changed, 41 insertions(+), 6 deletions(-)

diff --git a/modules/lotamePanoramaIdSystem.js b/modules/lotamePanoramaIdSystem.js
index 5c3a9a16b3a..82502356ab4 100644
--- a/modules/lotamePanoramaIdSystem.js
+++ b/modules/lotamePanoramaIdSystem.js
@@ -14,10 +14,41 @@ const KEY_EXPIRY = `${KEY_ID}_expiry`;
 const KEY_PROFILE = '_cc_id';
 const MODULE_NAME = 'lotamePanoramaId';
 const NINE_MONTHS_MS = 23328000 * 1000;
-const DAYS_TO_CACHE = 7;
-const DAY_MS = 60 * 60 * 24 * 1000;
 
 export const storage = getStorageManager(null, MODULE_NAME);
+const cookieDomain = findCookieDomain(String(document.domain));
+
+/**
+ * Find the root dommain
+ * @param {string} fullDomain
+ * @return {?string}
+ */
+function findCookieDomain(fullDomain) {
+  const domainParts = fullDomain.split('.');
+  if (domainParts.length == 2) {
+    return fullDomain;
+  }
+  let rootDomain;
+  let continueSearching = true;
+  let startIndex = -2;
+  const TEST_COOKIE_NAME = 'lotame_domain_check';
+  const TEST_COOKIE_VALUE = 'writeable';
+  do {
+    rootDomain = domainParts.slice(startIndex).join('.');
+    let expirationDate = new Date(
+      utils.timestamp() + 10 * 1000
+    ).toUTCString();
+    storage.setCookie(TEST_COOKIE_NAME, TEST_COOKIE_VALUE, expirationDate, 'Lax', `${rootDomain}`, undefined);
+    const value = storage.getCookie(TEST_COOKIE_NAME, undefined);
+    if (value === TEST_COOKIE_VALUE) {
+      continueSearching = false;
+    } else {
+      startIndex += -1;
+      continueSearching = Math.abs(startIndex) <= domainParts.length;
+    }
+  } while (continueSearching);
+  return rootDomain;
+}
 
 /**
  * Set the Lotame First Party Profile ID in the first party namespace
@@ -78,7 +109,7 @@ function getFromStorage(key) {
 function saveLotameCache(
   key,
   value,
-  expirationTimestamp = utils.timestamp() + DAYS_TO_CACHE * DAY_MS
+  expirationTimestamp
 ) {
   if (key && value) {
     let expirationDate = new Date(expirationTimestamp).toUTCString();
@@ -88,7 +119,7 @@ function saveLotameCache(
         value,
         expirationDate,
         'Lax',
-        undefined,
+        cookieDomain,
         undefined
       );
     }
@@ -115,7 +146,7 @@ function getLotameLocalCache() {
   try {
     const rawExpiry = getFromStorage(KEY_EXPIRY);
     if (utils.isStr(rawExpiry)) {
-      cache.expiryTimestampMs = parseInt(rawExpiry, 0);
+      cache.expiryTimestampMs = parseInt(rawExpiry, 10);
     }
   } catch (error) {
     utils.logError(error);
@@ -205,7 +236,11 @@ export const lotamePanoramaIdSubmodule = {
           if (response) {
             try {
               let responseObj = JSON.parse(response);
-              saveLotameCache(KEY_EXPIRY, responseObj.expiry_ts);
+              saveLotameCache(
+                KEY_EXPIRY,
+                responseObj.expiry_ts,
+                responseObj.expiry_ts
+              );
 
               if (utils.isStr(responseObj.profile_id)) {
                 setProfileId(responseObj.profile_id);

From 815bd0a02fc6bbcfd43e44f121b98c0e8c441cac Mon Sep 17 00:00:00 2001
From: Mark Conrad <mconrad@lotame.com>
Date: Wed, 25 Nov 2020 11:11:41 -0500
Subject: [PATCH 3/7] Remove extra space

---
 integrationExamples/gpt/userId_example.html | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/integrationExamples/gpt/userId_example.html b/integrationExamples/gpt/userId_example.html
index e7541289037..c1ad2d62eef 100644
--- a/integrationExamples/gpt/userId_example.html
+++ b/integrationExamples/gpt/userId_example.html
@@ -71,7 +71,7 @@
                 t.async = false;
                 t.src = 'http://acdn.adnxs.com/cmp/cmp.bundle.js';
                 var tag = document.getElementsByTagName('head')[0];
-                tag.appendChild(t);                
+                tag.appendChild(t);
             }
         })(window, document);
         // window.__cmp('showConsentTool');

From 3447bcd504866311662f53affcabb52cae1dc347 Mon Sep 17 00:00:00 2001
From: Mark Conrad <mconrad@lotame.com>
Date: Wed, 25 Nov 2020 13:40:33 -0500
Subject: [PATCH 4/7] LotamePanoramaIdSystem: Resolve the domain later; Add
 tests

---
 modules/lotamePanoramaIdSystem.js             | 73 ++++++++++---------
 .../modules/lotamePanoramaIdSystem_spec.js    | 20 +++++
 2 files changed, 59 insertions(+), 34 deletions(-)

diff --git a/modules/lotamePanoramaIdSystem.js b/modules/lotamePanoramaIdSystem.js
index 82502356ab4..5616c6b2573 100644
--- a/modules/lotamePanoramaIdSystem.js
+++ b/modules/lotamePanoramaIdSystem.js
@@ -16,39 +16,7 @@ const MODULE_NAME = 'lotamePanoramaId';
 const NINE_MONTHS_MS = 23328000 * 1000;
 
 export const storage = getStorageManager(null, MODULE_NAME);
-const cookieDomain = findCookieDomain(String(document.domain));
-
-/**
- * Find the root dommain
- * @param {string} fullDomain
- * @return {?string}
- */
-function findCookieDomain(fullDomain) {
-  const domainParts = fullDomain.split('.');
-  if (domainParts.length == 2) {
-    return fullDomain;
-  }
-  let rootDomain;
-  let continueSearching = true;
-  let startIndex = -2;
-  const TEST_COOKIE_NAME = 'lotame_domain_check';
-  const TEST_COOKIE_VALUE = 'writeable';
-  do {
-    rootDomain = domainParts.slice(startIndex).join('.');
-    let expirationDate = new Date(
-      utils.timestamp() + 10 * 1000
-    ).toUTCString();
-    storage.setCookie(TEST_COOKIE_NAME, TEST_COOKIE_VALUE, expirationDate, 'Lax', `${rootDomain}`, undefined);
-    const value = storage.getCookie(TEST_COOKIE_NAME, undefined);
-    if (value === TEST_COOKIE_VALUE) {
-      continueSearching = false;
-    } else {
-      startIndex += -1;
-      continueSearching = Math.abs(startIndex) <= domainParts.length;
-    }
-  } while (continueSearching);
-  return rootDomain;
-}
+let cookieDomain;
 
 /**
  * Set the Lotame First Party Profile ID in the first party namespace
@@ -57,7 +25,7 @@ function findCookieDomain(fullDomain) {
 function setProfileId(profileId) {
   if (storage.cookiesAreEnabled()) {
     let expirationDate = new Date(utils.timestamp() + NINE_MONTHS_MS).toUTCString();
-    storage.setCookie(KEY_PROFILE, profileId, expirationDate, 'Lax', undefined, undefined);
+    storage.setCookie(KEY_PROFILE, profileId, expirationDate, 'Lax', cookieDomain, undefined);
   }
   if (storage.hasLocalStorage()) {
     storage.setDataInLocalStorage(KEY_PROFILE, profileId, undefined);
@@ -179,6 +147,42 @@ export const lotamePanoramaIdSubmodule = {
    */
   name: MODULE_NAME,
 
+  /**
+   * Find the root domain
+   * @param {string} fullDomain
+   * @return {?string}
+   */
+  findCookieDomain: function (fullDomain) {
+    if (!storage.cookiesAreEnabled()) {
+      return fullDomain;
+    }
+
+    const domainParts = fullDomain.split('.');
+    if (domainParts.length == 2) {
+      return fullDomain;
+    }
+    let rootDomain;
+    let continueSearching = true;
+    let startIndex = -2;
+    const TEST_COOKIE_NAME = 'lotame_domain_check';
+    const TEST_COOKIE_VALUE = 'writeable';
+    do {
+      rootDomain = domainParts.slice(startIndex).join('.');
+      let expirationDate = new Date(
+        utils.timestamp() + 10 * 1000
+      ).toUTCString();
+      storage.setCookie(TEST_COOKIE_NAME, TEST_COOKIE_VALUE, expirationDate, 'Lax', `${rootDomain}`, undefined);
+      const value = storage.getCookie(TEST_COOKIE_NAME, undefined);
+      if (value === TEST_COOKIE_VALUE) {
+        continueSearching = false;
+      } else {
+        startIndex += -1;
+        continueSearching = Math.abs(startIndex) <= domainParts.length;
+      }
+    } while (continueSearching);
+    return rootDomain;
+  },
+
   /**
    * Decode the stored id value for passing to bid requests
    * @function decode
@@ -199,6 +203,7 @@ export const lotamePanoramaIdSubmodule = {
    * @returns {IdResponse|undefined}
    */
   getId(config, consentData, cacheIdObj) {
+    cookieDomain = this.findCookieDomain(String(document.domain));
     let localCache = getLotameLocalCache();
 
     let refreshNeeded = Date.now() > localCache.expiryTimestampMs;
diff --git a/test/spec/modules/lotamePanoramaIdSystem_spec.js b/test/spec/modules/lotamePanoramaIdSystem_spec.js
index c6d3383374a..b9f76cc701a 100644
--- a/test/spec/modules/lotamePanoramaIdSystem_spec.js
+++ b/test/spec/modules/lotamePanoramaIdSystem_spec.js
@@ -446,4 +446,24 @@ describe('LotameId', function() {
       'lotamePanoramaId': '1234'
     });
   });
+
+  describe('findCookieDomain', function() {
+    beforeEach(function() {
+      getCookieStub
+        .onFirstCall()
+        .returns(null) // .co.uk
+        .onSecondCall()
+        .returns('writeable') // realdomain.co.uk;
+    });
+
+    it('should just find the root domain', function() {
+      var domain = lotamePanoramaIdSubmodule.findCookieDomain('sub.realdomain.co.uk')
+      expect(domain).to.be.eq('realdomain.co.uk')
+    });
+
+    it('should find the full domain when no subdomain is present', function() {
+      var domain = lotamePanoramaIdSubmodule.findCookieDomain('realdomain.co.uk')
+      expect(domain).to.be.eq('realdomain.co.uk')
+    });
+  });
 });

From dc5ef22cc361c6b24f20049563e09480fb57108d Mon Sep 17 00:00:00 2001
From: Mark Conrad <mconrad@lotame.com>
Date: Tue, 1 Dec 2020 11:00:33 -0500
Subject: [PATCH 5/7] Per LGTM check, remove useless assignment

---
 modules/lotamePanoramaIdSystem.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/modules/lotamePanoramaIdSystem.js b/modules/lotamePanoramaIdSystem.js
index 5616c6b2573..c302ccbbb66 100644
--- a/modules/lotamePanoramaIdSystem.js
+++ b/modules/lotamePanoramaIdSystem.js
@@ -162,7 +162,7 @@ export const lotamePanoramaIdSubmodule = {
       return fullDomain;
     }
     let rootDomain;
-    let continueSearching = true;
+    let continueSearching;
     let startIndex = -2;
     const TEST_COOKIE_NAME = 'lotame_domain_check';
     const TEST_COOKIE_VALUE = 'writeable';

From bd2fe9c0ae02714cc291eaf87f5b747c9ebba1da Mon Sep 17 00:00:00 2001
From: Mark Conrad <mconrad@lotame.com>
Date: Fri, 11 Dec 2020 09:21:27 -0500
Subject: [PATCH 6/7] For a particular error case, don't update the profile id
 in storage

---
 modules/lotamePanoramaIdSystem.js | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/modules/lotamePanoramaIdSystem.js b/modules/lotamePanoramaIdSystem.js
index c302ccbbb66..2010f0001a5 100644
--- a/modules/lotamePanoramaIdSystem.js
+++ b/modules/lotamePanoramaIdSystem.js
@@ -241,6 +241,8 @@ export const lotamePanoramaIdSubmodule = {
           if (response) {
             try {
               let responseObj = JSON.parse(response);
+              const shouldUpdateProfileId = !(utils.isArray(responseObj.errors) && responseObj.errors.includes(111));
+
               saveLotameCache(
                 KEY_EXPIRY,
                 responseObj.expiry_ts,
@@ -248,7 +250,9 @@ export const lotamePanoramaIdSubmodule = {
               );
 
               if (utils.isStr(responseObj.profile_id)) {
-                setProfileId(responseObj.profile_id);
+                if (shouldUpdateProfileId) {
+                  setProfileId(responseObj.profile_id);
+                }
 
                 if (utils.isStr(responseObj.core_id)) {
                   saveLotameCache(
@@ -261,7 +265,9 @@ export const lotamePanoramaIdSubmodule = {
                   clearLotameCache(KEY_ID);
                 }
               } else {
-                clearLotameCache(KEY_PROFILE);
+                if (shouldUpdateProfileId) {
+                  clearLotameCache(KEY_PROFILE);
+                }
                 clearLotameCache(KEY_ID);
               }
             } catch (error) {

From 14f6991cf6d3e2f882465f7da57ef95d08224f5e Mon Sep 17 00:00:00 2001
From: Mark Conrad <mconrad@lotame.com>
Date: Fri, 11 Dec 2020 09:33:48 -0500
Subject: [PATCH 7/7] Add tests for the error 111 ignore case

---
 .../modules/lotamePanoramaIdSystem_spec.js    | 116 ++++++++++++++++++
 1 file changed, 116 insertions(+)

diff --git a/test/spec/modules/lotamePanoramaIdSystem_spec.js b/test/spec/modules/lotamePanoramaIdSystem_spec.js
index b9f76cc701a..608c6016a49 100644
--- a/test/spec/modules/lotamePanoramaIdSystem_spec.js
+++ b/test/spec/modules/lotamePanoramaIdSystem_spec.js
@@ -466,4 +466,120 @@ describe('LotameId', function() {
       expect(domain).to.be.eq('realdomain.co.uk')
     });
   });
+
+  describe('with an empty cache, ignore profile id for error 111', function () {
+    let request;
+    let callBackSpy = sinon.spy();
+
+    beforeEach(function () {
+      let submoduleCallback = lotamePanoramaIdSubmodule.getId({}).callback;
+      submoduleCallback(callBackSpy);
+
+      request = server.requests[0];
+
+      request.respond(
+        200,
+        responseHeader,
+        JSON.stringify({
+          profile_id: '4ec137245858469eb94a4e248f238694',
+          expiry_ts: 10,
+          errors: [111],
+          core_id:
+            'ca22992567e3cd4d116a5899b88a55d0d857a23610db939ae6ac13ba2335d87a',
+        })
+      );
+    });
+
+    it('should not save the first party id', function () {
+      sinon.assert.neverCalledWith(
+        setLocalStorageStub,
+        '_cc_id',
+        '4ec137245858469eb94a4e248f238694'
+      );
+      sinon.assert.neverCalledWith(
+        setCookieStub,
+        '_cc_id',
+        '4ec137245858469eb94a4e248f238694'
+      );
+    });
+
+    it('should save the expiry', function () {
+      sinon.assert.calledWith(setLocalStorageStub, 'panoramaId_expiry', 10);
+
+      sinon.assert.calledWith(setCookieStub, 'panoramaId_expiry', 10);
+    });
+
+    it('should save the id', function () {
+      sinon.assert.calledWith(
+        setLocalStorageStub,
+        'panoramaId',
+        'ca22992567e3cd4d116a5899b88a55d0d857a23610db939ae6ac13ba2335d87a'
+      );
+
+      sinon.assert.calledWith(
+        setCookieStub,
+        'panoramaId',
+        'ca22992567e3cd4d116a5899b88a55d0d857a23610db939ae6ac13ba2335d87a'
+      );
+    });
+  });
+
+  describe('receives an optout request with an error 111', function () {
+    let request;
+    let callBackSpy = sinon.spy();
+
+    beforeEach(function () {
+      getCookieStub.withArgs('panoramaId_expiry').returns('1000');
+      getCookieStub
+        .withArgs('panoramaId')
+        .returns(
+          'ca22992567e3cd4d116a5899b88a55d0d857a23610db939ae6ac13ba2335d87d'
+        );
+
+      let submoduleCallback = lotamePanoramaIdSubmodule.getId({}).callback;
+      submoduleCallback(callBackSpy);
+
+      request = server.requests[0];
+
+      request.respond(
+        200,
+        responseHeader,
+        JSON.stringify({
+          errors: [111],
+          expiry_ts: Date.now() + (30 * 24 * 60 * 60 * 1000),
+        })
+      );
+    });
+
+    it('should call the remote server when getId is called', function () {
+      expect(callBackSpy.calledOnce).to.be.true;
+    });
+
+    it('should clear the panorama id', function () {
+      sinon.assert.calledWith(
+        removeFromLocalStorageStub,
+        'panoramaId'
+      );
+
+      sinon.assert.calledWith(
+        setCookieStub,
+        'panoramaId',
+        '',
+        'Thu, 01 Jan 1970 00:00:00 GMT',
+        'Lax'
+      );
+    });
+
+    it('should not clear the profile id', function () {
+      sinon.assert.neverCalledWith(removeFromLocalStorageStub, '_cc_id');
+
+      sinon.assert.neverCalledWith(
+        setCookieStub,
+        '_cc_id',
+        '',
+        'Thu, 01 Jan 1970 00:00:00 GMT',
+        'Lax'
+      );
+    });
+  });
 });
