Add tapad id submodule

modules/.submodules.json

@@ -19,7 +19,8 @@
     "idxIdSystem",
     "fabrickIdSystem",
     "verizonMediaIdSystem",
-    "pubProvidedIdSystem"
+    "pubProvidedIdSystem",
+    "tapadIdSystem"
   ],
   "adpod": [
     "freeWheelAdserverVideo",

modules/tapadIdSystem.js

@@ -0,0 +1,78 @@
+import { uspDataHandler } from '../src/adapterManager.js';
+import { submodule } from '../src/hook.js';
+import { getStorageManager } from '../src/storageManager.js';
+import * as ajax from '../src/ajax.js'
+import * as utils from '../src/utils.js';
+
+export const storage = getStorageManager();
+const cookiesMaxAge = 7 * 24 * 60 * 60 * 1000; // 60 days
+export const defaultExpirationString = new Date(utils.timestamp() + cookiesMaxAge).toString();
+export const pastDateString = new Date(0).toString();
+export const tapadCookieKey = 'tapad_id';
+export const graphUrl = 'https://realtime-graph-access-zxvhwknfeq-uc.a.run.app/v1/graph';
+
+function saveOnAllStorages(key, value, expiration = defaultExpirationString) {
+  storage.setCookie(key, typeof value === 'object' ? JSON.stringify(value) : value, expiration);
+  storage.setDataInLocalStorage(key, JSON.stringify(value));
+}
+
+function deleteFromAllStorages(key) {
+  storage.setCookie(key, undefined, pastDateString);
+  storage.removeDataFromLocalStorage(key);
+}
+
+export const tapadIdSubmodule = {
+  name: 'tapadId',
+  /**
+   * decode the stored id value for passing to bid requests
+   * @function
+   * @returns {{tapadId: string} | undefined}
+   */
+  decode(id) {
+    return { tapadId: id };
+  },
+  /*
+   * @function
+   * @summary initiate Real Time Graph
+   * @param {SubmoduleParams} [configParams]
+   * @param {ConsentData} [consentData]
+   * @returns {IdResponse }}
+   */
+  getId(config) {
+    const uspData = uspDataHandler.getConsentData();
+    if (uspData && uspData !== '1---') {
+      return { id: undefined };
+    }
+    const configParams = config.params || {};
+    const expiration = config.storage && config.storage.expires
+      ? new Date(utils.timestamp() + config.storage.expires * 24 * 60 * 60 * 1000).toString()
+      : undefined;
+
+    return {
+      callback: (complete) => {
+        ajax.ajaxBuilder(10000)(
+          `${graphUrl}?company_id=${configParams.companyId}&tapad_id_type=TAPAD_ID`,
+          {
+            success: (response) => {
+              const responseJson = JSON.parse(response);
+              if (responseJson.hasOwnProperty('tapadId')) {
+                saveOnAllStorages(tapadCookieKey, responseJson.tapadId, expiration)
+                complete(responseJson.tapadId)
+              }
+            },
+            error: (_, e) => {
+              if (e.status === 404) {
+                deleteFromAllStorages(tapadCookieKey);
+                complete(undefined);
+              }
+              if (e.status === 403) {
+                utils.logMessage('Invalid Company Id. Contact [email protected] for assistance.')
+              }
+            }
+          }
+        )
+      }
+    }
+  }
+}
+submodule('userId', tapadIdSubmodule);

test/spec/modules/tapadIdSystem_spec.js

@@ -0,0 +1,55 @@
+import { tapadIdSubmodule, graphUrl, storage, tapadCookieKey, pastDateString, defaultExpirationString } from 'modules/tapadIdSystem.js';
+import * as utils from 'src/utils.js';
+
+import { server } from 'test/mocks/xhr.js';
+
+describe('TapadIdSystem', function () {
+  describe('getId', function() {
+    let setCookieSpy;
+    beforeEach(() => {
+      setCookieSpy = sinon.spy(storage, 'setCookie');
+    })
+    afterEach(() => {
+      setCookieSpy.restore()
+    })
+
+    it('should call to real time graph endpoint and handle valid response', function() {
+      const callbackSpy = sinon.spy()
+      const callback = tapadIdSubmodule.getId({
+        params: { companyId: 12345 }
+      }).callback
+      callback(callbackSpy);
+
+      const request = server.requests[0]
+      expect(request.url).to.eq(`${graphUrl}?company_id=12345&tapad_id_type=TAPAD_ID`)
+
+      request.respond(200, { 'Content-Type': 'application/json' }, JSON.stringify({ tapadId: 'your-tapad-id' }))
+      expect(callbackSpy.lastCall.lastArg).to.eq('your-tapad-id');
+      expect(setCookieSpy.lastCall.calledWith(tapadCookieKey, 'your-tapad-id', defaultExpirationString)).to.be.true
+    })
+
+    it('should remove stored tapadId if not found', function() {
+      const callbackSpy = sinon.spy()
+      const callback = tapadIdSubmodule.getId({}).callback
+      callback(callbackSpy);
+
+      const request = server.requests[0]
+
+      request.respond(404)
+      expect(callbackSpy.lastCall.lastArg).to.be.undefined;
+      expect(setCookieSpy.lastCall.calledWith(tapadCookieKey, undefined, pastDateString)).to.be.true
+    })
+    it('should log message with invalid company id', function() {
+      const logMessageSpy = sinon.spy(utils, 'logMessage');
+      const callbackSpy = sinon.spy()
+      const callback = tapadIdSubmodule.getId({}).callback
+      callback(callbackSpy);
+
+      const request = server.requests[0]
+
+      request.respond(403)
+      expect(logMessageSpy.lastCall.lastArg).to.eq('Invalid Company Id. Contact [email protected] for assistance.')
+      logMessageSpy.restore()
+    })
+  })
+})