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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
import { AppConstants } from "resource://gre/modules/AppConstants.sys.mjs";
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
ASRouterTargeting:
// eslint-disable-next-line mozilla/no-browser-refs-in-toolkit
"resource:///modules/asrouter/ASRouterTargeting.sys.mjs",
ClientEnvironment: "resource://normandy/lib/ClientEnvironment.sys.mjs",
ClientEnvironmentBase:
"resource://gre/modules/components-utils/ClientEnvironment.sys.mjs",
FilterExpressions:
"resource://gre/modules/components-utils/FilterExpressions.sys.mjs",
TelemetryEnvironment: "resource://gre/modules/TelemetryEnvironment.sys.mjs",
clearTimeout: "resource://gre/modules/Timer.sys.mjs",
setTimeout: "resource://gre/modules/Timer.sys.mjs",
});
const TARGETING_EVENT_CATEGORY = "messaging_experiments";
const TARGETING_EVENT_METHOD = "targeting";
const DEFAULT_TIMEOUT = 5000;
const ERROR_TYPES = {
ATTRIBUTE_ERROR: "attribute_error",
TIMEOUT: "attribute_timeout",
};
const TargetingEnvironment = {
get locale() {
return lazy.ASRouterTargeting.Environment.locale;
},
get localeLanguageCode() {
return lazy.ASRouterTargeting.Environment.localeLanguageCode;
},
get region() {
return lazy.ASRouterTargeting.Environment.region;
},
get userId() {
return lazy.ClientEnvironment.userId;
},
get version() {
return AppConstants.MOZ_APP_VERSION_DISPLAY;
},
get channel() {
const { settings } = lazy.TelemetryEnvironment.currentEnvironment;
return settings.update.channel;
},
get platform() {
return AppConstants.platform;
},
get os() {
return lazy.ClientEnvironmentBase.os;
},
};
export class TargetingContext {
#telemetrySource = null;
constructor(customContext, options = { source: null }) {
if (customContext) {
this.ctx = new Proxy(customContext, {
get: (customCtx, prop) => {
if (prop in TargetingEnvironment) {
return TargetingEnvironment[prop];
}
return customCtx[prop];
},
});
} else {
this.ctx = TargetingEnvironment;
}
// Used in telemetry to report where the targeting expression is coming from
this.#telemetrySource = options.source;
// Enable event recording
Services.telemetry.setEventRecordingEnabled(TARGETING_EVENT_CATEGORY, true);
}
setTelemetrySource(source) {
if (source) {
this.#telemetrySource = source;
}
}
_sendUndesiredEvent(eventData) {
if (this.#telemetrySource) {
Services.telemetry.recordEvent(
TARGETING_EVENT_CATEGORY,
TARGETING_EVENT_METHOD,
eventData.event,
eventData.value,
{ source: this.#telemetrySource }
);
} else {
Services.telemetry.recordEvent(
TARGETING_EVENT_CATEGORY,
TARGETING_EVENT_METHOD,
eventData.event,
eventData.value
);
}
}
/**
* Wrap each property of context[key] with a Proxy that captures errors and
* timeouts
*
* @param {Object.<string, TargetingGetters> | TargetingGetters} context
* @param {string} key Namespace value found in `context` param
* @returns {TargetingGetters} Wrapped context where getter report errors and timeouts
*/
createContextWithTimeout(context, key = null) {
const timeoutDuration = key ? context[key].timeout : context.timeout;
const logUndesiredEvent = (event, key, prop) => {
const value = key ? `${key}.${prop}` : prop;
this._sendUndesiredEvent({ event, value });
console.error(`${event}: ${value}`);
};
return new Proxy(context, {
get(target, prop) {
// eslint-disable-next-line no-async-promise-executor
return new Promise(async (resolve, reject) => {
// Create timeout cb to record attribute resolution taking too long.
let timeout = lazy.setTimeout(() => {
logUndesiredEvent(ERROR_TYPES.TIMEOUT, key, prop);
reject(
new Error(
`${prop} targeting getter timed out after ${
timeoutDuration || DEFAULT_TIMEOUT
}ms`
)
);
}, timeoutDuration || DEFAULT_TIMEOUT);
try {
resolve(await (key ? target[key][prop] : target[prop]));
} catch (error) {
logUndesiredEvent(ERROR_TYPES.ATTRIBUTE_ERROR, key, prop);
reject(error);
console.error(error);
} finally {
lazy.clearTimeout(timeout);
}
});
},
});
}
/**
* Merge all evaluation contexts and wrap the getters with timeouts
*
* @param {Object.<string, TargetingGetters>[]} contexts
* @returns {Object.<string, TargetingGetters>} Object that follows the pattern of `namespace: getters`
*/
mergeEvaluationContexts(contexts) {
let context = {};
for (let c of contexts) {
for (let envNamespace of Object.keys(c)) {
// Take the provided context apart, replace it with a proxy
context[envNamespace] = this.createContextWithTimeout(c, envNamespace);
}
}
return context;
}
/**
* Merge multiple TargetingGetters objects without accidentally evaluating
*
* @param {TargetingGetters[]} ...contexts
* @returns {Proxy<TargetingGetters>}
*/
static combineContexts(...contexts) {
return new Proxy(
{},
{
get(target, prop) {
for (let context of contexts) {
if (prop in context) {
return context[prop];
}
}
return null;
},
}
);
}
/**
* Evaluate JEXL expressions with default `TargetingEnvironment` and custom
* provided targeting contexts
*
* @example
* eval(
* "ctx.locale == 'en-US' && customCtx.foo == 42",
* { customCtx: { foo: 42 } }
* ); // true
*
* @param {string} expression JEXL expression
* @param {Object.<string, TargetingGetters>[]} ...contexts Additional custom context
* objects where the keys act as namespaces for the different getters
*
* @returns {promise} Evaluation result
*/
eval(expression, ...contexts) {
return lazy.FilterExpressions.eval(
expression,
this.mergeEvaluationContexts([{ ctx: this.ctx }, ...contexts])
);
}
/**
* Evaluate JEXL expressions with default provided targeting context
*
* @example
* new TargetingContext({ bar: 42 });
* evalWithDefault(
* "bar == 42",
* ); // true
*
* @param {string} expression JEXL expression
* @returns {promise} Evaluation result
*/
evalWithDefault(expression) {
return lazy.FilterExpressions.eval(
expression,
this.createContextWithTimeout(this.ctx)
);
}
}
|
