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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
|
"use strict";
const { ExperimentFakes } = ChromeUtils.importESModule(
"resource://testing-common/NimbusTestUtils.sys.mjs"
);
const { ExperimentManager } = ChromeUtils.importESModule(
"resource://nimbus/lib/ExperimentManager.sys.mjs"
);
const { RemoteSettingsExperimentLoader, EnrollmentsContext } =
ChromeUtils.importESModule(
"resource://nimbus/lib/RemoteSettingsExperimentLoader.sys.mjs"
);
const { TestUtils } = ChromeUtils.importESModule(
"resource://testing-common/TestUtils.sys.mjs"
);
const ENABLED_PREF = "messaging-system.rsexperimentloader.enabled";
const RUN_INTERVAL_PREF = "app.normandy.run_interval_seconds";
const STUDIES_OPT_OUT_PREF = "app.shield.optoutstudies.enabled";
const UPLOAD_PREF = "datareporting.healthreport.uploadEnabled";
const DEBUG_PREF = "nimbus.debug";
add_task(async function test_real_exp_manager() {
equal(
RemoteSettingsExperimentLoader.manager,
ExperimentManager,
"should reference ExperimentManager singleton by default"
);
});
add_task(async function test_lazy_pref_getters() {
const loader = ExperimentFakes.rsLoader();
sinon.stub(loader, "updateRecipes").resolves();
Services.prefs.setIntPref(RUN_INTERVAL_PREF, 123456);
equal(
loader.intervalInSeconds,
123456,
`should set intervalInSeconds to the value of ${RUN_INTERVAL_PREF}`
);
Services.prefs.setBoolPref(ENABLED_PREF, true);
equal(
loader.enabled,
true,
`should set enabled to the value of ${ENABLED_PREF}`
);
Services.prefs.setBoolPref(ENABLED_PREF, false);
equal(loader.enabled, false);
Services.prefs.clearUserPref(RUN_INTERVAL_PREF);
Services.prefs.clearUserPref(ENABLED_PREF);
});
add_task(async function test_init() {
const loader = ExperimentFakes.rsLoader();
sinon.stub(loader, "setTimer");
sinon.stub(loader, "updateRecipes").resolves();
Services.prefs.setBoolPref(ENABLED_PREF, false);
await loader.init();
equal(
loader.setTimer.callCount,
0,
`should not initialize if ${ENABLED_PREF} pref is false`
);
Services.prefs.setBoolPref(ENABLED_PREF, true);
await loader.init();
ok(loader.setTimer.calledOnce, "should call .setTimer");
ok(loader.updateRecipes.calledOnce, "should call .updatpickeRecipes");
});
add_task(async function test_init_with_opt_in() {
const loader = ExperimentFakes.rsLoader();
sinon.stub(loader, "setTimer");
sinon.stub(loader, "updateRecipes").resolves();
Services.prefs.setBoolPref(STUDIES_OPT_OUT_PREF, false);
await loader.init();
equal(
loader.setTimer.callCount,
0,
`should not initialize if ${STUDIES_OPT_OUT_PREF} pref is false`
);
Services.prefs.setBoolPref(ENABLED_PREF, false);
await loader.init();
equal(
loader.setTimer.callCount,
0,
`should not initialize if ${ENABLED_PREF} pref is false`
);
Services.prefs.setBoolPref(STUDIES_OPT_OUT_PREF, true);
Services.prefs.setBoolPref(ENABLED_PREF, true);
await loader.init();
ok(loader.setTimer.calledOnce, "should call .setTimer");
ok(loader.updateRecipes.calledOnce, "should call .updateRecipes");
});
add_task(async function test_updateRecipes() {
const loader = ExperimentFakes.rsLoader();
const PASS_FILTER_RECIPE = ExperimentFakes.recipe("foo", {
targeting: "true",
});
const FAIL_FILTER_RECIPE = ExperimentFakes.recipe("foo", {
targeting: "false",
});
sinon.stub(loader, "setTimer");
sinon.spy(loader, "updateRecipes");
sinon
.stub(loader.remoteSettingsClient, "get")
.resolves([PASS_FILTER_RECIPE, FAIL_FILTER_RECIPE]);
sinon.stub(loader.manager, "onRecipe").resolves();
sinon.stub(loader.manager, "onFinalize");
Services.prefs.setBoolPref(ENABLED_PREF, true);
await loader.init();
ok(loader.updateRecipes.calledOnce, "should call .updateRecipes");
equal(
loader.manager.onRecipe.callCount,
1,
"should call .onRecipe only for recipes that pass"
);
ok(
loader.manager.onRecipe.calledWith(PASS_FILTER_RECIPE, "rs-loader"),
"should call .onRecipe with argument data"
);
});
add_task(async function test_updateRecipes_someMismatch() {
const loader = ExperimentFakes.rsLoader();
const PASS_FILTER_RECIPE = ExperimentFakes.recipe("foo", {
targeting: "true",
});
const FAIL_FILTER_RECIPE = ExperimentFakes.recipe("foo", {
targeting: "false",
});
sinon.stub(loader, "setTimer");
sinon.spy(loader, "updateRecipes");
sinon
.stub(loader.remoteSettingsClient, "get")
.resolves([PASS_FILTER_RECIPE, FAIL_FILTER_RECIPE]);
sinon.stub(loader.manager, "onRecipe").resolves();
sinon.stub(loader.manager, "onFinalize");
Services.prefs.setBoolPref(ENABLED_PREF, true);
await loader.init();
ok(loader.updateRecipes.calledOnce, "should call .updateRecipes");
equal(
loader.manager.onRecipe.callCount,
1,
"should call .onRecipe only for recipes that pass"
);
ok(loader.manager.onFinalize.calledOnce, "Should call onFinalize.");
ok(
onFinalizeCalled(loader.manager.onFinalize, "rs-loader", {
recipeMismatches: [FAIL_FILTER_RECIPE.slug],
invalidRecipes: [],
invalidBranches: new Map(),
invalidFeatures: new Map(),
missingL10nIds: new Map(),
missingLocale: [],
locale: Services.locale.appLocaleAsBCP47,
validationEnabled: true,
}),
"should call .onFinalize with the recipes that failed targeting"
);
});
add_task(async function test_updateRecipes_forFirstStartup() {
const loader = ExperimentFakes.rsLoader();
const PASS_FILTER_RECIPE = ExperimentFakes.recipe("foo", {
targeting: "isFirstStartup",
});
sinon.stub(loader.remoteSettingsClient, "get").resolves([PASS_FILTER_RECIPE]);
sinon.stub(loader.manager, "onRecipe").resolves();
sinon.stub(loader.manager, "onFinalize");
sinon
.stub(loader.manager, "createTargetingContext")
.returns({ isFirstStartup: true });
Services.prefs.setBoolPref(ENABLED_PREF, true);
await loader.init({ isFirstStartup: true });
ok(loader.manager.onRecipe.calledOnce, "should pass the targeting filter");
});
add_task(async function test_updateRecipes_forNoneFirstStartup() {
const loader = ExperimentFakes.rsLoader();
const PASS_FILTER_RECIPE = ExperimentFakes.recipe("foo", {
targeting: "isFirstStartup",
});
sinon.stub(loader.remoteSettingsClient, "get").resolves([PASS_FILTER_RECIPE]);
sinon.stub(loader.manager, "onRecipe").resolves();
sinon.stub(loader.manager, "onFinalize");
sinon
.stub(loader.manager, "createTargetingContext")
.returns({ isFirstStartup: false });
Services.prefs.setBoolPref(ENABLED_PREF, true);
await loader.init({ isFirstStartup: true });
ok(loader.manager.onRecipe.notCalled, "should not pass the targeting filter");
});
add_task(async function test_checkTargeting() {
const loader = ExperimentFakes.rsLoader();
const ctx = new EnrollmentsContext(loader.manager);
equal(
await ctx.checkTargeting({}),
true,
"should return true if .targeting is not defined"
);
equal(
await ctx.checkTargeting({
targeting: "'foo'",
slug: "test_checkTargeting",
}),
true,
"should return true for truthy expression"
);
equal(
await ctx.checkTargeting({
targeting: "aPropertyThatDoesNotExist",
slug: "test_checkTargeting",
}),
false,
"should return false for falsey expression"
);
});
add_task(async function test_checkExperimentSelfReference() {
const loader = ExperimentFakes.rsLoader();
const ctx = new EnrollmentsContext(loader.manager);
const PASS_FILTER_RECIPE = ExperimentFakes.recipe("foo", {
targeting:
"experiment.slug == 'foo' && experiment.branches[0].slug == 'control'",
});
const FAIL_FILTER_RECIPE = ExperimentFakes.recipe("foo", {
targeting: "experiment.slug == 'bar'",
});
equal(
await ctx.checkTargeting(PASS_FILTER_RECIPE),
true,
"Should return true for matching on slug name and branch"
);
equal(
await ctx.checkTargeting(FAIL_FILTER_RECIPE),
false,
"Should fail targeting"
);
});
add_task(async function test_optIn_debug_disabled() {
info("Testing users cannot opt-in when nimbus.debug is false");
const loader = ExperimentFakes.rsLoader();
sinon.stub(loader, "setTimer");
sinon.stub(loader, "updateRecipes").resolves();
const recipe = ExperimentFakes.recipe("foo");
sinon.stub(loader.remoteSettingsClient, "get").resolves([recipe]);
Services.prefs.setBoolPref(DEBUG_PREF, false);
Services.prefs.setBoolPref(UPLOAD_PREF, true);
Services.prefs.setBoolPref(STUDIES_OPT_OUT_PREF, true);
await Assert.rejects(
loader.optInToExperiment({
slug: recipe.slug,
branchSlug: recipe.branches[0].slug,
}),
/Could not opt in/
);
Services.prefs.clearUserPref(DEBUG_PREF);
Services.prefs.clearUserPref(UPLOAD_PREF);
Services.prefs.clearUserPref(STUDIES_OPT_OUT_PREF);
});
add_task(async function test_optIn_studies_disabled() {
info(
"Testing users cannot opt-in when telemetry is disabled or studies are disabled."
);
const prefs = [UPLOAD_PREF, STUDIES_OPT_OUT_PREF];
const loader = ExperimentFakes.rsLoader();
sinon.stub(loader, "setTimer");
sinon.stub(loader, "updateRecipes").resolves();
const recipe = ExperimentFakes.recipe("foo");
sinon.stub(loader.remoteSettingsClient, "get").resolves([recipe]);
Services.prefs.setBoolPref(DEBUG_PREF, true);
for (const pref of prefs) {
Services.prefs.setBoolPref(UPLOAD_PREF, true);
Services.prefs.setBoolPref(STUDIES_OPT_OUT_PREF, true);
Services.prefs.setBoolPref(pref, false);
await Assert.rejects(
loader.optInToExperiment({
slug: recipe.slug,
branchSlug: recipe.branches[0].slug,
}),
/Could not opt in: studies are disabled/
);
}
Services.prefs.clearUserPref(DEBUG_PREF);
Services.prefs.clearUserPref(UPLOAD_PREF);
Services.prefs.clearUserPref(STUDIES_OPT_OUT_PREF);
});
add_task(async function test_enrollment_changed_notification() {
const loader = ExperimentFakes.rsLoader();
const PASS_FILTER_RECIPE = ExperimentFakes.recipe("foo", {
targeting: "true",
});
sinon.stub(loader, "setTimer");
sinon.spy(loader, "updateRecipes");
const enrollmentChanged = TestUtils.topicObserved(
"nimbus:enrollments-updated"
);
sinon.stub(loader.remoteSettingsClient, "get").resolves([PASS_FILTER_RECIPE]);
sinon.stub(loader.manager, "onRecipe").resolves();
sinon.stub(loader.manager, "onFinalize");
Services.prefs.setBoolPref(ENABLED_PREF, true);
await loader.init();
await enrollmentChanged;
ok(loader.updateRecipes.called, "should call .updateRecipes");
});
|
