userID: break out EID configuration to individual submodules (#10229)

* move eids config to submodules * update EID logic * Fix tests
prebid · Jul 14, 2023 · 4389768 · 4389768
1 parent f4664a1
commit 4389768
Show file tree

Hide file tree

Showing 58 changed files with 1,203 additions and 1,295 deletions.
diff --git a/modules/33acrossIdSystem.js b/modules/33acrossIdSystem.js
@@ -126,6 +126,15 @@ export const thirthyThreeAcrossIdSubmodule = {
         }, calculateQueryStringParams(pid, gdprConsentData), { method: 'GET', withCredentials: true });
       }
     };
+  },
+  eids: {
+    '33acrossId': {
+      source: '33across.com',
+      atype: 1,
+      getValue: function(data) {
+        return data.envelope;
+      }
+    },
   }
 };
 

diff --git a/modules/admixerIdSystem.js b/modules/admixerIdSystem.js
@@ -72,6 +72,12 @@ export const admixerIdSubmodule = {
     };
 
     return { callback: resp };
+  },
+  eids: {
+    'admixerId': {
+      source: 'admixer.net',
+      atype: 3
+    },
   }
 };
 function retrieveVisitorId(url, callback) {

diff --git a/modules/adqueryIdSystem.js b/modules/adqueryIdSystem.js
@@ -98,6 +98,12 @@ export const adqueryIdSubmodule = {
       }
     };
     return {callback: resp};
+  },
+  eids: {
+    'qid': {
+      source: 'adquery.io',
+      atype: 1
+    },
   }
 };
 

diff --git a/modules/adtelligentIdSystem.js b/modules/adtelligentIdSystem.js
@@ -85,6 +85,12 @@ export const adtelligentIdModule = {
       }
 
     }
+  },
+  eids: {
+    'adtelligentId': {
+      source: 'adtelligent.com',
+      atype: 3
+    },
   }
 };
 

diff --git a/modules/amxIdSystem.js b/modules/amxIdSystem.js
@@ -152,6 +152,12 @@ export const amxIdSubmodule = {
 
     return { callback };
   },
+  eids: {
+    amxId: {
+      source: 'amxdt.net',
+      atype: 1,
+    },
+  }
 };
 
 submodule('userId', amxIdSubmodule);
diff --git a/modules/britepoolIdSystem.js b/modules/britepoolIdSystem.js
@@ -136,6 +136,12 @@ export const britepoolIdSubmodule = {
       }
     }
     return valueObj;
+  },
+  eids: {
+    'britepoolid': {
+      source: 'britepool.com',
+      atype: 3
+    },
   }
 };
 

diff --git a/modules/connectIdSystem.js b/modules/connectIdSystem.js
@@ -294,6 +294,12 @@ export const connectIdSubmodule = {
    */
   getAjaxFn() {
     return ajax;
+  },
+  eids: {
+    'connectId': {
+      source: 'yahoo.com',
+      atype: 3
+    },
   }
 };
 

diff --git a/modules/criteoIdSystem.js b/modules/criteoIdSystem.js
@@ -216,6 +216,12 @@ export const criteoIdSubmodule = {
       id: localData.bidId ? { criteoId: localData.bidId } : undefined,
       callback: result
     }
+  },
+  eids: {
+    'criteoId': {
+      source: 'criteo.com',
+      atype: 1
+    },
   }
 };
 

diff --git a/modules/czechAdIdSystem.js b/modules/czechAdIdSystem.js
@@ -42,6 +42,12 @@ export const czechAdIdSubmodule = {
   getId () {
     const id = readId()
     return id ? { id: id } : undefined
+  },
+  eids: {
+    'czechAdId': {
+      source: 'czechadid.cz',
+      atype: 1
+    },
   }
 }
 

diff --git a/modules/dacIdSystem.js b/modules/dacIdSystem.js
@@ -170,6 +170,12 @@ export const dacIdSystemSubmodule = {
     }
 
     return fetchAoneId(configParams.oid, cookie.fuuid);
+  },
+  eids: {
+    'dacId': {
+      source: 'impact-ad.jp',
+      atype: 1
+    },
   }
 };
 

diff --git a/modules/deepintentDpesIdSystem.js b/modules/deepintentDpesIdSystem.js
@@ -39,8 +39,13 @@ export const deepintentDpesSubmodule = {
    */
   getId(config, consentData, cacheIdObj) {
     return cacheIdObj;
-  }
-
+  },
+  eids: {
+    'deepintentId': {
+      source: 'deepintent.com',
+      atype: 3
+    },
+  },
 };
 
 submodule('userId', deepintentDpesSubmodule);
diff --git a/modules/dmdIdSystem.js b/modules/dmdIdSystem.js
@@ -85,6 +85,12 @@ export const dmdIdSubmodule = {
       };
       return { callback: resp };
     }
+  },
+  eids: {
+    'dmdId': {
+      source: 'hcn.health',
+      atype: 3
+    },
   }
 };
 

diff --git a/modules/euidIdSystem.js b/modules/euidIdSystem.js
@@ -103,6 +103,15 @@ export const euidIdSubmodule = {
     _logInfo(`EUID getId returned`, result);
     return result;
   },
+  eids: {
+    'euid': {
+      source: 'euid.eu',
+      atype: 3,
+      getValue: function(data) {
+        return data.id;
+      }
+    },
+  },
 };
 
 function decodeImpl(value) {

diff --git a/modules/fabrickIdSystem.js b/modules/fabrickIdSystem.js
@@ -117,6 +117,12 @@ export const fabrickIdSubmodule = {
     } catch (e) {
       logError(`fabrickIdSystem encountered an error`, e);
     }
+  },
+  eids: {
+    'fabrickId': {
+      source: 'neustar.biz',
+      atype: 1
+    },
   }
 };
 

