Skip to content

Commit

Permalink
revert sharedIdtest removal,merging reworked
Browse files Browse the repository at this point in the history
  • Loading branch information
obernadin committed Jun 3, 2021
1 parent 3b63dd2 commit 8ca32a1
Show file tree
Hide file tree
Showing 5 changed files with 679 additions and 357 deletions.
269 changes: 256 additions & 13 deletions modules/sharedIdSystem.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,170 @@

import * as utils from '../src/utils.js';
import {submodule} from '../src/hook.js';
import { coppaDataHandler } from '../src/adapterManager.js';
import {ajax} from '../src/ajax.js';
import { uspDataHandler, coppaDataHandler } from '../src/adapterManager.js';
import {getStorageManager} from '../src/storageManager.js';

const GVLID = 887;
const storage = getStorageManager(GVLID, 'pubCommonId');
const COOKIE = 'cookie';
const LOCAL_STORAGE = 'html5';
const SHAREDID_OPT_OUT_VALUE = '00000000000000000000000000';
const SHAREDID_URL = 'https://id.sharedid.org/id';
const SHAREDID_SUFFIX = '_sharedid';
const EXPIRED_COOKIE_DATE = 'Thu, 01 Jan 1970 00:00:01 GMT';
const SHAREDID_DEFAULT_STATE = true;

const PUB_COMMON_ID = 'PublisherCommonId';

const GVLID = 887;
/**
* Store sharedid in either cookie or local storage
* @param {Object} config Need config.storage object to derive key, expiry time, and storage type.
* @param {string} value Shareid value to store
*/

function storeData(config, value) {
try {
if (value) {
const key = config.storage.name + SHAREDID_SUFFIX;
const expiresStr = (new Date(Date.now() + (storage.expires * (60 * 60 * 24 * 1000)))).toUTCString();

if (config.storage.type === COOKIE) {
if (storage.cookiesAreEnabled()) {
storage.setCookie(key, value, expiresStr, 'LAX', sharedIdSystemSubmodule.domainOverride());
}
} else if (config.storage.type === LOCAL_STORAGE) {
if (storage.hasLocalStorage()) {
storage.setDataInLocalStorage(`${key}_exp`, expiresStr);
storage.setDataInLocalStorage(key, value);
}
}
}
} catch (error) {
utils.logError(error);
}
}

/**
* Read sharedid from cookie or local storage
* @param config Need config.storage to derive key and storage type
* @return {string}
*/
function readData(config) {
try {
const key = config.storage.name + SHAREDID_SUFFIX;
if (config.storage.type === COOKIE) {
if (storage.cookiesAreEnabled()) {
return storage.getCookie(key);
}
} else if (config.storage.type === LOCAL_STORAGE) {
if (storage.hasLocalStorage()) {
const expValue = storage.getDataFromLocalStorage(`${key}_exp`);
if (!expValue) {
return storage.getDataFromLocalStorage(key);
} else if ((new Date(expValue)).getTime() - Date.now() > 0) {
return storage.getDataFromLocalStorage(key)
}
}
}
} catch (error) {
utils.logError(error);
}
}

/** @type {Submodule} */
/**
* Delete sharedid from cookie or local storage
* @param config Need config.storage to derive key and storage type
*/
function delData(config) {
try {
const key = config.storage.name + SHAREDID_SUFFIX;
if (config.storage.type === COOKIE) {
if (storage.cookiesAreEnabled()) {
storage.setCookie(key, '', EXPIRED_COOKIE_DATE);
}
} else if (config.storage.type === LOCAL_STORAGE) {
storage.removeDataFromLocalStorage(`${key}_exp`);
storage.removeDataFromLocalStorage(key);
}
} catch (error) {
utils.logError(error);
}
}

/**
* setup success and error handler for sharedid callback thru ajax
* @param {string} pubcid Current pubcommon id
* @param {function} callback userId module callback.
* @param {Object} config Need config.storage to derive sharedid storage params
* @return {{success: success, error: error}}
*/

function handleResponse(pubcid, callback, config) {
return {
success: function (responseBody) {
if (responseBody) {
try {
let responseObj = JSON.parse(responseBody);
utils.logInfo('PubCommonId: Generated SharedId: ' + responseObj.sharedId);
if (responseObj.sharedId) {
if (responseObj.sharedId !== SHAREDID_OPT_OUT_VALUE) {
// Store sharedId locally
storeData(config, responseObj.sharedId);
} else {
// Delete local copy if the user has opted out
delData(config);
}
}
// Pass pubcid even though there is no change in order to trigger decode
callback(responseObj.sharedId);
} catch (error) {
utils.logError(error);
}
}
},
error: function (statusText, responseBody) {
utils.logInfo('PubCommonId: failed to get sharedid');
}
}
}

/**
* Builds and returns the shared Id URL with attached consent data if applicable
* @param {Object} consentData
* @return {string}
*/
function sharedIdUrl(consentData) {
const usPrivacyString = uspDataHandler.getConsentData();
let sharedIdUrl = SHAREDID_URL;
if (usPrivacyString && typeof usPrivacyString === 'string') {
sharedIdUrl = `${SHAREDID_URL}?us_privacy=${usPrivacyString}`;
}
if (!consentData || typeof consentData.gdprApplies !== 'boolean' || !consentData.gdprApplies) return sharedIdUrl;
if (usPrivacyString) {
sharedIdUrl = `${sharedIdUrl}&gdpr=1&gdpr_consent=${consentData.consentString}`
return sharedIdUrl;
}
sharedIdUrl = `${SHAREDID_URL}?gdpr=1&gdpr_consent=${consentData.consentString}`;
return sharedIdUrl
}

