Bug 1583214 - Support ESR settings in the modern search configuration. r=mikedeboer

Differential Revision: https://phabricator.services.mozilla.com/D52041

--HG--
extra : moz-landing-system : lando

browser/components/search/extensions/engines.json

@@ -14,6 +14,16 @@
       "appliesTo": [{
         "included": { "everywhere": true },
         "default": "yes"
+      }, {
+        "included": { "everywhere": true },
+        "application": {
+          "channel": ["esr"]
+        },
+        "searchUrlGetParams": {
+          "client": "firefox-b-e",
+          "q": "{searchTerms}"
+        },
+        "telemetryId": "google-b-e"
       }, {
         "included": {
           "regions": ["ru", "tr", "by", "kz"],
@@ -24,6 +34,23 @@
           "telemetryId": "google"
         },
         "default": "no"
+      }, {
+        "included": {
+          "regions": ["ru", "tr", "by", "kz"],
+          "locales": {
+            "matches": ["ru", "tr", "be", "kk"],
+            "startsWith": ["en"]
+          },
+          "telemetryId": "google"
+        },
+        "application": {
+          "channel": ["esr"]
+        },
+        "searchUrlGetParams": {
+          "client": "firefox-b-e",
+          "q": "{searchTerms}"
+        },
+        "default": "no"
       }, {
         "included": {
           "regions": ["cn"],
@@ -32,6 +59,21 @@
           }
         },
         "default": "no"
+      }, {
+        "included": {
+          "regions": ["cn"],
+          "locales": {
+            "matches": ["zh-CN"]
+          }
+        },
+        "application": {
+          "channel": ["esr"]
+        },
+        "searchUrlGetParams": {
+          "client": "firefox-b-e",
+          "q": "{searchTerms}"
+        },
+        "default": "no"
       }, {
         "included": { "regions": ["us"] },
         "searchUrlGetParams": {
@@ -39,6 +81,16 @@
           "q": "{searchTerms}"
         },
         "telemetryId": "google-b-1-d"
+      },  {
+        "included": { "regions": ["us"] },
+        "application": {
+          "channel": ["esr"]
+        },
+        "searchUrlGetParams": {
+          "client": "firefox-b-1-e",
+          "q": "{searchTerms}"
+        },
+        "telemetryId": "google-b-1-e"
       }]
     },
     {

browser/components/search/test/browser/browser_google_behavior.js

@@ -5,6 +5,11 @@
  * Test Google search plugin URLs
  * TODO: This test is a near duplicate of browser_searchEngine_behaviors.js but
  * specific to Google. This is required due to bug 1315953.
+ *
+ * Note: Although we have tests for codes in
+ * toolkit/components/tests/xpcshell/searchconfigs, we also need this test as an
+ * integration test to check the search service to selector integration is
+ * working correctly (especially the ESR codes).
  */
 
 "use strict";

toolkit/components/search/SearchEngineSelector.jsm

@@ -49,13 +49,14 @@ class SearchEngineSelector {
   /**
    * @param {string} locale - Users locale.
    * @param {string} region - Users region.
+   * @param {string} channel - The update channel the application is running on.
    * @returns {object}
    *   An object with "engines" field, a sorted list of engines and
-   *   optionally "privateDefault" which is an object continaing the engine
-   *   details for the engine which should be the default in private mode.
+   *   optionally "privateDefault" which is an object containing the engine
+   *   details for the engine which should be the default in Private Browsing mode.
    */
-  fetchEngineConfiguration(locale, region = "default") {
-    log(`fetchEngineConfiguration ${region}:${locale}`);
+  fetchEngineConfiguration(locale, region, channel) {
+    log(`fetchEngineConfiguration ${region}:${locale}:${channel}`);
     let cohort = Services.prefs.getCharPref("browser.search.cohort", null);
     let engines = [];
     const lcLocale = locale.toLowerCase();
@@ -63,15 +64,22 @@ class SearchEngineSelector {
     for (let config of this.configuration) {
       const appliesTo = config.appliesTo || [];
       const applies = appliesTo.filter(section => {
+        if ("cohort" in section && cohort != section.cohort) {
+          return false;
+        }
+        if (
+          "application" in section &&
+          "channel" in section.application &&
+          !section.application.channel.includes(channel)
+        ) {
+          return false;
+        }
         let included =
           "included" in section &&
           this._isInSection(lcRegion, lcLocale, section.included);
         let excluded =
           "excluded" in section &&
           this._isInSection(lcRegion, lcLocale, section.excluded);
-        if ("cohort" in section && cohort != section.cohort) {
-          return false;
-        }
         return included && !excluded;
       });
 

toolkit/components/search/SearchService.jsm

@@ -1777,9 +1777,13 @@ SearchService.prototype = {
     let region = Services.prefs.getCharPref("browser.search.region", "default");
 
     await engineSelector.init();
+    let channel = AppConstants.MOZ_APP_VERSION_DISPLAY.endsWith("esr")
+      ? "esr"
+      : AppConstants.MOZ_UPDATE_CHANNEL;
     let { engines, privateDefault } = engineSelector.fetchEngineConfiguration(
       locale,
-      region
+      region,
+      channel
     );
 
     const defaultEngine = engines[0];

toolkit/components/search/docs/SearchConfigurationSchema.rst

@@ -128,6 +128,61 @@ depending on the user's locale.
 You can specify ``"default"`` as a region in the configuration if
 the engine is to be included when no region is specified.
 
+Application Scoping
+===================
+
+An engine configuration may be scoped to a particular application.
+
+Channel
+=======
+
+One or more channels may be specified in an array to restrict a configuration
+to just those channels. The current known channels are:
+
+    - default: Self-builds of Firefox, or possibly some self-distributed versions.
+    - nightly: Firefox Nightly builds.
+    - aurora: Firefox Developer Edition
+    - beta: Firefox Beta
+    - release: The main Firefox release channel.
+    - esr: The ESR Channel. This will also match versions of Firefox where the
+      displayed version number includes ``esr``. We do this to include Linux
+      distributions and other manual builds of ESR.
+
+In the following example, ``web@ext`` would be set as default on the default
+channel only, whereas ``web1@ext`` would be set as default on release and esr
+channels.
+
+.. code-block:: js
+
+    {
+      "webExtension": {
+        "id": "web@ext"
+      },
+      "appliesTo": [{
+        "included": {
+          "everywhere": true
+          "default": "yes",
+          "application": {
+            "channel": ["default"]
+          }
+        }
+      ]}
+    },
+    {
+      "webExtension": {
+        "id": "web1@ext"
+      },
+      "appliesTo": [{
+        "included": {
+          "everywhere": true
+          "default": "yes",
+          "application": {
+            "channel": ["release", "esr"]
+          }
+        }
+      ]}
+    }
+
 Experiments
 ===========
 

toolkit/components/search/schema/search-engine-config-schema.json

@@ -10,9 +10,6 @@
     "defaultPrivate": {
       "$ref": "#/definitions/defaultPrivate"
     },
-    "application": {
-      "$ref": "#/definitions/application"
-    },
     "orderHint": {
       "$ref": "#/definitions/orderHint"
     },
@@ -51,10 +48,10 @@
             "android"
           ]
         },
-        "branches": {
+        "channel": {
           "type": "array",
-          "title": "Branches",
-          "description": "Which branches this belongs to (not set = everywhere)",
+          "title": "Channel",
+          "description": "Which channel this belongs to (not set = everywhere). For ESR this is also keyed from the display version.",
           "items": {
             "type": "string",
             "enum": [

toolkit/components/search/tests/xpcshell/searchconfigs/head_searchconfig.js

@@ -16,6 +16,7 @@ const { XPCOMUtils } = ChromeUtils.import(
 XPCOMUtils.defineLazyModuleGetters(this, {
   AddonManager: "resource://gre/modules/AddonManager.jsm",
   AddonTestUtils: "resource://testing-common/AddonTestUtils.jsm",
+  AppConstants: "resource://gre/modules/AppConstants.jsm",
   ObjectUtils: "resource://gre/modules/ObjectUtils.jsm",
   OS: "resource://gre/modules/osfile.jsm",
   SearchEngine: "resource://gre/modules/SearchEngine.jsm",
@@ -168,7 +169,10 @@ class SearchConfigTest {
       let engines = [];
       let configs = await engineSelector.fetchEngineConfiguration(
         locale,
-        region
+        region,
+        AppConstants.MOZ_APP_VERSION_DISPLAY.endsWith("esr")
+          ? "esr"
+          : AppConstants.MOZ_UPDATE_CHANNEL
       );
       for (let config of configs.engines) {
         let engine = await Services.search.makeEnginesFromConfig(config);

toolkit/components/search/tests/xpcshell/searchconfigs/test_google.js

@@ -3,10 +3,6 @@
 
 "use strict";
 
-const { AppConstants } = ChromeUtils.import(
-  "resource://gre/modules/AppConstants.jsm"
-);
-
 const test = new SearchConfigTest({
   identifier: "google",
   aliases: ["@google"],

toolkit/components/search/tests/xpcshell/test_engine_selector.js

@@ -80,7 +80,8 @@ add_task(async function() {
 
   let { engines, privateDefault } = engineSelector.fetchEngineConfiguration(
     "en-US",
-    "us"
+    "us",
+    "default"
   );
   Assert.equal(
     privateDefault.engineName,
@@ -97,7 +98,8 @@ add_task(async function() {
 
   ({ engines, privateDefault } = engineSelector.fetchEngineConfiguration(
     "zh-CN",
-    "kz"
+    "kz",
+    "default"
   ));
   Assert.equal(engines.length, 2, "Correct engines are returns");
   Assert.equal(privateDefault, null, "There should be no privateDefault");
@@ -111,7 +113,8 @@ add_task(async function() {
   Services.prefs.setCharPref("browser.search.cohort", "acohortid");
   ({ engines, privateDefault } = engineSelector.fetchEngineConfiguration(
     "en-US",
-    "us"
+    "us",
+    "default"
   ));
   Assert.deepEqual(
     engines.map(obj => obj.engineName),
@@ -120,7 +123,9 @@ add_task(async function() {
   );
 
   ({ engines, privateDefault } = engineSelector.fetchEngineConfiguration(
-    "en-US"
+    "en-US",
+    "default",
+    "default"
   ));
   Assert.deepEqual(
     engines.map(obj => obj.engineName),

toolkit/components/search/tests/xpcshell/test_engine_selector_application.js

@@ -0,0 +1,118 @@
+/* Any copyright is dedicated to the Public Domain.
+ *    http://creativecommons.org/publicdomain/zero/1.0/ */
+
+"use strict";
+
+XPCOMUtils.defineLazyModuleGetters(this, {
+  SearchEngineSelector: "resource://gre/modules/SearchEngineSelector.jsm",
+});
+
+const CONFIG_URL =
+  "data:application/json," +
+  JSON.stringify({
+    data: [
+      {
+        webExtension: {
+          id: "aol@example.com",
+        },
+        appliesTo: [
+          {
+            included: { everywhere: true },
+          },
+        ],
+        default: "yes-if-no-other",
+      },
+      {
+        webExtension: {
+          id: "lycos@example.com",
+        },
+        appliesTo: [
+          {
+            included: { everywhere: true },
+            application: {
+              channel: ["nightly"],
+            },
+          },
+        ],
+        default: "yes",
+      },
+      {
+        webExtension: {
+          id: "altavista@example.com",
+        },
+        appliesTo: [
+          {
+            included: { everywhere: true },
+            application: {
+              channel: ["nightly", "esr"],
+            },
+          },
+        ],
+      },
+      {
+        webExtension: {
+          id: "excite@example.com",
+        },
+        appliesTo: [
+          {
+            included: { everywhere: true },
+          },
+          {
+            included: { everywhere: true },
+            application: {
+              channel: ["release"],
+            },
+            default: "yes",
+          },
+        ],
+      },
+    ],
+  });
+
+const expectedEnginesPerChannel = {
+  default: ["aol@example.com", "excite@example.com"],
+  nightly: [
+    "lycos@example.com",
+    "aol@example.com",
+    "altavista@example.com",
+    "excite@example.com",
+  ],
+  beta: ["aol@example.com", "excite@example.com"],
+  release: ["excite@example.com", "aol@example.com"],
+  esr: ["aol@example.com", "altavista@example.com", "excite@example.com"],
+};
+
+const expectedDefaultEngine = {
+  default: "aol@example.com",
+  nightly: "lycos@example.com",
+  beta: "aol@example.com",
+  release: "excite@example.com",
+  esr: "aol@example.com",
+};
+
+const engineSelector = new SearchEngineSelector();
+
+add_task(async function test_engine_selector_channels() {
+  await engineSelector.init(CONFIG_URL);
+
+  for (let [channel, expected] of Object.entries(expectedEnginesPerChannel)) {
+    const { engines } = engineSelector.fetchEngineConfiguration(
+      "en-US",
+      "us",
+      channel
+    );
+
+    const engineIds = engines.map(obj => obj.webExtension.id);
+    Assert.deepEqual(
+      engineIds,
+      expected,
+      `Should have the expected engines for channel "${channel}"`
+    );
+
+    Assert.equal(
+      engineIds[0],
+      expectedDefaultEngine[channel],
+      `Should have the correct default for channel "${channel}"`
+    );
+  }
+});

toolkit/components/search/tests/xpcshell/test_engine_selector_order.js

@@ -116,7 +116,8 @@ add_task(async function() {
 
     const { engines, privateDefault } = engineSelector.fetchEngineConfiguration(
       "us",
-      "en-US"
+      "en-US",
+      "default"
     );
     let names = engines.map(obj => obj.engineName);
     Assert.deepEqual(

toolkit/components/search/tests/xpcshell/xpcshell-common.ini

@@ -17,6 +17,7 @@ skip-if = true # Is confusing
 [test_defaultPrivateEngine.js]
 [test_distribution_unreadable.js]
 skip-if = os == "win" # Windows doesn't have the same sort of permissions management.
+[test_engine_selector_application.js]
 [test_engine_selector_order.js]
 [test_engine_selector.js]
 [test_engine_set_alias.js]