mozilla-central/toolkit/components/search/tests/xpcshell/test_searchSuggest_extraParams.js (file symbol)

Source code

Revision control

Copy as Markdown

Other Tools

Test Info: Warnings

/* Any copyright is dedicated to the Public Domain.
const TEST_CONFIG = [
{
webExtension: {
id: "get@search.mozilla.org",
name: "Get Engine",
search_url: "https://example.com",
search_url_get_params: "webExtension=1&search={searchTerms}",
suggest_url: "https://example.com",
suggest_url_get_params: "webExtension=1&suggest={searchTerms}",
},
appliesTo: [{ included: { everywhere: true } }],
suggestExtraParams: [
{
name: "custom_param",
pref: "test_pref_param",
condition: "pref",
},
],
},
];
const TEST_CONFIG_V2 = [
{
recordType: "engine",
identifier: "get",
base: {
name: "Get Engine",
urls: {
search: {
params: [
{
name: "webExtension",
value: "1",
},
],
searchTermParamName: "search",
},
suggestions: {
params: [
{
name: "custom_param",
experimentConfig: "test_pref_param",
},
{
name: "webExtension",
value: "1",
},
],
searchTermParamName: "suggest",
},
},
},
variants: [
{
environment: { allRegionsAndLocales: true },
},
],
},
{
recordType: "defaultEngines",
globalDefault: "get",
specificDefaults: [],
},
{
recordType: "engineOrders",
orders: [],
},
];
add_setup(async function () {
await SearchTestUtils.useTestEngines(
"method-extensions",
null,
SearchUtils.newSearchConfigEnabled ? TEST_CONFIG_V2 : TEST_CONFIG
);
await AddonTestUtils.promiseStartupManager();
await Services.search.init();
});
add_task(async function test_custom_suggest_param() {
let engine = Services.search.getEngineByName("Get Engine");
Assert.notEqual(engine, null, "Should have found an engine");
let submissionSuggest = engine.getSubmission(
"bar",
SearchUtils.URL_TYPE.SUGGEST_JSON
);
Assert.equal(
submissionSuggest.uri.spec,
"Suggest URLs should match"
);
let defaultBranch = Services.prefs.getDefaultBranch("browser.search.");
defaultBranch.setCharPref("param.test_pref_param", "good");
let nextSubmissionSuggest = engine.getSubmission(
"bar",
SearchUtils.URL_TYPE.SUGGEST_JSON
);
Assert.equal(
nextSubmissionSuggest.uri.spec,
"Suggest URLs should include custom param"
);
});