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
|
import { CONTENT_MESSAGE_TYPE } from "common/Actions.sys.mjs";
import { ActivityStream, PREFS_CONFIG } from "lib/ActivityStream.jsm";
import { GlobalOverrider } from "test/unit/utils";
import { DEFAULT_SITES } from "lib/DefaultSites.sys.mjs";
import { AboutPreferences } from "lib/AboutPreferences.jsm";
import { DefaultPrefs } from "lib/ActivityStreamPrefs.jsm";
import { NewTabInit } from "lib/NewTabInit.jsm";
import { SectionsFeed } from "lib/SectionsManager.jsm";
import { RecommendationProvider } from "lib/RecommendationProvider.jsm";
import { PlacesFeed } from "lib/PlacesFeed.jsm";
import { PrefsFeed } from "lib/PrefsFeed.jsm";
import { SystemTickFeed } from "lib/SystemTickFeed.jsm";
import { TelemetryFeed } from "lib/TelemetryFeed.jsm";
import { FaviconFeed } from "lib/FaviconFeed.jsm";
import { TopSitesFeed } from "lib/TopSitesFeed.jsm";
import { TopStoriesFeed } from "lib/TopStoriesFeed.jsm";
import { HighlightsFeed } from "lib/HighlightsFeed.jsm";
import { DiscoveryStreamFeed } from "lib/DiscoveryStreamFeed.jsm";
import { LinksCache } from "lib/LinksCache.sys.mjs";
import { PersistentCache } from "lib/PersistentCache.sys.mjs";
import { DownloadsManager } from "lib/DownloadsManager.jsm";
describe("ActivityStream", () => {
let sandbox;
let as;
function FakeStore() {
return { init: () => {}, uninit: () => {}, feeds: { get: () => {} } };
}
let globals;
beforeEach(() => {
globals = new GlobalOverrider();
globals.set({
Store: FakeStore,
DEFAULT_SITES,
AboutPreferences,
DefaultPrefs,
NewTabInit,
SectionsFeed,
RecommendationProvider,
PlacesFeed,
PrefsFeed,
SystemTickFeed,
TelemetryFeed,
FaviconFeed,
TopSitesFeed,
TopStoriesFeed,
HighlightsFeed,
DiscoveryStreamFeed,
LinksCache,
PersistentCache,
DownloadsManager,
});
as = new ActivityStream();
sandbox = sinon.createSandbox();
sandbox.stub(as.store, "init");
sandbox.stub(as.store, "uninit");
sandbox.stub(as._defaultPrefs, "init");
PREFS_CONFIG.get("feeds.system.topstories").value = undefined;
});
afterEach(() => {
sandbox.restore();
globals.restore();
});
it("should exist", () => {
assert.ok(ActivityStream);
});
it("should initialize with .initialized=false", () => {
assert.isFalse(as.initialized, ".initialized");
});
describe("#init", () => {
beforeEach(() => {
as.init();
});
it("should initialize default prefs", () => {
assert.calledOnce(as._defaultPrefs.init);
});
it("should set .initialized to true", () => {
assert.isTrue(as.initialized, ".initialized");
});
it("should call .store.init", () => {
assert.calledOnce(as.store.init);
});
it("should pass to Store an INIT event for content", () => {
as.init();
const [, action] = as.store.init.firstCall.args;
assert.equal(action.meta.to, CONTENT_MESSAGE_TYPE);
});
it("should pass to Store an UNINIT event", () => {
as.init();
const [, , action] = as.store.init.firstCall.args;
assert.equal(action.type, "UNINIT");
});
it("should clear old default discoverystream config pref", () => {
sandbox.stub(global.Services.prefs, "prefHasUserValue").returns(true);
sandbox
.stub(global.Services.prefs, "getStringPref")
.returns(
`{"api_key_pref":"extensions.pocket.oAuthConsumerKey","enabled":false,"show_spocs":true,"layout_endpoint":"https://getpocket.cdn.mozilla.net/v3/newtab/layout?version=1&consumer_key=$apiKey&layout_variant=basic"}`
);
sandbox.stub(global.Services.prefs, "clearUserPref");
as.init();
assert.calledWith(
global.Services.prefs.clearUserPref,
"browser.newtabpage.activity-stream.discoverystream.config"
);
});
it("should call addObserver for the app locales", () => {
sandbox.stub(global.Services.obs, "addObserver");
as.init();
assert.calledWith(
global.Services.obs.addObserver,
as,
"intl:app-locales-changed"
);
});
});
describe("#uninit", () => {
beforeEach(() => {
as.init();
as.uninit();
});
it("should set .initialized to false", () => {
assert.isFalse(as.initialized, ".initialized");
});
it("should call .store.uninit", () => {
assert.calledOnce(as.store.uninit);
});
it("should call removeObserver for the region", () => {
sandbox.stub(global.Services.obs, "removeObserver");
as.geo = "";
as.uninit();
assert.calledWith(
global.Services.obs.removeObserver,
as,
global.Region.REGION_TOPIC
);
});
it("should call removeObserver for the app locales", () => {
sandbox.stub(global.Services.obs, "removeObserver");
as.uninit();
assert.calledWith(
global.Services.obs.removeObserver,
as,
"intl:app-locales-changed"
);
});
});
describe("#observe", () => {
it("should call _updateDynamicPrefs from observe", () => {
sandbox.stub(as, "_updateDynamicPrefs");
as.observe(undefined, global.Region.REGION_TOPIC);
assert.calledOnce(as._updateDynamicPrefs);
});
});
describe("feeds", () => {
it("should create a NewTabInit feed", () => {
const feed = as.feeds.get("feeds.newtabinit")();
assert.ok(feed, "feed should exist");
});
it("should create a Places feed", () => {
const feed = as.feeds.get("feeds.places")();
assert.ok(feed, "feed should exist");
});
it("should create a TopSites feed", () => {
const feed = as.feeds.get("feeds.system.topsites")();
assert.ok(feed, "feed should exist");
});
it("should create a Telemetry feed", () => {
const feed = as.feeds.get("feeds.telemetry")();
assert.ok(feed, "feed should exist");
});
it("should create a Prefs feed", () => {
const feed = as.feeds.get("feeds.prefs")();
assert.ok(feed, "feed should exist");
});
it("should create a HighlightsFeed feed", () => {
const feed = as.feeds.get("feeds.section.highlights")();
assert.ok(feed, "feed should exist");
});
it("should create a TopStoriesFeed feed", () => {
const feed = as.feeds.get("feeds.system.topstories")();
assert.ok(feed, "feed should exist");
});
it("should create a AboutPreferences feed", () => {
const feed = as.feeds.get("feeds.aboutpreferences")();
assert.ok(feed, "feed should exist");
});
it("should create a SectionsFeed", () => {
const feed = as.feeds.get("feeds.sections")();
assert.ok(feed, "feed should exist");
});
it("should create a SystemTick feed", () => {
const feed = as.feeds.get("feeds.systemtick")();
assert.ok(feed, "feed should exist");
});
it("should create a Favicon feed", () => {
const feed = as.feeds.get("feeds.favicon")();
assert.ok(feed, "feed should exist");
});
it("should create a RecommendationProvider feed", () => {
const feed = as.feeds.get("feeds.recommendationprovider")();
assert.ok(feed, "feed should exist");
});
it("should create a DiscoveryStreamFeed feed", () => {
const feed = as.feeds.get("feeds.discoverystreamfeed")();
assert.ok(feed, "feed should exist");
});
});
describe("_migratePref", () => {
it("should migrate a pref if the user has set a custom value", () => {
sandbox.stub(global.Services.prefs, "prefHasUserValue").returns(true);
sandbox.stub(global.Services.prefs, "getPrefType").returns("integer");
sandbox.stub(global.Services.prefs, "getIntPref").returns(10);
as._migratePref("oldPrefName", result => assert.equal(10, result));
});
it("should not migrate a pref if the user has not set a custom value", () => {
// we bailed out early so we don't check the pref type later
sandbox.stub(global.Services.prefs, "prefHasUserValue").returns(false);
sandbox.stub(global.Services.prefs, "getPrefType");
as._migratePref("oldPrefName");
assert.notCalled(global.Services.prefs.getPrefType);
});
it("should use the proper pref getter for each type", () => {
sandbox.stub(global.Services.prefs, "prefHasUserValue").returns(true);
// Integer
sandbox.stub(global.Services.prefs, "getIntPref");
sandbox.stub(global.Services.prefs, "getPrefType").returns("integer");
as._migratePref("oldPrefName", () => {});
assert.calledWith(global.Services.prefs.getIntPref, "oldPrefName");
// Boolean
sandbox.stub(global.Services.prefs, "getBoolPref");
global.Services.prefs.getPrefType.returns("boolean");
as._migratePref("oldPrefName", () => {});
assert.calledWith(global.Services.prefs.getBoolPref, "oldPrefName");
// String
sandbox.stub(global.Services.prefs, "getStringPref");
global.Services.prefs.getPrefType.returns("string");
as._migratePref("oldPrefName", () => {});
assert.calledWith(global.Services.prefs.getStringPref, "oldPrefName");
});
it("should clear the old pref after setting the new one", () => {
sandbox.stub(global.Services.prefs, "prefHasUserValue").returns(true);
sandbox.stub(global.Services.prefs, "clearUserPref");
sandbox.stub(global.Services.prefs, "getPrefType").returns("integer");
as._migratePref("oldPrefName", () => {});
assert.calledWith(global.Services.prefs.clearUserPref, "oldPrefName");
});
});
describe("discoverystream.region-basic-layout config", () => {
let getStringPrefStub;
beforeEach(() => {
getStringPrefStub = sandbox.stub(global.Services.prefs, "getStringPref");
sandbox.stub(global.Region, "home").get(() => "CA");
sandbox
.stub(global.Services.locale, "appLocaleAsBCP47")
.get(() => "en-CA");
});
it("should enable 7 row layout pref if no basic config is set and no geo is set", () => {
getStringPrefStub
.withArgs(
"browser.newtabpage.activity-stream.discoverystream.region-basic-config"
)
.returns("");
sandbox.stub(global.Region, "home").get(() => "");
as._updateDynamicPrefs();
assert.isFalse(
PREFS_CONFIG.get("discoverystream.region-basic-layout").value
);
});
it("should enable 1 row layout pref based on region layout pref", () => {
getStringPrefStub
.withArgs(
"browser.newtabpage.activity-stream.discoverystream.region-basic-config"
)
.returns("CA");
as._updateDynamicPrefs();
assert.isTrue(
PREFS_CONFIG.get("discoverystream.region-basic-layout").value
);
});
it("should enable 7 row layout pref based on region layout pref", () => {
getStringPrefStub
.withArgs(
"browser.newtabpage.activity-stream.discoverystream.region-basic-config"
)
.returns("");
as._updateDynamicPrefs();
assert.isFalse(
PREFS_CONFIG.get("discoverystream.region-basic-layout").value
);
});
});
describe("_updateDynamicPrefs topstories default value", () => {
let getVariableStub;
let getBoolPrefStub;
let appLocaleAsBCP47Stub;
beforeEach(() => {
getVariableStub = sandbox.stub(
global.NimbusFeatures.pocketNewtab,
"getVariable"
);
appLocaleAsBCP47Stub = sandbox.stub(
global.Services.locale,
"appLocaleAsBCP47"
);
getBoolPrefStub = sandbox.stub(global.Services.prefs, "getBoolPref");
getBoolPrefStub
.withArgs("browser.newtabpage.activity-stream.feeds.section.topstories")
.returns(true);
appLocaleAsBCP47Stub.get(() => "en-US");
sandbox.stub(global.Region, "home").get(() => "US");
getVariableStub.withArgs("regionStoriesConfig").returns("US,CA");
});
it("should be false with no geo/locale", () => {
appLocaleAsBCP47Stub.get(() => "");
sandbox.stub(global.Region, "home").get(() => "");
as._updateDynamicPrefs();
assert.isFalse(PREFS_CONFIG.get("feeds.system.topstories").value);
});
it("should be false with no geo but an allowed locale", () => {
appLocaleAsBCP47Stub.get(() => "");
sandbox.stub(global.Region, "home").get(() => "");
appLocaleAsBCP47Stub.get(() => "en-US");
getVariableStub
.withArgs("localeListConfig")
.returns("en-US,en-CA,en-GB")
// We only have this pref set to trigger a close to real situation.
.withArgs(
"browser.newtabpage.activity-stream.discoverystream.region-stories-block"
)
.returns("FR");
as._updateDynamicPrefs();
assert.isFalse(PREFS_CONFIG.get("feeds.system.topstories").value);
});
it("should be false with unexpected geo", () => {
sandbox.stub(global.Region, "home").get(() => "NOGEO");
as._updateDynamicPrefs();
assert.isFalse(PREFS_CONFIG.get("feeds.system.topstories").value);
});
it("should be false with expected geo and unexpected locale", () => {
appLocaleAsBCP47Stub.get(() => "no-LOCALE");
as._updateDynamicPrefs();
assert.isFalse(PREFS_CONFIG.get("feeds.system.topstories").value);
});
it("should be true with expected geo and locale", () => {
as._updateDynamicPrefs();
assert.isTrue(PREFS_CONFIG.get("feeds.system.topstories").value);
});
it("should be false after expected geo and locale then unexpected", () => {
sandbox
.stub(global.Region, "home")
.onFirstCall()
.get(() => "US")
.onSecondCall()
.get(() => "NOGEO");
as._updateDynamicPrefs();
as._updateDynamicPrefs();
assert.isFalse(PREFS_CONFIG.get("feeds.system.topstories").value);
});
it("should be true with updated pref change", () => {
appLocaleAsBCP47Stub.get(() => "en-GB");
sandbox.stub(global.Region, "home").get(() => "GB");
getVariableStub.withArgs("regionStoriesConfig").returns("GB");
as._updateDynamicPrefs();
assert.isTrue(PREFS_CONFIG.get("feeds.system.topstories").value);
});
it("should be true with allowed locale in non US region", () => {
appLocaleAsBCP47Stub.get(() => "en-CA");
sandbox.stub(global.Region, "home").get(() => "DE");
getVariableStub.withArgs("localeListConfig").returns("en-US,en-CA,en-GB");
as._updateDynamicPrefs();
assert.isTrue(PREFS_CONFIG.get("feeds.system.topstories").value);
});
});
describe("_updateDynamicPrefs topstories delayed default value", () => {
let clock;
beforeEach(() => {
clock = sinon.useFakeTimers();
// Have addObserver cause prefHasUserValue to now return true then observe
sandbox
.stub(global.Services.obs, "addObserver")
.callsFake((pref, obs) => {
setTimeout(() => {
Services.obs.notifyObservers("US", "browser-region-updated");
});
});
});
afterEach(() => clock.restore());
it("should set false with unexpected geo", () => {
sandbox
.stub(global.Services.prefs, "getStringPref")
.withArgs("browser.search.region")
.returns("NOGEO");
as._updateDynamicPrefs();
clock.tick(1);
assert.isFalse(PREFS_CONFIG.get("feeds.system.topstories").value);
});
it("should set true with expected geo and locale", () => {
sandbox
.stub(global.NimbusFeatures.pocketNewtab, "getVariable")
.withArgs("regionStoriesConfig")
.returns("US");
sandbox.stub(global.Services.prefs, "getBoolPref").returns(true);
sandbox
.stub(global.Services.locale, "appLocaleAsBCP47")
.get(() => "en-US");
as._updateDynamicPrefs();
clock.tick(1);
assert.isTrue(PREFS_CONFIG.get("feeds.system.topstories").value);
});
it("should not change default even with expected geo and locale", () => {
as._defaultPrefs.set("feeds.system.topstories", false);
sandbox
.stub(global.Services.prefs, "getStringPref")
.withArgs(
"browser.newtabpage.activity-stream.discoverystream.region-stories-config"
)
.returns("US");
sandbox
.stub(global.Services.locale, "appLocaleAsBCP47")
.get(() => "en-US");
as._updateDynamicPrefs();
clock.tick(1);
assert.isFalse(PREFS_CONFIG.get("feeds.system.topstories").value);
});
it("should set false with geo blocked", () => {
sandbox
.stub(global.Services.prefs, "getStringPref")
.withArgs(
"browser.newtabpage.activity-stream.discoverystream.region-stories-config"
)
.returns("US")
.withArgs(
"browser.newtabpage.activity-stream.discoverystream.region-stories-block"
)
.returns("US");
sandbox.stub(global.Services.prefs, "getBoolPref").returns(true);
sandbox
.stub(global.Services.locale, "appLocaleAsBCP47")
.get(() => "en-US");
as._updateDynamicPrefs();
clock.tick(1);
assert.isFalse(PREFS_CONFIG.get("feeds.system.topstories").value);
});
});
describe("telemetry reporting on init failure", () => {
it("should send a ping on init error", () => {
as = new ActivityStream();
const telemetry = { handleUndesiredEvent: sandbox.spy() };
sandbox.stub(as.store, "init").throws();
sandbox.stub(as.store.feeds, "get").returns(telemetry);
try {
as.init();
} catch (e) {}
assert.calledOnce(telemetry.handleUndesiredEvent);
});
});
describe("searchs shortcuts shouldPin pref", () => {
const SEARCH_SHORTCUTS_SEARCH_ENGINES_PREF =
"improvesearch.topSiteSearchShortcuts.searchEngines";
let stub;
beforeEach(() => {
stub = sandbox.stub(global.Region, "home");
});
it("should be an empty string when no geo is available", () => {
stub.get(() => "");
as._updateDynamicPrefs();
assert.equal(
PREFS_CONFIG.get(SEARCH_SHORTCUTS_SEARCH_ENGINES_PREF).value,
""
);
});
it("should be 'baidu' in China", () => {
stub.get(() => "CN");
as._updateDynamicPrefs();
assert.equal(
PREFS_CONFIG.get(SEARCH_SHORTCUTS_SEARCH_ENGINES_PREF).value,
"baidu"
);
});
it("should be 'yandex' in Russia, Belarus, Kazakhstan, and Turkey", () => {
const geos = ["BY", "KZ", "RU", "TR"];
for (const geo of geos) {
stub.get(() => geo);
as._updateDynamicPrefs();
assert.equal(
PREFS_CONFIG.get(SEARCH_SHORTCUTS_SEARCH_ENGINES_PREF).value,
"yandex"
);
}
});
it("should be 'google,amazon' in Germany, France, the UK, Japan, Italy, and the US", () => {
const geos = ["DE", "FR", "GB", "IT", "JP", "US"];
for (const geo of geos) {
stub.returns(geo);
as._updateDynamicPrefs();
assert.equal(
PREFS_CONFIG.get(SEARCH_SHORTCUTS_SEARCH_ENGINES_PREF).value,
"google,amazon"
);
}
});
it("should be 'google' elsewhere", () => {
// A selection of other geos
const geos = ["BR", "CA", "ES", "ID", "IN"];
for (const geo of geos) {
stub.get(() => geo);
as._updateDynamicPrefs();
assert.equal(
PREFS_CONFIG.get(SEARCH_SHORTCUTS_SEARCH_ENGINES_PREF).value,
"google"
);
}
});
});
});
|