summaryrefslogtreecommitdiffstats
path: root/browser/components/urlbar/tests/quicksuggest/unit/test_weather.js
diff options
context:
space:
mode:
Diffstat (limited to 'browser/components/urlbar/tests/quicksuggest/unit/test_weather.js')
-rw-r--r--browser/components/urlbar/tests/quicksuggest/unit/test_weather.js200
1 files changed, 71 insertions, 129 deletions
diff --git a/browser/components/urlbar/tests/quicksuggest/unit/test_weather.js b/browser/components/urlbar/tests/quicksuggest/unit/test_weather.js
index 28801904a1..cd794f435b 100644
--- a/browser/components/urlbar/tests/quicksuggest/unit/test_weather.js
+++ b/browser/components/urlbar/tests/quicksuggest/unit/test_weather.js
@@ -34,6 +34,15 @@ add_setup(async () => {
// `lastFetchTimeMs` is expected to be `fetchDelayAfterComingOnlineMs`, we can
// be sure the value actually came from `fetchDelayAfterComingOnlineMs`.
QuickSuggest.weather._test_fetchDelayAfterComingOnlineMs = 53;
+
+ // When `add_tasks_with_rust()` disables the Rust backend and forces sync, the
+ // JS backend will sync `Weather` with remote settings. Since keywords are
+ // present in remote settings at that point (we added them above), `Weather`
+ // will then start fetching. The fetch may or may not be done before our test
+ // task starts. To make sure it's done, queue another fetch and await it.
+ registerAddTasksWithRustSetup(async () => {
+ await QuickSuggest.weather._test_fetch();
+ });
});
// The feature should be properly uninitialized when it's disabled and then
@@ -52,17 +61,15 @@ add_tasks_with_rust(async function disableAndEnable_suggestPref() {
async function doBasicDisableAndEnableTest(pref) {
// Sanity check initial state.
- assertEnabled({
+ await assertEnabled({
message: "Sanity check initial state",
hasSuggestion: true,
- pendingFetchCount: 0,
});
// Disable the feature. It should be immediately uninitialized.
UrlbarPrefs.set(pref, false);
assertDisabled({
message: "After disabling",
- pendingFetchCount: 0,
});
// No suggestion should be returned for a search.
@@ -83,19 +90,17 @@ async function doBasicDisableAndEnableTest(pref) {
// Re-enable the feature. It should be immediately initialized and a fetch
// should start.
info("Re-enable the feature");
- let fetchPromise = QuickSuggest.weather.waitForFetches();
+ let fetchPromise = waitForNewWeatherFetch();
UrlbarPrefs.set(pref, true);
- assertEnabled({
+ await assertEnabled({
message: "Immediately after re-enabling",
hasSuggestion: false,
- pendingFetchCount: 1,
});
await fetchPromise;
- assertEnabled({
+ await assertEnabled({
message: "After awaiting fetch",
hasSuggestion: true,
- pendingFetchCount: 0,
});
Assert.equal(
@@ -126,16 +131,15 @@ async function doBasicDisableAndEnableTest(pref) {
// This task is only appropriate for the JS backend, not Rust, since fetching is
// always active with Rust.
-add_task(
+add_tasks_with_rust(
{
- skip_if: () => UrlbarPrefs.get("quickSuggestRustEnabled"),
+ skip_if_rust_enabled: true,
},
async function keywordsNotDefined() {
// Sanity check initial state.
- assertEnabled({
+ await assertEnabled({
message: "Sanity check initial state",
hasSuggestion: true,
- pendingFetchCount: 0,
});
// Set RS data without any keywords. Fetching should immediately stop.
@@ -147,7 +151,6 @@ add_task(
]);
assertDisabled({
message: "After setting RS data without keywords",
- pendingFetchCount: 0,
});
// No suggestion should be returned for a search.
@@ -162,24 +165,22 @@ add_task(
// Set keywords. Fetching should immediately start.
info("Setting keywords");
- let fetchPromise = QuickSuggest.weather.waitForFetches();
+ let fetchPromise = waitForNewWeatherFetch();
await QuickSuggestTestUtils.setRemoteSettingsRecords([
{
type: "weather",
weather: MerinoTestUtils.WEATHER_RS_DATA,
},
]);
- assertEnabled({
+ await assertEnabled({
message: "Immediately after setting keywords",
hasSuggestion: false,
- pendingFetchCount: 1,
});
await fetchPromise;
- assertEnabled({
+ await assertEnabled({
message: "After awaiting fetch",
hasSuggestion: true,
- pendingFetchCount: 0,
});
Assert.equal(
@@ -211,27 +212,24 @@ add_task(
// it should be discarded since the feature is disabled.
add_tasks_with_rust(async function disableAndEnable_immediate1() {
// Sanity check initial state.
- assertEnabled({
+ await assertEnabled({
message: "Sanity check initial state",
hasSuggestion: true,
- pendingFetchCount: 0,
});
// Disable the feature. It should be immediately uninitialized.
UrlbarPrefs.set("weather.featureGate", false);
assertDisabled({
message: "After disabling",
- pendingFetchCount: 0,
});
// Re-enable the feature. It should be immediately initialized and a fetch
// should start.
- let fetchPromise = QuickSuggest.weather.waitForFetches();
+ let fetchPromise = waitForNewWeatherFetch();
UrlbarPrefs.set("weather.featureGate", true);
- assertEnabled({
+ await assertEnabled({
message: "Immediately after re-enabling",
hasSuggestion: false,
- pendingFetchCount: 1,
});
// Disable it again. The fetch will remain ongoing since pending fetches
@@ -239,7 +237,6 @@ add_tasks_with_rust(async function disableAndEnable_immediate1() {
UrlbarPrefs.set("weather.featureGate", false);
assertDisabled({
message: "After disabling again",
- pendingFetchCount: 1,
});
// Wait for the fetch to finish.
@@ -249,21 +246,19 @@ add_tasks_with_rust(async function disableAndEnable_immediate1() {
// uninitialized.
assertDisabled({
message: "After awaiting fetch",
- pendingFetchCount: 0,
});
// Clean up by re-enabling the feature for the remaining tasks.
- fetchPromise = QuickSuggest.weather.waitForFetches();
+ fetchPromise = waitForNewWeatherFetch();
UrlbarPrefs.set("weather.featureGate", true);
await fetchPromise;
// Wait for keywords to be re-synced from remote settings.
await QuickSuggestTestUtils.forceSync();
- assertEnabled({
+ await assertEnabled({
message: "On cleanup",
hasSuggestion: true,
- pendingFetchCount: 0,
});
});
@@ -279,26 +274,23 @@ add_tasks_with_rust(async function disableAndEnable_immediate1() {
// from step 2 should be discarded.
add_tasks_with_rust(async function disableAndEnable_immediate2() {
// Sanity check initial state.
- assertEnabled({
+ await assertEnabled({
message: "Sanity check initial state",
hasSuggestion: true,
- pendingFetchCount: 0,
});
// Disable the feature. It should be immediately uninitialized.
UrlbarPrefs.set("weather.featureGate", false);
assertDisabled({
message: "After disabling",
- pendingFetchCount: 0,
});
// Re-enable the feature. It should be immediately initialized and a fetch
// should start.
UrlbarPrefs.set("weather.featureGate", true);
- assertEnabled({
+ await assertEnabled({
message: "Immediately after re-enabling",
hasSuggestion: false,
- pendingFetchCount: 1,
});
// Disable it again. The fetch will remain ongoing since pending fetches
@@ -306,25 +298,21 @@ add_tasks_with_rust(async function disableAndEnable_immediate2() {
UrlbarPrefs.set("weather.featureGate", false);
assertDisabled({
message: "After disabling again",
- pendingFetchCount: 1,
});
- // Re-enable it. A new fetch should start, so now there will be two pending
- // fetches.
- let fetchPromise = QuickSuggest.weather.waitForFetches();
+ // Re-enable it. A new fetch should start.
+ let fetchPromise = waitForNewWeatherFetch();
UrlbarPrefs.set("weather.featureGate", true);
- assertEnabled({
+ await assertEnabled({
message: "Immediately after re-enabling again",
hasSuggestion: false,
- pendingFetchCount: 2,
});
- // Wait for both fetches to finish.
+ // Wait for it to finish.
await fetchPromise;
- assertEnabled({
+ await assertEnabled({
message: "Immediately after re-enabling again",
hasSuggestion: true,
- pendingFetchCount: 0,
});
// Wait for keywords to be re-synced from remote settings.
@@ -334,10 +322,9 @@ add_tasks_with_rust(async function disableAndEnable_immediate2() {
// A fetch that doesn't return a suggestion should cause the last-fetched
// suggestion to be discarded.
add_tasks_with_rust(async function noSuggestion() {
- assertEnabled({
+ await assertEnabled({
message: "Sanity check initial state",
hasSuggestion: true,
- pendingFetchCount: 0,
});
let histograms = MerinoTestUtils.getAndClearHistograms({
@@ -350,10 +337,9 @@ add_tasks_with_rust(async function noSuggestion() {
await QuickSuggest.weather._test_fetch();
- assertEnabled({
+ await assertEnabled({
message: "After fetch",
hasSuggestion: false,
- pendingFetchCount: 0,
});
Assert.equal(
QuickSuggest.weather._test_merino.lastFetchStatus,
@@ -381,19 +367,17 @@ add_tasks_with_rust(async function noSuggestion() {
// Clean up by forcing another fetch so the suggestion is non-null for the
// remaining tasks.
await QuickSuggest.weather._test_fetch();
- assertEnabled({
+ await assertEnabled({
message: "On cleanup",
hasSuggestion: true,
- pendingFetchCount: 0,
});
});
// A network error should cause the last-fetched suggestion to be discarded.
add_tasks_with_rust(async function networkError() {
- assertEnabled({
+ await assertEnabled({
message: "Sanity check initial state",
hasSuggestion: true,
- pendingFetchCount: 0,
});
let histograms = MerinoTestUtils.getAndClearHistograms({
@@ -411,10 +395,9 @@ add_tasks_with_rust(async function networkError() {
QuickSuggest.weather._test_setTimeoutMs(-1);
- assertEnabled({
+ await assertEnabled({
message: "After fetch",
hasSuggestion: false,
- pendingFetchCount: 0,
});
Assert.equal(
QuickSuggest.weather._test_merino.lastFetchStatus,
@@ -440,19 +423,17 @@ add_tasks_with_rust(async function networkError() {
// Clean up by forcing another fetch so the suggestion is non-null for the
// remaining tasks.
await QuickSuggest.weather._test_fetch();
- assertEnabled({
+ await assertEnabled({
message: "On cleanup",
hasSuggestion: true,
- pendingFetchCount: 0,
});
});
// An HTTP error should cause the last-fetched suggestion to be discarded.
add_tasks_with_rust(async function httpError() {
- assertEnabled({
+ await assertEnabled({
message: "Sanity check initial state",
hasSuggestion: true,
- pendingFetchCount: 0,
});
let histograms = MerinoTestUtils.getAndClearHistograms({
@@ -463,10 +444,9 @@ add_tasks_with_rust(async function httpError() {
MerinoTestUtils.server.response = { status: 500 };
await QuickSuggest.weather._test_fetch();
- assertEnabled({
+ await assertEnabled({
message: "After fetch",
hasSuggestion: false,
- pendingFetchCount: 0,
});
Assert.equal(
QuickSuggest.weather._test_merino.lastFetchStatus,
@@ -494,20 +474,18 @@ add_tasks_with_rust(async function httpError() {
MerinoTestUtils.server.reset();
MerinoTestUtils.server.response.body.suggestions = [WEATHER_SUGGESTION];
await QuickSuggest.weather._test_fetch();
- assertEnabled({
+ await assertEnabled({
message: "On cleanup",
hasSuggestion: true,
- pendingFetchCount: 0,
});
});
// A fetch that doesn't return a suggestion due to a client timeout should cause
// the last-fetched suggestion to be discarded.
add_tasks_with_rust(async function clientTimeout() {
- assertEnabled({
+ await assertEnabled({
message: "Sanity check initial state",
hasSuggestion: true,
- pendingFetchCount: 0,
});
let histograms = MerinoTestUtils.getAndClearHistograms({
@@ -528,10 +506,9 @@ add_tasks_with_rust(async function clientTimeout() {
await QuickSuggest.weather._test_fetch();
- assertEnabled({
+ await assertEnabled({
message: "After fetch",
hasSuggestion: false,
- pendingFetchCount: 0,
});
Assert.equal(
QuickSuggest.weather._test_merino.lastFetchStatus,
@@ -573,10 +550,9 @@ add_tasks_with_rust(async function clientTimeout() {
// Clean up by forcing another fetch so the suggestion is non-null for the
// remaining tasks.
await QuickSuggest.weather._test_fetch();
- assertEnabled({
+ await assertEnabled({
message: "On cleanup",
hasSuggestion: true,
- pendingFetchCount: 0,
});
});
@@ -662,10 +638,9 @@ async function doLocaleTest({ shouldRunTask, osUnit, unitsByLocale }) {
return;
}
- assertEnabled({
+ await assertEnabled({
message: "Sanity check initial state",
hasSuggestion: true,
- pendingFetchCount: 0,
});
// Sanity check initial locale info.
@@ -716,10 +691,9 @@ async function doLocaleTest({ shouldRunTask, osUnit, unitsByLocale }) {
// Blocks a result and makes sure the weather pref is disabled.
add_tasks_with_rust(async function block() {
// Sanity check initial state.
- assertEnabled({
+ await assertEnabled({
message: "Sanity check initial state",
hasSuggestion: true,
- pendingFetchCount: 0,
});
Assert.ok(
UrlbarPrefs.get("suggest.weather"),
@@ -775,17 +749,16 @@ add_tasks_with_rust(async function block() {
});
// Re-enable the pref and clean up.
- let fetchPromise = QuickSuggest.weather.waitForFetches();
+ let fetchPromise = waitForNewWeatherFetch();
UrlbarPrefs.set("suggest.weather", true);
await fetchPromise;
// Wait for keywords to be re-synced from remote settings.
await QuickSuggestTestUtils.forceSync();
- assertEnabled({
+ await assertEnabled({
message: "On cleanup",
hasSuggestion: true,
- pendingFetchCount: 0,
});
});
@@ -849,16 +822,12 @@ async function doWakeTest({
// Advance the clock and simulate wake.
info("Sending wake notification");
+ let fetchPromise = waitForNewWeatherFetch();
let nowOnWake = nowOnStart + sleepIntervalMs;
dateNowStub.returns(nowOnWake);
QuickSuggest.weather.observe(null, "wake_notification", "");
Assert.equal(
- QuickSuggest.weather._test_pendingFetchCount,
- 0,
- "After wake, next fetch should not have immediately started"
- );
- Assert.equal(
QuickSuggest.weather._test_lastFetchTimeMs,
nowOnStart,
"After wake, last fetch time should be unchanged"
@@ -891,18 +860,13 @@ async function doWakeTest({
// Wait for the fetch. If the wake didn't trigger it, then the caller should
// have passed in a `sleepIntervalMs` that will make it start soon.
info("Waiting for fetch after wake");
- await QuickSuggest.weather.waitForFetches();
+ await fetchPromise;
Assert.equal(
QuickSuggest.weather._test_fetchTimerMs,
QuickSuggest.weather._test_fetchIntervalMs,
"After post-wake fetch, timer period should remain full fetch interval"
);
- Assert.equal(
- QuickSuggest.weather._test_pendingFetchCount,
- 0,
- "After post-wake fetch, no more fetches should be pending"
- );
dateNowStub.restore();
}
@@ -958,11 +922,6 @@ async function doOnlineTestWithSuggestion({ topic, dataValues }) {
QuickSuggest.weather.observe(null, topic, data);
Assert.equal(
- QuickSuggest.weather._test_pendingFetchCount,
- 0,
- "Fetch should not have started"
- );
- Assert.equal(
QuickSuggest.weather._test_fetchTimer,
timer,
"Timer should not have been recreated"
@@ -1033,11 +992,6 @@ async function doOnlineTestWithNullSuggestion({
"Suggestion should remain null"
);
Assert.equal(
- QuickSuggest.weather._test_pendingFetchCount,
- 0,
- "Fetch should not have started"
- );
- Assert.equal(
QuickSuggest.weather._test_fetchTimer,
timer,
"Timer should not have been recreated"
@@ -1055,13 +1009,9 @@ async function doOnlineTestWithNullSuggestion({
Assert.ok(!QuickSuggest.weather.suggestion, "Suggestion should be null");
info("Sending notification: " + JSON.stringify({ topic, data }));
+ let fetchPromise = waitForNewWeatherFetch();
QuickSuggest.weather.observe(null, topic, data);
- Assert.equal(
- QuickSuggest.weather._test_pendingFetchCount,
- 0,
- "Fetch should not have started yet"
- );
Assert.notEqual(
QuickSuggest.weather._test_fetchTimer,
0,
@@ -1081,13 +1031,8 @@ async function doOnlineTestWithNullSuggestion({
timer = QuickSuggest.weather._test_fetchTimer;
info("Waiting for fetch after notification");
- await QuickSuggest.weather.waitForFetches();
+ await fetchPromise;
- Assert.equal(
- QuickSuggest.weather._test_pendingFetchCount,
- 0,
- "Fetch should not be pending"
- );
Assert.notEqual(
QuickSuggest.weather._test_fetchTimer,
0,
@@ -1164,20 +1109,23 @@ async function doManyNotificationsTest(notifications) {
MerinoTestUtils.WEATHER_SUGGESTION,
];
+ let { fetchPromise: oldFetchPromise } = QuickSuggest.weather;
+ let fetchPromise = waitForNewWeatherFetch();
+
// Send the notifications.
for (let [topic, data] of notifications) {
info("Sending notification: " + JSON.stringify({ topic, data }));
QuickSuggest.weather.observe(null, topic, data);
+ Assert.equal(
+ QuickSuggest.weather.fetchPromise,
+ oldFetchPromise,
+ "No new fetch should have started yet"
+ );
}
info("Waiting for fetch after notifications");
- await QuickSuggest.weather.waitForFetches();
+ await fetchPromise;
- Assert.equal(
- QuickSuggest.weather._test_pendingFetchCount,
- 0,
- "Fetch should not be pending"
- );
Assert.notEqual(
QuickSuggest.weather._test_fetchTimer,
0,
@@ -1241,7 +1189,7 @@ add_tasks_with_rust(async function vpn() {
// Simulate the link status changing. Since the mock link service still
// indicates a VPN is detected, the suggestion should remain null.
- let fetchPromise = QuickSuggest.weather.waitForFetches();
+ let fetchPromise = waitForNewWeatherFetch();
QuickSuggest.weather.observe(null, "network:link-status-changed", "changed");
await fetchPromise;
Assert.ok(!QuickSuggest.weather.suggestion, "Suggestion should remain null");
@@ -1251,7 +1199,7 @@ add_tasks_with_rust(async function vpn() {
Ci.nsINetworkLinkService.NONE_DETECTED;
// Simulate the link status changing again. The suggestion should be fetched.
- fetchPromise = QuickSuggest.weather.waitForFetches();
+ fetchPromise = waitForNewWeatherFetch();
QuickSuggest.weather.observe(null, "network:link-status-changed", "changed");
await fetchPromise;
Assert.ok(QuickSuggest.weather.suggestion, "Suggestion should be fetched");
@@ -1264,10 +1212,9 @@ add_tasks_with_rust(async function vpn() {
// weather record.
add_tasks_with_rust(async function nimbusOverride() {
// Sanity check initial state.
- assertEnabled({
+ await assertEnabled({
message: "Sanity check initial state",
hasSuggestion: true,
- pendingFetchCount: 0,
});
let defaultResult = makeWeatherResult();
@@ -1349,7 +1296,7 @@ add_tasks_with_rust(async function nimbusOverride() {
});
});
-function assertEnabled({ message, hasSuggestion, pendingFetchCount }) {
+async function assertEnabled({ message, hasSuggestion }) {
info("Asserting feature is enabled");
if (message) {
info(message);
@@ -1360,20 +1307,20 @@ function assertEnabled({ message, hasSuggestion, pendingFetchCount }) {
hasSuggestion,
"Suggestion is null or non-null as expected"
);
+ Assert.ok(QuickSuggest.weather._test_merino, "Merino client is non-null");
+
+ await TestUtils.waitForCondition(
+ () => QuickSuggest.weather._test_fetchTimer,
+ "Waiting for fetch timer to become non-zero"
+ );
Assert.notEqual(
QuickSuggest.weather._test_fetchTimer,
0,
"Fetch timer is non-zero"
);
- Assert.ok(QuickSuggest.weather._test_merino, "Merino client is non-null");
- Assert.equal(
- QuickSuggest.weather._test_pendingFetchCount,
- pendingFetchCount,
- "Expected pending fetch count"
- );
}
-function assertDisabled({ message, pendingFetchCount }) {
+function assertDisabled({ message }) {
info("Asserting feature is disabled");
if (message) {
info(message);
@@ -1394,9 +1341,4 @@ function assertDisabled({ message, pendingFetchCount }) {
null,
"Merino client is null"
);
- Assert.equal(
- QuickSuggest.weather._test_pendingFetchCount,
- pendingFetchCount,
- "Expected pending fetch count"
- );
}
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-20 11:19:48 +0000