Bug 1851449 - Ensure trending checkbox is disabled correctly. r=Gijs,settings-reviewers

Differential Revision: https://phabricator.services.mozilla.com/D187488
This commit is contained in:
Dale Harvey 2023-09-06 19:19:20 +00:00
parent 04ca8d0561
commit b89b4b32b2
3 changed files with 85 additions and 3 deletions

View File

@ -217,7 +217,7 @@ var gSearchPane = {
);
permanentPBLabel.hidden = urlbarSuggests.hidden || !permanentPB;
this._updateTrendingCheckbox();
this._updateTrendingCheckbox(!suggestsPref.value || permanentPB);
},
_showAddEngineButton() {
@ -231,14 +231,15 @@ var gSearchPane = {
}
},
async _updateTrendingCheckbox() {
async _updateTrendingCheckbox(suggestDisabled) {
let trendingBox = document.getElementById("showTrendingSuggestionsBox");
let trendingCheckBox = document.getElementById("showTrendingSuggestions");
let trendingSupported = TRENDING_ENGINES.includes(
(await Services.search.getDefault()).name
);
trendingBox.hidden = !Preferences.get("browser.urlbar.trending.featureGate")
.value;
trendingBox.disabled = !trendingSupported;
trendingCheckBox.disabled = suggestDisabled || !trendingSupported;
},
/**

View File

@ -152,4 +152,5 @@ support-files =
[browser_sync_chooseWhatToSync.js]
[browser_sync_disabled.js]
[browser_sync_pairing.js]
[browser_trendingsuggestions.js]
[browser_warning_permanent_private_browsing.js]

View File

@ -0,0 +1,80 @@
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
const { SearchTestUtils } = ChromeUtils.importESModule(
"resource://testing-common/SearchTestUtils.sys.mjs"
);
const MAIN_PREF = "browser.search.suggest.enabled";
const URLBAR_PREF = "browser.urlbar.suggest.searches";
const TRENDING_PREF = "browser.urlbar.trending.featureGate";
const TRENDING_CHECKBOX_ID = "showTrendingSuggestions";
const SUGGESTIONED_CHECKBOX_ID = "suggestionsInSearchFieldsCheckbox";
SearchTestUtils.init(this);
add_setup(async function () {
await SpecialPowers.pushPrefEnv({
set: [
[MAIN_PREF, true],
[URLBAR_PREF, true],
[TRENDING_PREF, true],
],
});
await SearchTestUtils.installSearchExtension({
name: "engine1",
search_url: "https://example.com/engine1",
search_url_get_params: "search={searchTerms}",
});
const defaultEngine = await Services.search.getDefault();
registerCleanupFunction(async () => {
await Services.search.setDefault(
defaultEngine,
Ci.nsISearchService.CHANGE_REASON_UNKNOWN
);
});
});
add_task(async function testSuggestionsDisabled() {
await openPreferencesViaOpenPreferencesAPI("search", { leaveOpen: true });
let doc = gBrowser.selectedBrowser.contentDocument;
let trendingCheckbox = doc.getElementById(TRENDING_CHECKBOX_ID);
let suggestionsCheckbox = doc.getElementById(SUGGESTIONED_CHECKBOX_ID);
Assert.ok(trendingCheckbox.checked, "Checkbox should be visible and checked");
Assert.ok(!trendingCheckbox.disabled, "Checkbox should not be disabled");
// Disable search suggestions.
suggestionsCheckbox.checked = false;
suggestionsCheckbox.doCommand();
await BrowserTestUtils.waitForCondition(
() => trendingCheckbox.disabled,
"Trending checkbox should be disabled when search suggestions are disabled"
);
// Clean up.
Services.prefs.clearUserPref(MAIN_PREF);
gBrowser.removeCurrentTab();
});
add_task(async function testNonTrendingEngine() {
// Set engine that does not support trending suggestions as default.
const engine1 = Services.search.getEngineByName("engine1");
Services.search.setDefault(
engine1,
Ci.nsISearchService.CHANGE_REASON_UNKNOWN
);
await openPreferencesViaOpenPreferencesAPI("search", { leaveOpen: true });
let doc = gBrowser.selectedBrowser.contentDocument;
let trendingCheckbox = doc.getElementById(TRENDING_CHECKBOX_ID);
Assert.ok(
trendingCheckbox.disabled,
"Checkbox should be disabled when an engine that doesnt support trending suggestions is default"
);
gBrowser.removeCurrentTab();
});