-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
enrichment.js
158 lines (140 loc) · 4.76 KB
/
enrichment.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
import {hook} from '../hook.js';
import {getRefererInfo, parseDomain} from '../refererDetection.js';
import {findRootDomain} from './rootDomain.js';
import {deepSetValue, getDefinedParams, getDNT, getWindowSelf, getWindowTop, mergeDeep} from '../utils.js';
import {config} from '../config.js';
import {getHighEntropySUA, getLowEntropySUA} from './sua.js';
import {GreedyPromise} from '../utils/promise.js';
import {CLIENT_SECTIONS, clientSectionChecker, hasSection} from './oneClient.js';
import {isActivityAllowed} from '../activities/rules.js';
import {activityParams} from '../activities/activityParams.js';
import {ACTIVITY_ACCESS_DEVICE} from '../activities/activities.js';
import {MODULE_TYPE_PREBID} from '../activities/modules.js';
export const dep = {
getRefererInfo,
findRootDomain,
getWindowTop,
getWindowSelf,
getHighEntropySUA,
getLowEntropySUA,
};
const oneClient = clientSectionChecker('FPD')
/**
* Enrich an ortb2 object with first-party data.
* @param {Promise<Object>} fpd - A promise that resolves to an ortb2 object.
* @returns {Promise<Object>} - A promise that resolves to an enriched ortb2 object.
*/
export const enrichFPD = hook('sync', (fpd) => {
const promArr = [fpd, getSUA().catch(() => null), tryToGetCdepLabel().catch(() => null)];
return GreedyPromise.all(promArr)
.then(([ortb2, sua, cdep]) => {
const ri = dep.getRefererInfo();
mergeLegacySetConfigs(ortb2);
Object.entries(ENRICHMENTS).forEach(([section, getEnrichments]) => {
const data = getEnrichments(ortb2, ri);
if (data && Object.keys(data).length > 0) {
ortb2[section] = mergeDeep({}, data, ortb2[section]);
}
});
if (sua) {
deepSetValue(ortb2, 'device.sua', Object.assign({}, sua, ortb2.device.sua));
}
if (cdep) {
const ext = {
cdep
}
deepSetValue(ortb2, 'device.ext', Object.assign({}, ext, ortb2.device.ext));
}
ortb2 = oneClient(ortb2);
for (let section of CLIENT_SECTIONS) {
if (hasSection(ortb2, section)) {
ortb2[section] = mergeDeep({}, clientEnrichment(ortb2, ri), ortb2[section]);
break;
}
}
return ortb2;
});
});
function mergeLegacySetConfigs(ortb2) {
// merge in values from "legacy" setConfig({app, site, device})
// TODO: deprecate these eventually
['app', 'site', 'device'].forEach(prop => {
const cfg = config.getConfig(prop);
if (cfg != null) {
ortb2[prop] = mergeDeep({}, cfg, ortb2[prop]);
}
})
}
function winFallback(fn) {
try {
return fn(dep.getWindowTop());
} catch (e) {
return fn(dep.getWindowSelf());
}
}
function getSUA() {
const hints = config.getConfig('firstPartyData.uaHints');
return !Array.isArray(hints) || hints.length === 0
? GreedyPromise.resolve(dep.getLowEntropySUA())
: dep.getHighEntropySUA(hints);
}
function removeUndef(obj) {
return getDefinedParams(obj, Object.keys(obj))
}
function tryToGetCdepLabel() {
return GreedyPromise.resolve('cookieDeprecationLabel' in navigator && isActivityAllowed(ACTIVITY_ACCESS_DEVICE, activityParams(MODULE_TYPE_PREBID, 'cdep')) && navigator.cookieDeprecationLabel.getValue());
}
const ENRICHMENTS = {
site(ortb2, ri) {
if (CLIENT_SECTIONS.filter(p => p !== 'site').some(hasSection.bind(null, ortb2))) {
// do not enrich site if dooh or app are set
return;
}
return removeUndef({
page: ri.page,
ref: ri.ref,
});
},
device() {
return winFallback((win) => {
const w = win.innerWidth || win.document.documentElement.clientWidth || win.document.body.clientWidth;
const h = win.innerHeight || win.document.documentElement.clientHeight || win.document.body.clientHeight;
const device = {
w,
h,
dnt: getDNT() ? 1 : 0,
ua: win.navigator.userAgent,
language: win.navigator.language.split('-').shift(),
};
if (win.navigator?.webdriver) {
deepSetValue(device, 'ext.webdriver', true);
}
return device;
})
},
regs() {
const regs = {};
if (winFallback((win) => win.navigator.globalPrivacyControl)) {
deepSetValue(regs, 'ext.gpc', 1);
}
const coppa = config.getConfig('coppa');
if (typeof coppa === 'boolean') {
regs.coppa = coppa ? 1 : 0;
}
return regs;
}
};
// Enrichment of properties common across dooh, app and site - will be dropped into whatever
// section is appropriate
function clientEnrichment(ortb2, ri) {
const domain = parseDomain(ri.page, {noLeadingWww: true});
const keywords = winFallback((win) => win.document.querySelector('meta[name=\'keywords\']'))
?.content?.replace?.(/\s/g, '');
return removeUndef({
domain,
keywords,
publisher: removeUndef({
domain: dep.findRootDomain(domain)
})
})
}