forked from prebid/Prebid.js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Prebid core: enrich FPD by default (prebid#9205)
* Move rootDomain * Move FPD enrichments to core * Remove fpdEnrichments module * Cleanup * Add `site`, `device`, and coppa enrichments * FPD enrichments: GDPR * FPD enrichments: USP * Enrich FPD from requestBids * Fix typo in package.json
- Loading branch information
1 parent
bace818
commit 57f4f62
Showing
24 changed files
with
751 additions
and
965 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,190 +1,2 @@ | ||
|
|
||
| /** | ||
| * This module sets default values and validates ortb2 first part data | ||
| * @module modules/firstPartyData | ||
| */ | ||
| import { timestamp, mergeDeep } from '../src/utils.js'; | ||
| import { submodule } from '../src/hook.js'; | ||
| import {getRefererInfo, parseDomain} from '../src/refererDetection.js'; | ||
| import { getCoreStorageManager } from '../src/storageManager.js'; | ||
| import {GreedyPromise} from '../src/utils/promise.js'; | ||
| import {getHighEntropySUA, getLowEntropySUA} from '../libraries/fpd/sua.js'; | ||
|
|
||
| let ortb2; | ||
| let win = (window === window.top) ? window : window.top; | ||
| export const coreStorage = getCoreStorageManager('enrichmentFpd'); | ||
|
|
||
| export const sua = {he: getHighEntropySUA, le: getLowEntropySUA}; | ||
|
|
||
| /** | ||
| * Find the root domain | ||
| * @param {string|undefined} fullDomain | ||
| * @return {string} | ||
| */ | ||
| export function findRootDomain(fullDomain = window.location.hostname) { | ||
| if (!coreStorage.cookiesAreEnabled()) { | ||
| return fullDomain; | ||
| } | ||
|
|
||
| const domainParts = fullDomain.split('.'); | ||
| if (domainParts.length == 2) { | ||
| return fullDomain; | ||
| } | ||
| let rootDomain; | ||
| let continueSearching; | ||
| let startIndex = -2; | ||
| const TEST_COOKIE_NAME = `_rdc${Date.now()}`; | ||
| const TEST_COOKIE_VALUE = 'writeable'; | ||
| do { | ||
| rootDomain = domainParts.slice(startIndex).join('.'); | ||
| let expirationDate = new Date(timestamp() + 10 * 1000).toUTCString(); | ||
|
|
||
| // Write a test cookie | ||
| coreStorage.setCookie( | ||
| TEST_COOKIE_NAME, | ||
| TEST_COOKIE_VALUE, | ||
| expirationDate, | ||
| 'Lax', | ||
| rootDomain, | ||
| undefined | ||
| ); | ||
|
|
||
| // See if the write was successful | ||
| const value = coreStorage.getCookie(TEST_COOKIE_NAME, undefined); | ||
| if (value === TEST_COOKIE_VALUE) { | ||
| continueSearching = false; | ||
| // Delete our test cookie | ||
| coreStorage.setCookie( | ||
| TEST_COOKIE_NAME, | ||
| '', | ||
| 'Thu, 01 Jan 1970 00:00:01 GMT', | ||
| undefined, | ||
| rootDomain, | ||
| undefined | ||
| ); | ||
| } else { | ||
| startIndex += -1; | ||
| continueSearching = Math.abs(startIndex) <= domainParts.length; | ||
| } | ||
| } while (continueSearching); | ||
| return rootDomain; | ||
| } | ||
|
|
||
| /** | ||
| * Checks for referer and if exists merges into ortb2 global data | ||
| */ | ||
| function setReferer() { | ||
| if (getRefererInfo().ref) mergeDeep(ortb2, { site: { ref: getRefererInfo().ref } }); | ||
| } | ||
|
|
||
| /** | ||
| * Checks for canonical url and if exists merges into ortb2 global data | ||
| */ | ||
| function setPage() { | ||
| if (getRefererInfo().page) mergeDeep(ortb2, { site: { page: getRefererInfo().page } }); | ||
| } | ||
|
|
||
| /** | ||
| * Checks for canonical url and if exists retrieves domain and merges into ortb2 global data | ||
| */ | ||
| function setDomain() { | ||
| const domain = parseDomain(getRefererInfo().page, {noLeadingWww: true}); | ||
| if (domain) { | ||
| mergeDeep(ortb2, { site: { domain: domain } }); | ||
| mergeDeep(ortb2, { site: { publisher: { domain: findRootDomain(domain) } } }); | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Checks for screen/device width and height and sets dimensions | ||
| */ | ||
| function setDimensions() { | ||
| let width; | ||
| let height; | ||
|
|
||
| try { | ||
| width = win.innerWidth || win.document.documentElement.clientWidth || win.document.body.clientWidth; | ||
| height = win.innerHeight || win.document.documentElement.clientHeight || win.document.body.clientHeight; | ||
| } catch (e) { | ||
| width = window.innerWidth || window.document.documentElement.clientWidth || window.document.body.clientWidth; | ||
| height = window.innerHeight || window.document.documentElement.clientHeight || window.document.body.clientHeight; | ||
| } | ||
|
|
||
| mergeDeep(ortb2, { device: { w: width, h: height } }); | ||
| } | ||
|
|
||
| /** | ||
| * Scans page for meta keywords, and if exists, merges into site.keywords | ||
| */ | ||
| function setKeywords() { | ||
| let keywords; | ||
|
|
||
| try { | ||
| keywords = win.document.querySelector("meta[name='keywords']"); | ||
| } catch (e) { | ||
| keywords = window.document.querySelector("meta[name='keywords']"); | ||
| } | ||
|
|
||
| if (keywords && keywords.content) mergeDeep(ortb2, { site: { keywords: keywords.content.replace(/\s/g, '') } }); | ||
| } | ||
|
|
||
| function setDeviceSua(hints) { | ||
| let data = Array.isArray(hints) && hints.length === 0 | ||
| ? GreedyPromise.resolve(sua.le()) | ||
| : sua.he(hints); | ||
| return data.then((sua) => { | ||
| if (sua != null) { | ||
| mergeDeep(ortb2, {device: {sua}}); | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| /** | ||
| * Checks the Global Privacy Control status, and if exists and is true, merges into regs.ext.gpc | ||
| */ | ||
| function setGpc() { | ||
| const gpcValue = navigator.globalPrivacyControl; | ||
| if (gpcValue) { | ||
| mergeDeep(ortb2, { regs: { ext: { gpc: 1 } } }) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Resets modules global ortb2 data | ||
| */ | ||
| export const resetEnrichments = () => { ortb2 = null }; | ||
|
|
||
| function runEnrichments(fpdConf) { | ||
| setReferer(); | ||
| setPage(); | ||
| setDomain(); | ||
| setDimensions(); | ||
| setKeywords(); | ||
| setGpc(); | ||
| return setDeviceSua(fpdConf.uaHints).then(() => ortb2); | ||
| } | ||
|
|
||
| export function processFpd(fpdConf, {global}) { | ||
| if (fpdConf.skipEnrichments) { | ||
| return {global}; | ||
| } else { | ||
| let ready; | ||
| if (ortb2 == null) { | ||
| ortb2 = {}; | ||
| ready = runEnrichments(fpdConf); | ||
| } else { | ||
| ready = GreedyPromise.resolve(); | ||
| } | ||
| return ready.then(() => ({ | ||
| global: mergeDeep({}, ortb2, global) | ||
| })) | ||
| } | ||
| } | ||
| /** @type {firstPartyDataSubmodule} */ | ||
| export const enrichmentsSubmodule = { | ||
| name: 'enrichments', | ||
| queue: 2, | ||
| processFpd | ||
| } | ||
|
|
||
| submodule('firstPartyData', enrichmentsSubmodule) | ||
| // Logic from this module was moved into core since approx. 7.27 | ||
| // TODO: remove this in v8 |
Oops, something went wrong.