ConnectID: Support new easy-opt out method (#9069)

* Respect custom opt-out override localstorage key. * Wrap opt-out check in a function. * Rename function * Add unit tests Co-authored-by: slimkrazy <[email protected]>
prebid · Oct 11, 2022 · 958acae · 958acae
1 parent 7287486
commit 958acae
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 1 deletion.
diff --git a/modules/connectIdSystem.js b/modules/connectIdSystem.js
@@ -7,18 +7,27 @@
 
 import {ajax} from '../src/ajax.js';
 import {submodule} from '../src/hook.js';
-import {formatQS, logError} from '../src/utils.js';
 import {includes} from '../src/polyfill.js';
+import {formatQS, logError} from '../src/utils.js';
 
 const MODULE_NAME = 'connectId';
 const VENDOR_ID = 25;
 const PLACEHOLDER = '__PIXEL_ID__';
 const UPS_ENDPOINT = `https://ups.analytics.yahoo.com/ups/${PLACEHOLDER}/fed`;
+const OVERRIDE_OPT_OUT_KEY = 'connectIdOptOut';
 
 function isEUConsentRequired(consentData) {
   return !!(consentData && consentData.gdpr && consentData.gdpr.gdprApplies);
 }
 
+function userHasOptedOut() {
+  try {
+    return localStorage.getItem(OVERRIDE_OPT_OUT_KEY) === '1';
+  } catch {
+    return false;
+  }
+}
+
 /** @type {Submodule} */
 export const connectIdSubmodule = {
   /**
@@ -36,6 +45,9 @@ export const connectIdSubmodule = {
    * @returns {{connectId: string} | undefined}
    */
   decode(value) {
+    if (userHasOptedOut()) {
+      return undefined;
+    }
     return (typeof value === 'object' && value.connectid)
       ? {connectId: value.connectid} : undefined;
   },
@@ -47,6 +59,9 @@ export const connectIdSubmodule = {
    * @returns {IdResponse|undefined}
    */
   getId(config, consentData) {
+    if (userHasOptedOut()) {
+      return;
+    }
     const params = config.params || {};
     if (!params || typeof params.he !== 'string' ||
       (typeof params.pixelId === 'undefined' && typeof params.endpoint === 'undefined')) {

diff --git a/test/spec/modules/connectIdSystem_spec.js b/test/spec/modules/connectIdSystem_spec.js
@@ -76,6 +76,26 @@ describe('Yahoo ConnectID Submodule', () => {
       expect(result.callback).to.be.a('function');
     });
 
+    it('returns an undefined if the Yahoo specific opt-out key is present in local storage', () => {
+      localStorage.setItem('connectIdOptOut', '1');
+      expect(invokeGetIdAPI({
+        he: HASHED_EMAIL,
+        pixelId: PIXEL_ID
+      }, consentData)).to.be.undefined;
+      localStorage.removeItem('connectIdOptOut');
+    });
+
+    it('returns an object with the callback function if the correct params are passed and Yahoo opt-out value is not "1"', () => {
+      localStorage.setItem('connectIdOptOut', 'true');
+      let result = invokeGetIdAPI({
+        he: HASHED_EMAIL,
+        pixelId: PIXEL_ID
+      }, consentData);
+      expect(result).to.be.an('object').that.has.all.keys('callback');
+      expect(result.callback).to.be.a('function');
+      localStorage.removeItem('connectIdOptOut');
+    });
+
     it('Makes an ajax GET request to the production API endpoint with query params', () => {
       invokeGetIdAPI({
         he: HASHED_EMAIL,