Source code

Revision control

Copy as Markdown

Other Tools

Test Info: Warnings

/* Any copyright is dedicated to the Public Domain.
/**
* Tests reloading engines when changing the in-use locale of a WebExtension,
* where the name of the engine changes as well.
*/
"use strict";
const CONFIG = [
{
webExtension: {
id: "engine@search.mozilla.org",
name: "Test search engine",
params: [
{
name: "q",
value: "{searchTerms}",
},
{
name: "channel",
condition: "purpose",
purpose: "contextmenu",
value: "rcs",
},
{
name: "channel",
condition: "purpose",
purpose: "keyword",
value: "fflb",
},
],
suggest_url:
},
appliesTo: [
{
included: { everywhere: true },
default: "yes",
},
],
},
{
webExtension: {
id: "engine-diff-name@search.mozilla.org",
default_locale: "en",
searchProvider: {
en: {
name: "engine-diff-name-en",
},
gd: {
name: "engine-diff-name-gd",
},
},
},
appliesTo: [
{
included: { everywhere: true },
excluded: { locales: { matches: ["gd"] } },
},
{
included: { locales: { matches: ["gd"] } },
webExtension: {
locales: ["gd"],
},
},
],
},
];
const CONFIG_V2 = [
{
recordType: "engine",
identifier: "engine",
base: {
name: "Test search engine",
urls: {
search: {
params: [
{
name: "channel",
searchAccessPoint: {
addressbar: "fflb",
contextmenu: "rcs",
},
},
],
searchTermParamName: "q",
},
},
},
},
variants: [
{
environment: { allRegionsAndLocales: true },
},
],
},
{
recordType: "engine",
identifier: "engine-diff-name-en",
base: {
name: "engine-diff-name-en",
urls: {
search: {
searchTermParamName: "q",
},
},
},
variants: [
{
environment: { excludedLocales: ["gd"] },
},
],
},
{
recordType: "engine",
identifier: "engine-diff-name-gd",
base: {
name: "engine-diff-name-gd",
urls: {
search: {
searchTermParamName: "q",
},
},
},
variants: [
{
environment: { locales: ["gd"] },
},
],
},
{
recordType: "defaultEngines",
globalDefault: "engine",
specificDefaults: [],
},
{
recordType: "engineOrders",
orders: [],
},
];
add_setup(async () => {
Services.locale.availableLocales = [
...Services.locale.availableLocales,
"en",
"gd",
];
Services.locale.requestedLocales = ["gd"];
await SearchTestUtils.useTestEngines(
"data",
null,
SearchUtils.newSearchConfigEnabled ? CONFIG_V2 : CONFIG
);
await AddonTestUtils.promiseStartupManager();
await Services.search.init();
});
add_task(async function test_config_updated_engine_changes() {
let engines = await Services.search.getEngines();
Assert.deepEqual(
engines.map(e => e.name),
["Test search engine", "engine-diff-name-gd"],
"Should have the correct engines installed"
);
let engine = await Services.search.getEngineByName("engine-diff-name-gd");
Assert.equal(
engine.name,
"engine-diff-name-gd",
"Should have the correct engine name"
);
Assert.equal(
engine.getSubmission("test").uri.spec,
SearchUtils.newSearchConfigEnabled
"Should have the gd search url"
);
await promiseSetLocale("en");
engines = await Services.search.getEngines();
Assert.deepEqual(
engines.map(e => e.name),
["Test search engine", "engine-diff-name-en"],
"Should have the correct engines installed after locale change"
);
engine = await Services.search.getEngineByName("engine-diff-name-en");
Assert.equal(
engine.name,
"engine-diff-name-en",
"Should have the correct engine name"
);
Assert.equal(
engine.getSubmission("test").uri.spec,
SearchUtils.newSearchConfigEnabled
"Should have the en search url"
);
});