Bug 1878731 - Convert ASRouterDefaultConfig to an ESM. r=emcminn,omc-reviewers

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

Author: mikeconley

browser/components/BrowserGlue.sys.mjs

@@ -9,6 +9,8 @@ const lazy = {};
 
 ChromeUtils.defineESModuleGetters(lazy, {
   AboutNewTab: "resource:///modules/AboutNewTab.sys.mjs",
+  ASRouterDefaultConfig:
+    "resource:///modules/asrouter/ASRouterDefaultConfig.sys.mjs",
   ASRouterNewTabHook: "resource:///modules/asrouter/ASRouterNewTabHook.sys.mjs",
   ActorManagerParent: "resource://gre/modules/ActorManagerParent.sys.mjs",
   AddonManager: "resource://gre/modules/AddonManager.sys.mjs",
@@ -98,8 +100,6 @@ ChromeUtils.defineESModuleGetters(lazy, {
 });
 
 XPCOMUtils.defineLazyModuleGetters(lazy, {
-  ASRouterDefaultConfig:
-    "resource:///modules/asrouter/ASRouterDefaultConfig.jsm",
   ASRouter: "resource:///modules/asrouter/ASRouter.jsm",
 });
 

browser/components/asrouter/actors/ASRouterParent.sys.mjs

@@ -12,9 +12,7 @@ const { ASRouterNewTabHook } = ChromeUtils.importESModule(
   "resource:///modules/asrouter/ASRouterNewTabHook.sys.mjs"
 );
 
-const { ASRouterDefaultConfig } = ChromeUtils.import(
-  "resource:///modules/asrouter/ASRouterDefaultConfig.jsm"
-);
+import { ASRouterDefaultConfig } from "resource:///modules/asrouter/ASRouterDefaultConfig.sys.mjs";
 
 export class ASRouterTabs {
   constructor({ asRouterNewTabHook }) {

browser/components/asrouter/modules/ASRouterDefaultConfig.jsm renamed to browser/components/asrouter/modules/ASRouterDefaultConfig.sys.mjs

@@ -3,31 +3,30 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-"use strict";
-
-const EXPORTED_SYMBOLS = ["ASRouterDefaultConfig"];
-
 const { ASRouter } = ChromeUtils.import(
   "resource:///modules/asrouter/ASRouter.jsm"
 );
-const { TelemetryFeed } = ChromeUtils.importESModule(
-  "resource://activity-stream/lib/TelemetryFeed.sys.mjs"
-);
-const { ASRouterParentProcessMessageHandler } = ChromeUtils.importESModule(
-  "resource:///modules/asrouter/ASRouterParentProcessMessageHandler.sys.mjs"
-);
+import { TelemetryFeed } from "resource://activity-stream/lib/TelemetryFeed.sys.mjs";
+import { ASRouterParentProcessMessageHandler } from "resource:///modules/asrouter/ASRouterParentProcessMessageHandler.sys.mjs";
+
+// We use importESModule here instead of static import so that
+// the Karma test environment won't choke on this module. This
+// is because the Karma test environment does not actually rely
+// on SpecialMessageActions, and overrides importESModule to be
+// a no-op (which can't be done for a static import statement).
+
+// eslint-disable-next-line mozilla/use-static-import
 const { SpecialMessageActions } = ChromeUtils.importESModule(
   "resource://messaging-system/lib/SpecialMessageActions.sys.mjs"
 );
+
 const { ASRouterPreferences } = ChromeUtils.import(
   "resource:///modules/asrouter/ASRouterPreferences.jsm"
 );
 const { QueryCache } = ChromeUtils.import(
   "resource:///modules/asrouter/ASRouterTargeting.jsm"
 );
-const { ActivityStreamStorage } = ChromeUtils.importESModule(
-  "resource://activity-stream/lib/ActivityStreamStorage.sys.mjs"
-);
+import { ActivityStreamStorage } from "resource://activity-stream/lib/ActivityStreamStorage.sys.mjs";
 
 const createStorage = async telemetryFeed => {
   // "snippets" is the name of one storage space, but these days it is used
@@ -53,7 +52,7 @@ const createStorage = async telemetryFeed => {
   return dbStore.getDbTable("snippets");
 };
 
-const ASRouterDefaultConfig = () => {
+export const ASRouterDefaultConfig = () => {
   const router = ASRouter;
   const telemetry = new TelemetryFeed();
   const messageHandler = new ASRouterParentProcessMessageHandler({

browser/components/asrouter/moz.build

@@ -17,7 +17,7 @@ FINAL_TARGET_FILES.actors += [
 EXTRA_JS_MODULES.asrouter += [
     "modules/ActorConstants.sys.mjs",
     "modules/ASRouter.jsm",
-    "modules/ASRouterDefaultConfig.jsm",
+    "modules/ASRouterDefaultConfig.sys.mjs",
     "modules/ASRouterNewTabHook.sys.mjs",
     "modules/ASRouterParentProcessMessageHandler.sys.mjs",
     "modules/ASRouterPreferences.jsm",

browser/components/asrouter/tests/browser/browser_asrouter_bug1800087.js

@@ -10,8 +10,8 @@
 const { ASRouterNewTabHook } = ChromeUtils.importESModule(
   "resource:///modules/asrouter/ASRouterNewTabHook.sys.mjs"
 );
-const { ASRouterDefaultConfig } = ChromeUtils.import(
-  "resource:///modules/asrouter/ASRouterDefaultConfig.jsm"
+const { ASRouterDefaultConfig } = ChromeUtils.importESModule(
+  "resource:///modules/asrouter/ASRouterDefaultConfig.sys.mjs"
 );
 
 add_setup(() => ASRouterNewTabHook.destroy());

toolkit/components/backgroundtasks/BackgroundTasksUtils.sys.mjs

@@ -29,6 +29,10 @@ XPCOMUtils.defineLazyServiceGetter(
 );
 
 ChromeUtils.defineESModuleGetters(lazy, {
+  ASRouterDefaultConfig:
+    // eslint-disable-next-line mozilla/no-browser-refs-in-toolkit
+    "resource:///modules/asrouter/ASRouterDefaultConfig.sys.mjs",
+
   ExperimentManager: "resource://nimbus/lib/ExperimentManager.sys.mjs",
 
   RemoteSettingsExperimentLoader:
@@ -39,10 +43,6 @@ XPCOMUtils.defineLazyModuleGetters(lazy, {
   ASRouter:
     // eslint-disable-next-line mozilla/no-browser-refs-in-toolkit
     "resource:///modules/asrouter/ASRouter.jsm",
-
-  ASRouterDefaultConfig:
-    // eslint-disable-next-line mozilla/no-browser-refs-in-toolkit
-    "resource:///modules/asrouter/ASRouterDefaultConfig.jsm",
 });
 
 class CannotLockProfileError extends Error {