diff --git a/modules/ftrackIdSystem.js b/modules/ftrackIdSystem.js
@@ -221,6 +221,22 @@ export const ftrackIdSubmodule = {
     if (usPrivacyVersion == 1 && usPrivacyOptOutSale === 'Y') consentValue = false;
 
     return consentValue;
+  },
+  eids: {
+    'ftrackId': {
+      source: 'flashtalking.com',
+      atype: 1,
+      getValue: function(data) {
+        let value = '';
+        if (data && data.ext && data.ext.DeviceID) {
+          value = data.ext.DeviceID;
+        }
+        return value;
+      },
+      getUidExt: function(data) {
+        return data && data.ext;
+      }
+    },
   }
 };
 

diff --git a/modules/gravitoIdSystem.js b/modules/gravitoIdSystem.js
@@ -53,6 +53,12 @@ export const gravitoIdSystemSubmodule = {
     }
     return undefined;
   },
+  eids: {
+    'gravitompId': {
+      source: 'gravito.net',
+      atype: 1
+    },
+  }
 }
 
 submodule('userId', gravitoIdSystemSubmodule);
diff --git a/modules/growthCodeIdSystem.js b/modules/growthCodeIdSystem.js
@@ -5,7 +5,7 @@
  * @requires module:modules/userId
  */
 
-import {logError, logInfo, tryAppendQueryString} from '../src/utils.js';
+import {logError, logInfo, pick, tryAppendQueryString} from '../src/utils.js';
 import {ajax} from '../src/ajax.js';
 import { submodule } from '../src/hook.js'
 import {getStorageManager} from '../src/storageManager.js';
@@ -166,6 +166,25 @@ export const growthCodeIdSubmodule = {
       }
     };
     return { callback: resp };
+  },
+  eids: {
+    'growthCodeId': {
+      getValue: function(data) {
+        return data.gc_id
+      },
+      source: 'growthcode.io',
+      atype: 1,
+      getUidExt: function(data) {
+        const extendedData = pick(data, [
+          'h1',
+          'h2',
+          'h3',
+        ]);
+        if (Object.keys(extendedData).length) {
+          return extendedData;
+        }
+      }
+    },
   }
 };
 

diff --git a/modules/hadronIdSystem.js b/modules/hadronIdSystem.js
@@ -110,6 +110,12 @@ export const hadronIdSubmodule = {
       ajax(url, callbacks, undefined, {method: 'GET'});
     };
     return {callback: resp};
+  },
+  eids: {
+    'hadronId': {
+      source: 'audigent.com',
+      atype: 1
+    },
   }
 };
 

diff --git a/modules/id5IdSystem.js b/modules/id5IdSystem.js
@@ -154,7 +154,21 @@ export const id5IdSubmodule = {
 
     logInfo(LOG_PREFIX + 'using cached ID', cacheIdObj);
     return cacheIdObj;
-  }
+  },
+  eids: {
+    'id5id': {
+      getValue: function(data) {
+        return data.uid
+      },
+      source: 'id5-sync.com',
+      atype: 1,
+      getUidExt: function(data) {
+        if (data.ext) {
+          return data.ext;
+        }
+      }
+    },
+  },
 };
 
 class IdFetchFlow {

diff --git a/modules/identityLinkIdSystem.js b/modules/identityLinkIdSystem.js
@@ -79,6 +79,12 @@ export const identityLinkSubmodule = {
     };
 
     return { callback: resp };
+  },
+  eids: {
+    'idl_env': {
+      source: 'liveramp.com',
+      atype: 3
+    },
   }
 };
 // return envelope from third party endpoint

diff --git a/modules/idxIdSystem.js b/modules/idxIdSystem.js
@@ -57,6 +57,12 @@ export const idxIdSubmodule = {
       }
     }
     return undefined;
+  },
+  eids: {
+    'idx': {
+      source: 'idx.lat',
+      atype: 1
+    },
   }
 };
 submodule('userId', idxIdSubmodule);
diff --git a/modules/imuIdSystem.js b/modules/imuIdSystem.js
@@ -160,6 +160,16 @@ export const imuIdSubmodule = {
         imppid: localData.ppid
       }
     };
+  },
+  eids: {
+    'imppid': {
+      source: 'ppid.intimatemerger.com',
+      atype: 1
+    },
+    'imuid': {
+      source: 'intimatemerger.com',
+      atype: 1
+    },
   }
 };
 

diff --git a/modules/intentIqIdSystem.js b/modules/intentIqIdSystem.js
@@ -193,6 +193,12 @@ export const intentIqIdSubmodule = {
       }
     };
     return { callback: resp };
+  },
+  eids: {
+    'intentIqId': {
+      source: 'intentiq.com',
+      atype: 1
+    },
   }
 };
 

diff --git a/modules/justIdSystem.js b/modules/justIdSystem.js
@@ -91,6 +91,12 @@ export const justIdSubmodule = {
         }
       }
     };
+  },
+  eids: {
+    'justId': {
+      source: 'justtag.com',
+      atype: 1
+    },
   }
 };
 

diff --git a/modules/kinessoIdSystem.js b/modules/kinessoIdSystem.js
@@ -233,8 +233,13 @@ export const kinessoIdSubmodule = {
     const payloadString = JSON.stringify(kinessoIdPayload);
     ajax(kinessoSyncUrl(accountId, consentData), syncId(knnsoId), payloadString, {method: 'POST', withCredentials: true});
     return {'id': knnsoId};
-  }
-
+  },
+  eids: {
+    'kpuid': {
+      source: 'kpuid.com',
+      atype: 3
+    },
+  },
 };
 
 // Register submodule for userId