/**
* Wraps pixelCallback in order to call sharedid sync
* @param {string} pubcid Pubcommon id value
* @param {function|undefined} pixelCallback fires a pixel to first party server
* @param {Object} config Need config.storage to derive sharedid storage params.
* @return {function(...[*]=)}
*/

function getIdCallback(pubcid, pixelCallback, config, consentData) {
return function (callback) {
if (typeof pixelCallback === 'function') {
pixelCallback();
}
ajax(sharedIdUrl(consentData), handleResponse(pubcid, callback, config), undefined, {method: 'GET', withCredentials: true});
}
}
export const sharedIdSystemSubmodule = {
/**
* used to link submodule with config
Expand All @@ -26,12 +183,6 @@ export const sharedIdSystemSubmodule = {
* @type {Number}
*/
gvlid: GVLID,
/**
* Return a callback function that calls the pixelUrl with id as a query parameter
* @param pixelUrl
* @param id
* @returns {function}
*/
makeCallback: function (pixelUrl, id = '') {
if (!pixelUrl) {
return;
Expand All @@ -54,7 +205,15 @@ export const sharedIdSystemSubmodule = {
* @returns {{pubcid:string}}
*/
decode(value, config) {
return {'pubcid': value};
const idObj = {'pubcid': value};
const {params: {enableSharedId = SHAREDID_DEFAULT_STATE} = {}} = config;

if (enableSharedId) {
const sharedId = readData(config);
if (sharedId) idObj['sharedid'] = {id: sharedId};
}

return idObj;
},
/**
* performs action to obtain id
Expand All @@ -67,10 +226,10 @@ export const sharedIdSystemSubmodule = {
getId: function (config = {}, consentData, storedId) {
const coppa = coppaDataHandler.getCoppa();
if (coppa) {
utils.logInfo('SharedId: IDs not provided for coppa requests, exiting SharedId');
utils.logInfo('PubCommonId: IDs not provided for coppa requests, exiting PubCommonId');
return;
}
const {params: {create = true, pixelUrl} = {}} = config;
const {params: {create = true, pixelUrl, enableSharedId = SHAREDID_DEFAULT_STATE} = {}} = config;
let newId = storedId;
if (!newId) {
try {
Expand All @@ -85,9 +244,93 @@ export const sharedIdSystemSubmodule = {
}

const pixelCallback = this.makeCallback(pixelUrl, newId);
const combinedCallback = enableSharedId ? getIdCallback(newId, pixelCallback, config, consentData) : pixelCallback;

return {id: newId, callback: combinedCallback};
},
/**
* performs action to extend an id. There are generally two ways to extend the expiration time
* of stored id: using pixelUrl or return the id and let main user id module write it again with
* the new expiration time.
*
* PixelUrl, if defined, should point back to a first party domain endpoint. On the server
* side, there is either a plugin, or customized logic to read and write back the pubcid cookie.
* The extendId function itself should return only the callback, and not the id itself to avoid
* having the script-side overwriting server-side. This applies to both pubcid and sharedid.
*
* On the other hand, if there is no pixelUrl, then the extendId should return storedId so that
* its expiration time is updated. Sharedid, however, will have to be updated by this submodule
* separately.
*
* @function
* @param {SubmoduleParams} [config]
* @param {ConsentData|undefined} consentData
* @param {Object} storedId existing id
* @returns {IdResponse|undefined}
*/
extendId: function(config = {}, consentData, storedId) {
const coppa = coppaDataHandler.getCoppa();
if (coppa) {
utils.logInfo('PubCommonId: IDs not provided for coppa requests, exiting PubCommonId');
return;
}
const {params: {extend = false, pixelUrl, enableSharedId = SHAREDID_DEFAULT_STATE} = {}} = config;

if (extend) {
try {
if (typeof window[PUB_COMMON_ID] === 'object') {
if (enableSharedId) {
// If the page includes its own pubcid module, then there is nothing to do
// except to update sharedid's expiration time
storeData(config, readData(config));
}
return;
}
} catch (e) {
}

return {id: newId, callback: pixelCallback};
if (pixelUrl) {
const callback = this.makeCallback(pixelUrl, storedId);
return {callback: callback};
} else {
if (enableSharedId) {
// Update with the same value to extend expiration time
storeData(config, readData(config));
}
return {id: storedId};
}
}
},

/**
* @param {string} domain
* @param {HTMLDocument} document
* @return {(string|undefined)}
*/
domainOverride: function () {
const domainElements = document.domain.split('.');
const cookieName = `_gd${Date.now()}`;
for (let i = 0, topDomain, testCookie; i < domainElements.length; i++) {
const nextDomain = domainElements.slice(i).join('.');

// write test cookie
storage.setCookie(cookieName, '1', undefined, undefined, nextDomain);

// read test cookie to verify domain was valid
testCookie = storage.getCookie(cookieName);

// delete test cookie
storage.setCookie(cookieName, '', 'Thu, 01 Jan 1970 00:00:01 GMT', undefined, nextDomain);

if (testCookie === '1') {
// cookie was written successfully using test domain so the topDomain is updated
topDomain = nextDomain;
} else {
// cookie failed to write using test domain so exit by returning the topDomain
return topDomain;
}
}
}
};

submodule('userId', sharedIdSystemSubmodule);
1 change: 1 addition & 0 deletions test/spec/modules/lotamePanoramaIdSystem_spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {
} from 'modules/lotamePanoramaIdSystem.js';
import * as utils from 'src/utils.js';
import { server } from 'test/mocks/xhr.js';
import sinon from 'sinon';

const responseHeader = { 'Content-Type': 'application/json' };

Expand Down
Loading

0 comments on commit 8ca32a1

Please sign in to comment.