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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
|
"use strict";
const { Sampling } = ChromeUtils.importESModule(
"resource://gre/modules/components-utils/Sampling.sys.mjs"
);
const { ClientEnvironment } = ChromeUtils.importESModule(
"resource://normandy/lib/ClientEnvironment.sys.mjs"
);
const { cleanupStorePrefCache } = ExperimentFakes;
const { ExperimentStore } = ChromeUtils.importESModule(
"resource://nimbus/lib/ExperimentStore.sys.mjs"
);
const { TelemetryEnvironment } = ChromeUtils.importESModule(
"resource://gre/modules/TelemetryEnvironment.sys.mjs"
);
const { TelemetryEvents } = ChromeUtils.importESModule(
"resource://normandy/lib/TelemetryEvents.sys.mjs"
);
const { SYNC_DATA_PREF_BRANCH, SYNC_DEFAULTS_PREF_BRANCH } = ExperimentStore;
const globalSandbox = sinon.createSandbox();
globalSandbox.spy(TelemetryEnvironment, "setExperimentInactive");
globalSandbox.spy(TelemetryEvents, "sendEvent");
registerCleanupFunction(() => {
globalSandbox.restore();
});
/**
* FOG requires a little setup in order to test it
*/
add_setup(function test_setup() {
// FOG needs a profile directory to put its data in.
do_get_profile();
// FOG needs to be initialized in order for data to flow.
Services.fog.initializeFOG();
});
/**
* The normal case: Enrollment of a new experiment
*/
add_task(async function test_add_to_store() {
const manager = ExperimentFakes.manager();
const recipe = ExperimentFakes.recipe("foo");
const enrollPromise = new Promise(resolve =>
manager.store.on("update:foo", resolve)
);
await manager.onStartup();
await manager.enroll(recipe, "test_add_to_store");
await enrollPromise;
const experiment = manager.store.get("foo");
Assert.ok(experiment, "should add an experiment with slug foo");
Assert.ok(
recipe.branches.includes(experiment.branch),
"should choose a branch from the recipe.branches"
);
Assert.equal(experiment.active, true, "should set .active = true");
manager.unenroll("foo", "test-cleanup");
await assertEmptyStore(manager.store);
});
add_task(async function test_add_rollout_to_store() {
const manager = ExperimentFakes.manager();
const recipe = {
...ExperimentFakes.recipe("rollout-slug"),
branches: [ExperimentFakes.rollout("rollout").branch],
isRollout: true,
active: true,
bucketConfig: {
namespace: "nimbus-test-utils",
randomizationUnit: "normandy_id",
start: 0,
count: 1000,
total: 1000,
},
};
const enrollPromise = new Promise(resolve =>
manager.store.on("update:rollout-slug", resolve)
);
await manager.onStartup();
await manager.enroll(recipe, "test_add_rollout_to_store");
await enrollPromise;
const experiment = manager.store.get("rollout-slug");
Assert.ok(experiment, `Should add an experiment with slug ${recipe.slug}`);
Assert.ok(
recipe.branches.includes(experiment.branch),
"should choose a branch from the recipe.branches"
);
Assert.equal(experiment.isRollout, true, "should have .isRollout");
manager.unenroll("rollout-slug", "test-cleanup");
await assertEmptyStore(manager.store);
});
add_task(
async function test_setExperimentActive_sendEnrollmentTelemetry_called() {
const manager = ExperimentFakes.manager();
const sandbox = sinon.createSandbox();
const enrollPromise = new Promise(resolve =>
manager.store.on("update:foo", resolve)
);
sandbox.spy(manager, "setExperimentActive");
sandbox.spy(manager, "sendEnrollmentTelemetry");
// Clear any pre-existing data in Glean
Services.fog.testResetFOG();
await manager.onStartup();
// Ensure there is no experiment active with the id in FOG
Assert.equal(
undefined,
Services.fog.testGetExperimentData("foo"),
"no active experiment exists before enrollment"
);
// Check that there aren't any Glean enrollment events yet
var enrollmentEvents = Glean.nimbusEvents.enrollment.testGetValue();
Assert.equal(
undefined,
enrollmentEvents,
"no Glean enrollment events before enrollment"
);
await manager.enroll(
ExperimentFakes.recipe("foo"),
"test_setExperimentActive_sendEnrollmentTelemetry_called"
);
await enrollPromise;
const experiment = manager.store.get("foo");
Assert.equal(
manager.setExperimentActive.calledWith(experiment),
true,
"should call setExperimentActive after an enrollment"
);
Assert.equal(
manager.sendEnrollmentTelemetry.calledWith(experiment),
true,
"should call sendEnrollmentTelemetry after an enrollment"
);
// Test Glean experiment API interaction
Assert.notEqual(
undefined,
Services.fog.testGetExperimentData(experiment.slug),
"Glean.setExperimentActive called with `foo` feature"
);
// Check that the Glean enrollment event was recorded.
enrollmentEvents = Glean.nimbusEvents.enrollment.testGetValue();
// We expect only one event
Assert.equal(1, enrollmentEvents.length);
// And that one event matches the expected enrolled experiment
Assert.equal(
experiment.slug,
enrollmentEvents[0].extra.experiment,
"Glean.nimbusEvents.enrollment recorded with correct experiment slug"
);
Assert.equal(
experiment.branch.slug,
enrollmentEvents[0].extra.branch,
"Glean.nimbusEvents.enrollment recorded with correct branch slug"
);
Assert.equal(
experiment.experimentType,
enrollmentEvents[0].extra.experiment_type,
"Glean.nimbusEvents.enrollment recorded with correct experiment type"
);
manager.unenroll("foo", "test-cleanup");
await assertEmptyStore(manager.store);
}
);
add_task(async function test_setRolloutActive_sendEnrollmentTelemetry_called() {
globalSandbox.reset();
globalSandbox.spy(TelemetryEnvironment, "setExperimentActive");
globalSandbox.spy(TelemetryEvents.sendEvent);
const manager = ExperimentFakes.manager();
const sandbox = sinon.createSandbox();
const rolloutRecipe = {
...ExperimentFakes.recipe("rollout"),
branches: [ExperimentFakes.rollout("rollout").branch],
isRollout: true,
};
const enrollPromise = new Promise(resolve =>
manager.store.on("update:rollout", resolve)
);
sandbox.spy(manager, "setExperimentActive");
sandbox.spy(manager, "sendEnrollmentTelemetry");
// Clear any pre-existing data in Glean
Services.fog.testResetFOG();
await manager.onStartup();
// Test Glean experiment API interaction
Assert.equal(
undefined,
Services.fog.testGetExperimentData("rollout"),
"no rollout active before enrollment"
);
// Check that there aren't any Glean enrollment events yet
var enrollmentEvents = Glean.nimbusEvents.enrollment.testGetValue();
Assert.equal(
undefined,
enrollmentEvents,
"no Glean enrollment events before enrollment"
);
let result = await manager.enroll(
rolloutRecipe,
"test_setRolloutActive_sendEnrollmentTelemetry_called"
);
await enrollPromise;
const enrollment = manager.store.get("rollout");
Assert.ok(!!result && !!enrollment, "Enrollment was successful");
Assert.equal(
TelemetryEnvironment.setExperimentActive.called,
true,
"should call setExperimentActive"
);
Assert.ok(
manager.setExperimentActive.calledWith(enrollment),
"Should call setExperimentActive with the rollout"
);
Assert.equal(
manager.setExperimentActive.firstCall.args[0].experimentType,
"rollout",
"Should have the correct experimentType"
);
Assert.equal(
manager.sendEnrollmentTelemetry.calledWith(enrollment),
true,
"should call sendEnrollmentTelemetry after an enrollment"
);
Assert.ok(
TelemetryEvents.sendEvent.calledOnce,
"Should send out enrollment telemetry"
);
Assert.ok(
TelemetryEvents.sendEvent.calledWith(
"enroll",
sinon.match.string,
enrollment.slug,
{
experimentType: "rollout",
branch: enrollment.branch.slug,
}
),
"Should send telemetry with expected values"
);
// Test Glean experiment API interaction
Assert.equal(
enrollment.branch.slug,
Services.fog.testGetExperimentData(enrollment.slug).branch,
"Glean.setExperimentActive called with expected values"
);
// Check that the Glean enrollment event was recorded.
enrollmentEvents = Glean.nimbusEvents.enrollment.testGetValue();
// We expect only one event
Assert.equal(1, enrollmentEvents.length);
// And that one event matches the expected enrolled experiment
Assert.equal(
enrollment.slug,
enrollmentEvents[0].extra.experiment,
"Glean.nimbusEvents.enrollment recorded with correct experiment slug"
);
Assert.equal(
enrollment.branch.slug,
enrollmentEvents[0].extra.branch,
"Glean.nimbusEvents.enrollment recorded with correct branch slug"
);
Assert.equal(
enrollment.experimentType,
enrollmentEvents[0].extra.experiment_type,
"Glean.nimbusEvents.enrollment recorded with correct experiment type"
);
manager.unenroll("rollout", "test-cleanup");
await assertEmptyStore(manager.store);
globalSandbox.restore();
});
// /**
// * Failure cases:
// * - slug conflict
// * - group conflict
// */
add_task(async function test_failure_name_conflict() {
const manager = ExperimentFakes.manager();
const sandbox = sinon.createSandbox();
sandbox.spy(manager, "sendFailureTelemetry");
// Clear any pre-existing data in Glean
Services.fog.testResetFOG();
await manager.onStartup();
// Check that there aren't any Glean enroll_failed events yet
var failureEvents = Glean.nimbusEvents.enrollFailed.testGetValue();
Assert.equal(
undefined,
failureEvents,
"no Glean enroll_failed events before failure"
);
// simulate adding a previouly enrolled experiment
await manager.store.addEnrollment(ExperimentFakes.experiment("foo"));
await Assert.rejects(
manager.enroll(ExperimentFakes.recipe("foo"), "test_failure_name_conflict"),
/An experiment with the slug "foo" already exists/,
"should throw if a conflicting experiment exists"
);
Assert.equal(
manager.sendFailureTelemetry.calledWith(
"enrollFailed",
"foo",
"name-conflict"
),
true,
"should send failure telemetry if a conflicting experiment exists"
);
// Check that the Glean enrollment event was recorded.
failureEvents = Glean.nimbusEvents.enrollFailed.testGetValue();
// We expect only one event
Assert.equal(1, failureEvents.length);
// And that one event matches the expected enrolled experiment
Assert.equal(
"foo",
failureEvents[0].extra.experiment,
"Glean.nimbusEvents.enroll_failed recorded with correct experiment slug"
);
Assert.equal(
"name-conflict",
failureEvents[0].extra.reason,
"Glean.nimbusEvents.enroll_failed recorded with correct reason"
);
manager.unenroll("foo", "test-cleanup");
await assertEmptyStore(manager.store);
});
add_task(async function test_failure_group_conflict() {
const manager = ExperimentFakes.manager();
const sandbox = sinon.createSandbox();
sandbox.spy(manager, "sendFailureTelemetry");
// Clear any pre-existing data in Glean
Services.fog.testResetFOG();
await manager.onStartup();
// Check that there aren't any Glean enroll_failed events yet
var failureEvents = Glean.nimbusEvents.enrollFailed.testGetValue();
Assert.equal(
undefined,
failureEvents,
"no Glean enroll_failed events before failure"
);
// Two conflicting branches that both have the group "pink"
// These should not be allowed to exist simultaneously.
const existingBranch = {
slug: "treatment",
features: [{ featureId: "pink", value: {} }],
};
const newBranch = {
slug: "treatment",
features: [{ featureId: "pink", value: {} }],
};
// simulate adding an experiment with a conflicting group "pink"
await manager.store.addEnrollment(
ExperimentFakes.experiment("foo", {
branch: existingBranch,
})
);
// ensure .enroll chooses the special branch with the conflict
sandbox.stub(manager, "chooseBranch").returns(newBranch);
Assert.equal(
await manager.enroll(
ExperimentFakes.recipe("bar", { branches: [newBranch] }),
"test_failure_group_conflict"
),
null,
"should not enroll if there is a feature conflict"
);
Assert.equal(
manager.sendFailureTelemetry.calledWith(
"enrollFailed",
"bar",
"feature-conflict"
),
true,
"should send failure telemetry if a feature conflict exists"
);
// Check that the Glean enroll_failed event was recorded.
failureEvents = Glean.nimbusEvents.enrollFailed.testGetValue();
// We expect only one event
Assert.equal(1, failureEvents.length);
// And that event matches the expected experiment and reason
Assert.equal(
"bar",
failureEvents[0].extra.experiment,
"Glean.nimbusEvents.enroll_failed recorded with correct experiment slug"
);
Assert.equal(
"feature-conflict",
failureEvents[0].extra.reason,
"Glean.nimbusEvents.enroll_failed recorded with correct reason"
);
manager.unenroll("foo", "test-cleanup");
await assertEmptyStore(manager.store);
});
add_task(async function test_rollout_failure_group_conflict() {
const manager = ExperimentFakes.manager();
const sandbox = sinon.createSandbox();
const rollout = ExperimentFakes.rollout("rollout-enrollment");
const recipe = {
...ExperimentFakes.recipe("rollout-recipe"),
branches: [rollout.branch],
isRollout: true,
};
sandbox.spy(manager, "sendFailureTelemetry");
// Clear any pre-existing data in Glean
Services.fog.testResetFOG();
await manager.onStartup();
// Check that there aren't any Glean enroll_failed events yet
var failureEvents = Glean.nimbusEvents.enrollFailed.testGetValue();
Assert.equal(
undefined,
failureEvents,
"no Glean enroll_failed events before failure"
);
// simulate adding an experiment with a conflicting group "pink"
await manager.store.addEnrollment(rollout);
Assert.equal(
await manager.enroll(recipe, "test_rollout_failure_group_conflict"),
null,
"should not enroll if there is a feature conflict"
);
Assert.equal(
manager.sendFailureTelemetry.calledWith(
"enrollFailed",
recipe.slug,
"feature-conflict"
),
true,
"should send failure telemetry if a feature conflict exists"
);
// Check that the Glean enroll_failed event was recorded.
failureEvents = Glean.nimbusEvents.enrollFailed.testGetValue();
// We expect only one event
Assert.equal(1, failureEvents.length);
// And that event matches the expected experiment and reason
Assert.equal(
recipe.slug,
failureEvents[0].extra.experiment,
"Glean.nimbusEvents.enroll_failed recorded with correct experiment slug"
);
Assert.equal(
"feature-conflict",
failureEvents[0].extra.reason,
"Glean.nimbusEvents.enroll_failed recorded with correct reason"
);
manager.unenroll("rollout-enrollment", "test-cleanup");
await assertEmptyStore(manager.store);
});
add_task(async function test_rollout_experiment_no_conflict() {
const manager = ExperimentFakes.manager();
const sandbox = sinon.createSandbox();
const experiment = ExperimentFakes.recipe("experiment");
const rollout = ExperimentFakes.recipe("rollout", { isRollout: true });
sandbox.spy(manager, "sendFailureTelemetry");
// Clear any pre-existing data in Glean
Services.fog.testResetFOG();
await manager.onStartup();
// Check that there aren't any Glean enroll_failed events yet
var failureEvents = Glean.nimbusEvents.enrollFailed.testGetValue();
Assert.equal(
undefined,
failureEvents,
"no Glean enroll_failed events before failure"
);
await ExperimentFakes.enrollmentHelper(experiment, {
manager,
}).enrollmentPromise;
await ExperimentFakes.enrollmentHelper(rollout, {
manager,
}).enrollmentPromise;
Assert.ok(
manager.store.get(experiment.slug).active,
"Enrolled in the experiment for the feature"
);
Assert.ok(
manager.store.get(rollout.slug).active,
"Enrolled in the rollout for the feature"
);
Assert.ok(
manager.sendFailureTelemetry.notCalled,
"Should send failure telemetry if a feature conflict exists"
);
// Check that there aren't any Glean enroll_failed events
failureEvents = Glean.nimbusEvents.enrollFailed.testGetValue();
Assert.equal(
undefined,
failureEvents,
"no Glean enroll_failed events before failure"
);
await ExperimentFakes.cleanupAll([experiment.slug, rollout.slug], {
manager,
});
await assertEmptyStore(manager.store);
});
add_task(async function test_sampling_check() {
const manager = ExperimentFakes.manager();
let recipe = ExperimentFakes.recipe("foo", { bucketConfig: null });
const sandbox = sinon.createSandbox();
sandbox.stub(Sampling, "bucketSample").resolves(true);
sandbox.replaceGetter(ClientEnvironment, "userId", () => 42);
Assert.ok(
!manager.isInBucketAllocation(recipe.bucketConfig),
"fails for no bucket config"
);
recipe = ExperimentFakes.recipe("foo2", {
bucketConfig: { randomizationUnit: "foo" },
});
Assert.ok(
!manager.isInBucketAllocation(recipe.bucketConfig),
"fails for unknown randomizationUnit"
);
recipe = ExperimentFakes.recipe("foo3");
const result = await manager.isInBucketAllocation(recipe.bucketConfig);
Assert.equal(
Sampling.bucketSample.callCount,
1,
"it should call bucketSample"
);
Assert.ok(result, "result should be true");
const { args } = Sampling.bucketSample.firstCall;
Assert.equal(args[0][0], 42, "called with expected randomization id");
Assert.equal(
args[0][1],
recipe.bucketConfig.namespace,
"called with expected namespace"
);
Assert.equal(
args[1],
recipe.bucketConfig.start,
"called with expected start"
);
Assert.equal(
args[2],
recipe.bucketConfig.count,
"called with expected count"
);
Assert.equal(
args[3],
recipe.bucketConfig.total,
"called with expected total"
);
await assertEmptyStore(manager.store);
sandbox.reset();
});
add_task(async function enroll_in_reference_aw_experiment() {
cleanupStorePrefCache();
let dir = Services.dirsvc.get("CurWorkD", Ci.nsIFile).path;
let src = PathUtils.join(
dir,
"reference_aboutwelcome_experiment_content.json"
);
const content = await IOUtils.readJSON(src);
// Create two dummy branches with the content from disk
const branches = ["treatment-a", "treatment-b"].map(slug => ({
slug,
ratio: 1,
features: [
{ value: { ...content, enabled: true }, featureId: "aboutwelcome" },
],
}));
let recipe = ExperimentFakes.recipe("reference-aw", { branches });
// Ensure we get enrolled
recipe.bucketConfig.count = recipe.bucketConfig.total;
const manager = ExperimentFakes.manager();
const enrollPromise = new Promise(resolve =>
manager.store.on("update:reference-aw", resolve)
);
await manager.onStartup();
await manager.enroll(recipe, "enroll_in_reference_aw_experiment");
await enrollPromise;
Assert.ok(manager.store.get("reference-aw"), "Successful onboarding");
let prefValue = Services.prefs.getStringPref(
`${SYNC_DATA_PREF_BRANCH}aboutwelcome`
);
Assert.ok(
prefValue,
"aboutwelcome experiment enrollment should be stored to prefs"
);
// In case some regression causes us to store a significant amount of data
// in prefs.
Assert.ok(prefValue.length < 3498, "Make sure we don't bloat the prefs");
manager.unenroll(recipe.slug, "enroll_in_reference_aw_experiment:cleanup");
manager.store._deleteForTests("aboutwelcome");
await assertEmptyStore(manager.store);
});
add_task(async function test_forceEnroll_cleanup() {
const manager = ExperimentFakes.manager();
const sandbox = sinon.createSandbox();
const fooEnrollPromise = new Promise(resolve =>
manager.store.on("update:foo", resolve)
);
const barEnrollPromise = new Promise(resolve =>
manager.store.on("update:optin-bar", resolve)
);
let unenrollStub = sandbox.spy(manager, "unenroll");
let existingRecipe = ExperimentFakes.recipe("foo", {
branches: [
{
slug: "treatment",
ratio: 1,
features: [{ featureId: "force-enrollment", value: {} }],
},
],
});
let forcedRecipe = ExperimentFakes.recipe("bar", {
branches: [
{
slug: "treatment",
ratio: 1,
features: [{ featureId: "force-enrollment", value: {} }],
},
],
});
await manager.onStartup();
await manager.enroll(existingRecipe, "test_forceEnroll_cleanup");
await fooEnrollPromise;
let setExperimentActiveSpy = sandbox.spy(manager, "setExperimentActive");
manager.forceEnroll(forcedRecipe, forcedRecipe.branches[0]);
await barEnrollPromise;
Assert.ok(unenrollStub.called, "Unenrolled from existing experiment");
Assert.equal(
unenrollStub.firstCall.args[0],
existingRecipe.slug,
"Called with existing recipe slug"
);
Assert.ok(setExperimentActiveSpy.calledOnce, "Activated forced experiment");
Assert.equal(
setExperimentActiveSpy.firstCall.args[0].slug,
`optin-${forcedRecipe.slug}`,
"Called with forced experiment slug"
);
Assert.equal(
manager.store.getExperimentForFeature("force-enrollment").slug,
`optin-${forcedRecipe.slug}`,
"Enrolled in forced experiment"
);
manager.unenroll(`optin-${forcedRecipe.slug}`, "test-cleanup");
await assertEmptyStore(manager.store);
sandbox.restore();
});
add_task(async function test_rollout_unenroll_conflict() {
const manager = ExperimentFakes.manager();
const sandbox = sinon.createSandbox();
let unenrollStub = sandbox.stub(manager, "unenroll").returns(true);
let enrollStub = sandbox.stub(manager, "_enroll").returns(true);
let rollout = ExperimentFakes.rollout("rollout_conflict");
// We want to force a conflict
sandbox.stub(manager.store, "getRolloutForFeature").returns(rollout);
manager.forceEnroll(rollout, rollout.branch);
Assert.ok(unenrollStub.calledOnce, "Should unenroll the conflicting rollout");
Assert.ok(
unenrollStub.calledWith(rollout.slug, "force-enrollment"),
"Should call with expected slug"
);
Assert.ok(enrollStub.calledOnce, "Should call enroll as expected");
await assertEmptyStore(manager.store);
sandbox.restore();
});
add_task(async function test_forceEnroll() {
const experiment1 = ExperimentFakes.recipe("experiment-1");
const experiment2 = ExperimentFakes.recipe("experiment-2");
const rollout1 = ExperimentFakes.recipe("rollout-1", { isRollout: true });
const rollout2 = ExperimentFakes.recipe("rollout-2", { isRollout: true });
const TEST_CASES = [
{
enroll: [experiment1, rollout1],
expected: [experiment1, rollout1],
},
{
enroll: [rollout1, experiment1],
expected: [experiment1, rollout1],
},
{
enroll: [experiment1, experiment2],
expected: [experiment2],
},
{
enroll: [rollout1, rollout2],
expected: [rollout2],
},
{
enroll: [experiment1, rollout1, rollout2, experiment2],
expected: [experiment2, rollout2],
},
];
async function forceEnroll(manager, recipe) {
const enrollmentPromise = new Promise(resolve => {
manager.store.on(`update:optin-${recipe.slug}`, resolve);
});
manager.forceEnroll(recipe, recipe.branches[0]);
return enrollmentPromise;
}
const loader = ExperimentFakes.rsLoader();
const manager = loader.manager;
sinon
.stub(loader.remoteSettingsClient, "get")
.resolves([experiment1, experiment2, rollout1, rollout2]);
sinon.stub(loader, "setTimer");
await loader.init();
await manager.onStartup();
for (const { enroll, expected } of TEST_CASES) {
for (const recipe of enroll) {
await forceEnroll(manager, recipe);
}
const activeSlugs = manager.store
.getAll()
.filter(enrollment => enrollment.active)
.map(r => r.slug);
Assert.equal(
activeSlugs.length,
expected.length,
`Should be enrolled in ${expected.length} experiments and rollouts`
);
for (const { slug, isRollout } of expected) {
Assert.ok(
activeSlugs.includes(`optin-${slug}`),
`Should be enrolled in ${
isRollout ? "rollout" : "experiment"
} with slug optin-${slug}`
);
}
for (const { slug } of expected) {
manager.unenroll(`optin-${slug}`);
manager.store._deleteForTests(`optin-${slug}`);
}
}
await assertEmptyStore(manager.store);
});
add_task(async function test_featureIds_is_stored() {
Services.prefs.setStringPref("messaging-system.log", "all");
const recipe = ExperimentFakes.recipe("featureIds");
// Ensure we get enrolled
recipe.bucketConfig.count = recipe.bucketConfig.total;
const store = ExperimentFakes.store();
const manager = ExperimentFakes.manager(store);
await manager.onStartup();
const { enrollmentPromise, doExperimentCleanup } =
ExperimentFakes.enrollmentHelper(recipe, { manager });
await enrollmentPromise;
Assert.ok(manager.store.addEnrollment.calledOnce, "experiment is stored");
let [enrollment] = manager.store.addEnrollment.firstCall.args;
Assert.ok("featureIds" in enrollment, "featureIds is stored");
Assert.deepEqual(
enrollment.featureIds,
["testFeature"],
"Has expected value"
);
await doExperimentCleanup();
await assertEmptyStore(manager.store);
});
add_task(async function experiment_and_rollout_enroll_and_cleanup() {
let store = ExperimentFakes.store();
const manager = ExperimentFakes.manager(store);
await manager.onStartup();
let rolloutCleanup = await ExperimentFakes.enrollWithRollout(
{
featureId: "aboutwelcome",
value: { enabled: true },
},
{
manager,
}
);
let experimentCleanup = await ExperimentFakes.enrollWithFeatureConfig(
{
featureId: "aboutwelcome",
value: { enabled: true },
},
{ manager }
);
Assert.ok(
Services.prefs.getBoolPref(`${SYNC_DATA_PREF_BRANCH}aboutwelcome.enabled`)
);
Assert.ok(
Services.prefs.getBoolPref(
`${SYNC_DEFAULTS_PREF_BRANCH}aboutwelcome.enabled`
)
);
await experimentCleanup();
Assert.ok(
!Services.prefs.getBoolPref(
`${SYNC_DATA_PREF_BRANCH}aboutwelcome.enabled`,
false
)
);
Assert.ok(
Services.prefs.getBoolPref(
`${SYNC_DEFAULTS_PREF_BRANCH}aboutwelcome.enabled`
)
);
await rolloutCleanup();
Assert.ok(
!Services.prefs.getBoolPref(
`${SYNC_DATA_PREF_BRANCH}aboutwelcome.enabled`,
false
)
);
Assert.ok(
!Services.prefs.getBoolPref(
`${SYNC_DEFAULTS_PREF_BRANCH}aboutwelcome.enabled`,
false
)
);
await assertEmptyStore(manager.store);
});
add_task(async function test_reEnroll() {
const store = ExperimentFakes.store();
const manager = ExperimentFakes.manager(store);
await manager.onStartup();
await manager.store.ready();
const experiment = ExperimentFakes.recipe("experiment");
experiment.bucketConfig = {
...experiment.bucketConfig,
start: 0,
count: 1000,
total: 1000,
};
const rollout = ExperimentFakes.recipe("rollout", { isRollout: true });
rollout.bucketConfig = {
...rollout.bucketConfig,
start: 0,
count: 1000,
total: 1000,
};
await manager.enroll(experiment, "test");
Assert.equal(
manager.store.getExperimentForFeature("testFeature")?.slug,
experiment.slug,
"Should enroll in experiment"
);
await manager.enroll(rollout, "test");
Assert.equal(
manager.store.getRolloutForFeature("testFeature")?.slug,
rollout.slug,
"Should enroll in rollout"
);
manager.unenroll(experiment.slug);
Assert.ok(
!manager.store.getExperimentForFeature("testFeature"),
"Should unenroll from experiment"
);
manager.unenroll(rollout.slug);
Assert.ok(
!manager.store.getRolloutForFeature("testFeature"),
"Should unenroll from rollout"
);
await Assert.rejects(
manager.enroll(experiment, "test", { reenroll: true }),
/An experiment with the slug "experiment" already exists/,
"Should not re-enroll in experiment"
);
await manager.enroll(rollout, "test", { reenroll: true });
Assert.equal(
manager.store.getRolloutForFeature("testFeature")?.slug,
rollout.slug,
"Should re-enroll in rollout"
);
manager.unenroll(rollout.slug);
await assertEmptyStore(store);
});
|