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

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

Author: mikeconley

browser/components/BrowserGlue.sys.mjs

@@ -44,6 +44,8 @@ ChromeUtils.defineESModuleGetters(lazy, {
   NewTabUtils: "resource://gre/modules/NewTabUtils.sys.mjs",
   NimbusFeatures: "resource://nimbus/ExperimentAPI.sys.mjs",
   Normandy: "resource://normandy/Normandy.sys.mjs",
+  OnboardingMessageProvider:
+    "resource:///modules/asrouter/OnboardingMessageProvider.sys.mjs",
   OsEnvironment: "resource://gre/modules/OsEnvironment.sys.mjs",
   PageActions: "resource:///modules/PageActions.sys.mjs",
   PageDataService: "resource:///modules/pagedata/PageDataService.sys.mjs",
@@ -99,8 +101,6 @@ XPCOMUtils.defineLazyModuleGetters(lazy, {
   ASRouterDefaultConfig:
     "resource:///modules/asrouter/ASRouterDefaultConfig.jsm",
   ASRouter: "resource:///modules/asrouter/ASRouter.jsm",
-  OnboardingMessageProvider:
-    "resource:///modules/asrouter/OnboardingMessageProvider.jsm",
 });
 
 if (AppConstants.MOZ_UPDATER) {

browser/components/aboutwelcome/tests/browser/browser_aboutwelcome_upgrade_multistage_mr.js

@@ -1,7 +1,7 @@
 "use strict";
 
-const { OnboardingMessageProvider } = ChromeUtils.import(
-  "resource:///modules/asrouter/OnboardingMessageProvider.jsm"
+const { OnboardingMessageProvider } = ChromeUtils.importESModule(
+  "resource:///modules/asrouter/OnboardingMessageProvider.sys.mjs"
 );
 const { SpecialMessageActions } = ChromeUtils.importESModule(
   "resource://messaging-system/lib/SpecialMessageActions.sys.mjs"

browser/components/asrouter/content-src/schemas/extract-test-corpus.js

@@ -7,8 +7,8 @@
 const { CFRMessageProvider } = ChromeUtils.importESModule(
   "resource:///modules/asrouter/CFRMessageProvider.sys.mjs"
 );
-const { OnboardingMessageProvider } = ChromeUtils.import(
-  "resource:///modules/asrouter/OnboardingMessageProvider.jsm"
+const { OnboardingMessageProvider } = ChromeUtils.importESModule(
+  "resource:///modules/asrouter/OnboardingMessageProvider.sys.mjs"
 );
 const { PanelTestProvider } = ChromeUtils.importESModule(
   "resource:///modules/asrouter/PanelTestProvider.sys.mjs"

browser/components/asrouter/karma.mc.config.js

@@ -223,7 +223,7 @@ module.exports = function (config) {
               path.resolve("modules/ASRouterTriggerListeners.jsm"),
               path.resolve("modules/CFRMessageProvider.sys.mjs"),
               path.resolve("modules/CFRPageActions.jsm"),
-              path.resolve("modules/OnboardingMessageProvider.jsm"),
+              path.resolve("modules/OnboardingMessageProvider.sys.mjs"),
             ],
           },
         ],

browser/components/asrouter/modules/ASRouter.jsm

@@ -61,7 +61,7 @@ const { MESSAGING_EXPERIMENTS_DEFAULT_FEATURES } = ChromeUtils.importESModule(
 const { CFRMessageProvider } = ChromeUtils.importESModule(
   "resource:///modules/asrouter/CFRMessageProvider.sys.mjs"
 );
-const { OnboardingMessageProvider } = ChromeUtils.import(
+const { OnboardingMessageProvider } = ChromeUtils.importESModule(
   "resource:///modules/asrouter/OnboardingMessageProvider.jsm"
 );
 const { RemoteSettings } = ChromeUtils.importESModule(

browser/components/asrouter/modules/FeatureCalloutMessages.sys.mjs

@@ -4,7 +4,7 @@
 
 // Eventually, make this a messaging system
 // provider instead of adding these message
-// into OnboardingMessageProvider.jsm
+// into OnboardingMessageProvider.sys.mjs
 const FIREFOX_VIEW_PREF = "browser.firefox-view.feature-tour";
 const PDFJS_PREF = "browser.pdfjs.feature-tour";
 // Empty screens are included as placeholders to ensure step

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

@@ -1,17 +1,24 @@
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * 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";
 
+// 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 already stubs out
+// XPCOMUtils and AppConstants, 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 { XPCOMUtils } = ChromeUtils.importESModule(
   "resource://gre/modules/XPCOMUtils.sys.mjs"
 );
+
+// eslint-disable-next-line mozilla/use-static-import
 const { AppConstants } = ChromeUtils.importESModule(
   "resource://gre/modules/AppConstants.sys.mjs"
 );
-const { FeatureCalloutMessages } = ChromeUtils.importESModule(
-  "resource:///modules/asrouter/FeatureCalloutMessages.sys.mjs"
-);
+
+import { FeatureCalloutMessages } from "resource:///modules/asrouter/FeatureCalloutMessages.sys.mjs";
 
 const lazy = {};
 
@@ -1208,7 +1215,7 @@ const BASE_MESSAGES = () => [
 const ONBOARDING_MESSAGES = () =>
   BASE_MESSAGES().concat(FeatureCalloutMessages.getMessages());
 
-const OnboardingMessageProvider = {
+export const OnboardingMessageProvider = {
   async getExtraAttributes() {
     const [header, button_label] = await L10N.formatMessages([
       { id: "onboarding-welcome-header" },
@@ -1404,5 +1411,3 @@ const OnboardingMessageProvider = {
     return message;
   },
 };
-
-const EXPORTED_SYMBOLS = ["OnboardingMessageProvider"];

browser/components/asrouter/moz.build

@@ -31,7 +31,7 @@ EXTRA_JS_MODULES.asrouter += [
     "modules/InfoBar.sys.mjs",
     "modules/MessagingExperimentConstants.sys.mjs",
     "modules/MomentsPageHub.sys.mjs",
-    "modules/OnboardingMessageProvider.jsm",
+    "modules/OnboardingMessageProvider.sys.mjs",
     "modules/PageEventManager.sys.mjs",
     "modules/PanelTestProvider.sys.mjs",
     "modules/RemoteL10n.sys.mjs",

browser/components/asrouter/tests/browser/browser_asrouter_toolbarbadge.js

@@ -1,5 +1,5 @@
-const { OnboardingMessageProvider } = ChromeUtils.import(
-  "resource:///modules/asrouter/OnboardingMessageProvider.jsm"
+const { OnboardingMessageProvider } = ChromeUtils.importESModule(
+  "resource:///modules/asrouter/OnboardingMessageProvider.sys.mjs"
 );
 const { ToolbarBadgeHub } = ChromeUtils.importESModule(
   "resource:///modules/asrouter/ToolbarBadgeHub.sys.mjs"

browser/components/asrouter/tests/unit/ASRouterTargeting.test.js

@@ -4,7 +4,7 @@ import {
   getSortedMessages,
   QueryCache,
 } from "modules/ASRouterTargeting.jsm";
-import { OnboardingMessageProvider } from "modules/OnboardingMessageProvider.jsm";
+import { OnboardingMessageProvider } from "modules/OnboardingMessageProvider.sys.mjs";
 import { ASRouterPreferences } from "modules/ASRouterPreferences.jsm";
 import { GlobalOverrider } from "test/unit/utils";
 

browser/components/asrouter/tests/unit/ToolbarBadgeHub.test.js

@@ -1,6 +1,6 @@
 import { _ToolbarBadgeHub } from "modules/ToolbarBadgeHub.sys.mjs";
 import { GlobalOverrider } from "test/unit/utils";
-import { OnboardingMessageProvider } from "modules/OnboardingMessageProvider.jsm";
+import { OnboardingMessageProvider } from "modules/OnboardingMessageProvider.sys.mjs";
 import {
   _ToolbarPanelHub,
   ToolbarPanelHub,

browser/components/asrouter/tests/xpcshell/test_OnboardingMessageProvider.js

@@ -1,8 +1,8 @@
 /* Any copyright is dedicated to the Public Domain.
    http://creativecommons.org/publicdomain/zero/1.0/ */
 
-const { OnboardingMessageProvider } = ChromeUtils.import(
-  "resource:///modules/asrouter/OnboardingMessageProvider.jsm"
+const { OnboardingMessageProvider } = ChromeUtils.importESModule(
+  "resource:///modules/asrouter/OnboardingMessageProvider.sys.mjs"
 );
 const { sinon } = ChromeUtils.importESModule(
   "resource://testing-common/Sinon.sys.mjs"

browser/components/newtab/test/browser/browser_foxdoodle_set_default.js

@@ -11,8 +11,8 @@ const { ASRouterTargeting } = ChromeUtils.import(
   "resource:///modules/asrouter/ASRouterTargeting.jsm"
 );
 
-const { OnboardingMessageProvider } = ChromeUtils.import(
-  "resource:///modules/asrouter/OnboardingMessageProvider.jsm"
+const { OnboardingMessageProvider } = ChromeUtils.importESModule(
+  "resource:///modules/asrouter/OnboardingMessageProvider.sys.mjs"
 );
 
 async function waitForClick(selector, win) {

browser/components/tests/browser/browser_browserGlue_upgradeDialog_trigger.js

@@ -9,8 +9,8 @@ const { ExperimentFakes } = ChromeUtils.importESModule(
 const { ExperimentAPI } = ChromeUtils.importESModule(
   "resource://nimbus/ExperimentAPI.sys.mjs"
 );
-const { OnboardingMessageProvider } = ChromeUtils.import(
-  "resource:///modules/asrouter/OnboardingMessageProvider.jsm"
+const { OnboardingMessageProvider } = ChromeUtils.importESModule(
+  "resource:///modules/asrouter/OnboardingMessageProvider.sys.mjs"
 );
 
 XPCOMUtils.defineLazyServiceGetters(this, {

taskcluster/ci/source-test/python.yml

@@ -465,7 +465,7 @@ fxms-schemas:
             - 'browser/components/asrouter/content-src/schemas/make-schemas.py'
             - 'browser/components/asrouter/content-src/**/*.schema.json'
             - 'browser/components/asrouter/modules/CFRMessageProvider.sys.mjs'
-            - 'browser/components/asrouter/modules/OnboardingMessageProvider.jsm'
+            - 'browser/components/asrouter/modules/OnboardingMessageProvider.sys.mjs'
             - 'browser/components/asrouter/modules/PanelTestProvider.sys.mjs'
 
 condprof:

toolkit/components/messaging-system/schemas/SpecialMessageActionSchemas/test/browser/browser_sma_open_spotlight_dialog.js

@@ -3,8 +3,8 @@
 
 "use strict";
 
-const { OnboardingMessageProvider } = ChromeUtils.import(
-  "resource:///modules/asrouter/OnboardingMessageProvider.jsm"
+const { OnboardingMessageProvider } = ChromeUtils.importESModule(
+  "resource:///modules/asrouter/OnboardingMessageProvider.sys.mjs"
 );
 
 const { Spotlight } = ChromeUtils.importESModule(

toolkit/components/messaging-system/schemas/index.rst

@@ -180,7 +180,7 @@ Triggers and actions
 
 ..  _CFRMessageProvider: https://searchfox.org/mozilla-central/source/browser/components/asrouter/modules/CFRMessageProvider.jsm
 ..  _PanelTestProvider: https://searchfox.org/mozilla-central/source/browser/components/asrouter/modules/PanelTestProvider.jsm
-..  _OnboardingMessageProvider: https://searchfox.org/mozilla-central/source/browser/components/asrouter/modules/OnboardingMessageProvider.jsm
+..  _OnboardingMessageProvider: https://searchfox.org/mozilla-central/source/browser/components/asrouter/modules/OnboardingMessageProvider.sys.mjs
 ..  _Test_CFRMessageProvider: https://searchfox.org/mozilla-central/source/browser/components/asrouter/tests//xpcshell/test_CFMessageProvider.js
 ..  _Test_OnboardingMessageProvider: https://searchfox.org/mozilla-central/source/browser/components/asrouter/tests//xpcshell/test_OnboardingMessageProvider.js
 ..  _Test_PanelTestProvider: https://searchfox.org/mozilla-central/source/browser/components/asrouter/tests//xpcshell/test_PanelTestProvider.js