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
|
/* 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/. */
// Tests ingest in the Rust backend.
"use strict";
ChromeUtils.defineESModuleGetters(this, {
setTimeout: "resource://gre/modules/Timer.sys.mjs",
});
// These consts are copied from the update timer manager test. See
// `initUpdateTimerManager()`.
const PREF_APP_UPDATE_TIMERMINIMUMDELAY = "app.update.timerMinimumDelay";
const PREF_APP_UPDATE_TIMERFIRSTINTERVAL = "app.update.timerFirstInterval";
const MAIN_TIMER_INTERVAL = 1000; // milliseconds
const CATEGORY_UPDATE_TIMER = "update-timer";
const REMOTE_SETTINGS_SUGGESTION = {
id: 1,
url: "http://example.com/amp",
title: "AMP Suggestion",
keywords: ["amp"],
click_url: "http://example.com/amp-click",
impression_url: "http://example.com/amp-impression",
advertiser: "Amp",
iab_category: "22 - Shopping",
icon: "1234",
};
add_setup(async function () {
initUpdateTimerManager();
await QuickSuggestTestUtils.ensureQuickSuggestInit({
remoteSettingsRecords: [
{
type: "data",
attachment: [REMOTE_SETTINGS_SUGGESTION],
},
],
prefs: [
["suggest.quicksuggest.sponsored", true],
["quicksuggest.rustEnabled", false],
],
});
});
// IMPORTANT: This task must run first!
//
// This simulates the first time the Rust backend is enabled in a profile. The
// backend should perform ingestion immediately.
add_task(async function firstRun() {
Assert.ok(
!UrlbarPrefs.get("quicksuggest.rustEnabled"),
"rustEnabled pref is initially false (this task must run first!)"
);
Assert.strictEqual(
QuickSuggest.rustBackend.isEnabled,
false,
"Rust backend is initially disabled (this task must run first!)"
);
Assert.ok(
!QuickSuggest.rustBackend.ingestPromise,
"No ingest has been performed yet (this task must run first!)"
);
info("Enabling the Rust backend");
UrlbarPrefs.set("quicksuggest.rustEnabled", true);
Assert.ok(QuickSuggest.rustBackend.isEnabled, "Rust backend is now enabled");
// An ingest should start.
let { ingestPromise } = await waitForIngestStart(null);
info("Awaiting ingest promise");
await ingestPromise;
info("Done awaiting ingest promise");
await checkSuggestions();
// Disable and re-enable the backend. No new ingestion should start
// immediately since this isn't the first time the backend has been enabled.
UrlbarPrefs.set("quicksuggest.rustEnabled", false);
UrlbarPrefs.set("quicksuggest.rustEnabled", true);
await assertNoNewIngestStarted(ingestPromise);
await checkSuggestions();
UrlbarPrefs.set("quicksuggest.rustEnabled", false);
});
// Ingestion should be performed according to the defined interval.
add_task(async function interval() {
let { ingestPromise } = QuickSuggest.rustBackend;
Assert.ok(
ingestPromise,
"Sanity check: An ingest has already been performed"
);
Assert.ok(
!UrlbarPrefs.get("quicksuggest.rustEnabled"),
"Sanity check: Rust backend is initially disabled"
);
// Set a small interval and enable the backend. No new ingestion should start
// immediately since this isn't the first time the backend has been enabled.
let intervalSecs = 1;
UrlbarPrefs.set("quicksuggest.rustIngestIntervalSeconds", intervalSecs);
UrlbarPrefs.set("quicksuggest.rustEnabled", true);
await assertNoNewIngestStarted(ingestPromise);
// Wait for a few ingests to happen.
for (let i = 0; i < 3; i++) {
info("Preparing for ingest at index " + i);
// Set a new suggestion so we can make sure ingest really happened.
let suggestion = {
...REMOTE_SETTINGS_SUGGESTION,
url: REMOTE_SETTINGS_SUGGESTION.url + "/" + i,
};
await QuickSuggestTestUtils.setRemoteSettingsRecords(
[
{
type: "data",
attachment: [suggestion],
},
],
// Don't force sync since the whole point here is to make sure the backend
// ingests on its own!
{ forceSync: false }
);
// Wait for ingest to start and finish.
info("Waiting for ingest to start at index " + i);
({ ingestPromise } = await waitForIngestStart(ingestPromise));
info("Waiting for ingest to finish at index " + i);
await ingestPromise;
await checkSuggestions([suggestion]);
}
// In the loop above, there was one additional async call after awaiting the
// ingest promise, to `checkSuggestions()`. It's possible, though unlikely,
// that call took so long that another ingest has started. To be sure, wait
// for one final ingest to start before continuing.
({ ingestPromise } = await waitForIngestStart(ingestPromise));
// Now immediately disable the backend. New ingests should not start, but the
// final one will still be ongoing.
info("Disabling the backend");
UrlbarPrefs.set("quicksuggest.rustEnabled", false);
info("Awaiting final ingest promise");
await ingestPromise;
// Wait a few seconds.
let waitSecs = 3 * intervalSecs;
info(`Waiting ${waitSecs}s...`);
// eslint-disable-next-line mozilla/no-arbitrary-setTimeout
await new Promise(r => setTimeout(r, 1000 * waitSecs));
// No new ingests should have started.
Assert.equal(
QuickSuggest.rustBackend.ingestPromise,
ingestPromise,
"No new ingest started after disabling the backend"
);
UrlbarPrefs.clear("quicksuggest.rustIngestIntervalSeconds");
});
async function waitForIngestStart(oldIngestPromise) {
let newIngestPromise;
await TestUtils.waitForCondition(() => {
let { ingestPromise } = QuickSuggest.rustBackend;
if (
(oldIngestPromise && ingestPromise != oldIngestPromise) ||
(!oldIngestPromise && ingestPromise)
) {
newIngestPromise = ingestPromise;
return true;
}
return false;
}, "Waiting for a new ingest to start");
Assert.equal(
QuickSuggest.rustBackend.ingestPromise,
newIngestPromise,
"Sanity check: ingestPromise hasn't changed since waitForCondition returned"
);
// A bare promise can't be returned because it will cause the awaiting caller
// to await that promise! We're simply trying to return the promise, which the
// caller can later await.
return { ingestPromise: newIngestPromise };
}
async function assertNoNewIngestStarted(oldIngestPromise) {
for (let i = 0; i < 3; i++) {
await TestUtils.waitForTick();
}
Assert.equal(
QuickSuggest.rustBackend.ingestPromise,
oldIngestPromise,
"No new ingest started"
);
}
async function checkSuggestions(expected = [REMOTE_SETTINGS_SUGGESTION]) {
let actual = await QuickSuggest.rustBackend.query("amp");
Assert.deepEqual(
actual.map(s => s.url),
expected.map(s => s.url),
"Backend should be serving the expected suggestions"
);
}
/**
* Sets up the update timer manager for testing: makes it fire more often,
* removes all existing timers, and initializes it for testing. The body of this
* function is copied from:
* https://searchfox.org/mozilla-central/source/toolkit/components/timermanager/tests/unit/consumerNotifications.js
*/
function initUpdateTimerManager() {
// Set the timer to fire every second
Services.prefs.setIntPref(
PREF_APP_UPDATE_TIMERMINIMUMDELAY,
MAIN_TIMER_INTERVAL / 1000
);
Services.prefs.setIntPref(
PREF_APP_UPDATE_TIMERFIRSTINTERVAL,
MAIN_TIMER_INTERVAL
);
// Remove existing update timers to prevent them from being notified
for (let { data: entry } of Services.catMan.enumerateCategory(
CATEGORY_UPDATE_TIMER
)) {
Services.catMan.deleteCategoryEntry(CATEGORY_UPDATE_TIMER, entry, false);
}
Cc["@mozilla.org/updates/timer-manager;1"]
.getService(Ci.nsIUpdateTimerManager)
.QueryInterface(Ci.nsIObserver)
.observe(null, "utm-test-init", "");
}
|
