Skip to content

Commit 7ede694

Browse files
committed
Bug 1878731 - Convert OnboardingMessageProvider to an ESM. r=emcminn,omc-reviewers
Differential Revision: https://phabricator.services.mozilla.com/D201125
1 parent 34e17ab commit 7ede694

File tree

17 files changed

+36
-31
lines changed

17 files changed

+36
-31
lines changed

browser/components/BrowserGlue.sys.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ ChromeUtils.defineESModuleGetters(lazy, {
4444
NewTabUtils: "resource://gre/modules/NewTabUtils.sys.mjs",
4545
NimbusFeatures: "resource://nimbus/ExperimentAPI.sys.mjs",
4646
Normandy: "resource://normandy/Normandy.sys.mjs",
47+
OnboardingMessageProvider:
48+
"resource:///modules/asrouter/OnboardingMessageProvider.sys.mjs",
4749
OsEnvironment: "resource://gre/modules/OsEnvironment.sys.mjs",
4850
PageActions: "resource:///modules/PageActions.sys.mjs",
4951
PageDataService: "resource:///modules/pagedata/PageDataService.sys.mjs",
@@ -99,8 +101,6 @@ XPCOMUtils.defineLazyModuleGetters(lazy, {
99101
ASRouterDefaultConfig:
100102
"resource:///modules/asrouter/ASRouterDefaultConfig.jsm",
101103
ASRouter: "resource:///modules/asrouter/ASRouter.jsm",
102-
OnboardingMessageProvider:
103-
"resource:///modules/asrouter/OnboardingMessageProvider.jsm",
104104
});
105105

106106
if (AppConstants.MOZ_UPDATER) {

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"use strict";
22

3-
const { OnboardingMessageProvider } = ChromeUtils.import(
4-
"resource:///modules/asrouter/OnboardingMessageProvider.jsm"
3+
const { OnboardingMessageProvider } = ChromeUtils.importESModule(
4+
"resource:///modules/asrouter/OnboardingMessageProvider.sys.mjs"
55
);
66
const { SpecialMessageActions } = ChromeUtils.importESModule(
77
"resource://messaging-system/lib/SpecialMessageActions.sys.mjs"

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
const { CFRMessageProvider } = ChromeUtils.importESModule(
88
"resource:///modules/asrouter/CFRMessageProvider.sys.mjs"
99
);
10-
const { OnboardingMessageProvider } = ChromeUtils.import(
11-
"resource:///modules/asrouter/OnboardingMessageProvider.jsm"
10+
const { OnboardingMessageProvider } = ChromeUtils.importESModule(
11+
"resource:///modules/asrouter/OnboardingMessageProvider.sys.mjs"
1212
);
1313
const { PanelTestProvider } = ChromeUtils.importESModule(
1414
"resource:///modules/asrouter/PanelTestProvider.sys.mjs"

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ module.exports = function (config) {
223223
path.resolve("modules/ASRouterTriggerListeners.jsm"),
224224
path.resolve("modules/CFRMessageProvider.sys.mjs"),
225225
path.resolve("modules/CFRPageActions.jsm"),
226-
path.resolve("modules/OnboardingMessageProvider.jsm"),
226+
path.resolve("modules/OnboardingMessageProvider.sys.mjs"),
227227
],
228228
},
229229
],

browser/components/asrouter/modules/ASRouter.jsm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ const { MESSAGING_EXPERIMENTS_DEFAULT_FEATURES } = ChromeUtils.importESModule(
6161
const { CFRMessageProvider } = ChromeUtils.importESModule(
6262
"resource:///modules/asrouter/CFRMessageProvider.sys.mjs"
6363
);
64-
const { OnboardingMessageProvider } = ChromeUtils.import(
64+
const { OnboardingMessageProvider } = ChromeUtils.importESModule(
6565
"resource:///modules/asrouter/OnboardingMessageProvider.jsm"
6666
);
6767
const { RemoteSettings } = ChromeUtils.importESModule(

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

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

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

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
11
/* This Source Code Form is subject to the terms of the Mozilla Public
22
* License, v. 2.0. If a copy of the MPL was not distributed with this
33
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
4-
"use strict";
54

5+
// We use importESModule here instead of static import so that
6+
// the Karma test environment won't choke on this module. This
7+
// is because the Karma test environment already stubs out
8+
// XPCOMUtils and AppConstants, and overrides importESModule
9+
// to be a no-op (which can't be done for a static import statement).
10+
11+
// eslint-disable-next-line mozilla/use-static-import
612
const { XPCOMUtils } = ChromeUtils.importESModule(
713
"resource://gre/modules/XPCOMUtils.sys.mjs"
814
);
15+
16+
// eslint-disable-next-line mozilla/use-static-import
917
const { AppConstants } = ChromeUtils.importESModule(
1018
"resource://gre/modules/AppConstants.sys.mjs"
1119
);
12-
const { FeatureCalloutMessages } = ChromeUtils.importESModule(
13-
"resource:///modules/asrouter/FeatureCalloutMessages.sys.mjs"
14-
);
20+
21+
import { FeatureCalloutMessages } from "resource:///modules/asrouter/FeatureCalloutMessages.sys.mjs";
1522

1623
const lazy = {};
1724

@@ -1208,7 +1215,7 @@ const BASE_MESSAGES = () => [
12081215
const ONBOARDING_MESSAGES = () =>
12091216
BASE_MESSAGES().concat(FeatureCalloutMessages.getMessages());
12101217

1211-
const OnboardingMessageProvider = {
1218+
export const OnboardingMessageProvider = {
12121219
async getExtraAttributes() {
12131220
const [header, button_label] = await L10N.formatMessages([
12141221
{ id: "onboarding-welcome-header" },
@@ -1404,5 +1411,3 @@ const OnboardingMessageProvider = {
14041411
return message;
14051412
},
14061413
};
1407-
1408-
const EXPORTED_SYMBOLS = ["OnboardingMessageProvider"];

browser/components/asrouter/moz.build

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ EXTRA_JS_MODULES.asrouter += [
3131
"modules/InfoBar.sys.mjs",
3232
"modules/MessagingExperimentConstants.sys.mjs",
3333
"modules/MomentsPageHub.sys.mjs",
34-
"modules/OnboardingMessageProvider.jsm",
34+
"modules/OnboardingMessageProvider.sys.mjs",
3535
"modules/PageEventManager.sys.mjs",
3636
"modules/PanelTestProvider.sys.mjs",
3737
"modules/RemoteL10n.sys.mjs",

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
const { OnboardingMessageProvider } = ChromeUtils.import(
2-
"resource:///modules/asrouter/OnboardingMessageProvider.jsm"
1+
const { OnboardingMessageProvider } = ChromeUtils.importESModule(
2+
"resource:///modules/asrouter/OnboardingMessageProvider.sys.mjs"
33
);
44
const { ToolbarBadgeHub } = ChromeUtils.importESModule(
55
"resource:///modules/asrouter/ToolbarBadgeHub.sys.mjs"

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import {
44
getSortedMessages,
55
QueryCache,
66
} from "modules/ASRouterTargeting.jsm";
7-
import { OnboardingMessageProvider } from "modules/OnboardingMessageProvider.jsm";
7+
import { OnboardingMessageProvider } from "modules/OnboardingMessageProvider.sys.mjs";
88
import { ASRouterPreferences } from "modules/ASRouterPreferences.jsm";
99
import { GlobalOverrider } from "test/unit/utils";
1010

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { _ToolbarBadgeHub } from "modules/ToolbarBadgeHub.sys.mjs";
22
import { GlobalOverrider } from "test/unit/utils";
3-
import { OnboardingMessageProvider } from "modules/OnboardingMessageProvider.jsm";
3+
import { OnboardingMessageProvider } from "modules/OnboardingMessageProvider.sys.mjs";
44
import {
55
_ToolbarPanelHub,
66
ToolbarPanelHub,

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/* Any copyright is dedicated to the Public Domain.
22
http://creativecommons.org/publicdomain/zero/1.0/ */
33

4-
const { OnboardingMessageProvider } = ChromeUtils.import(
5-
"resource:///modules/asrouter/OnboardingMessageProvider.jsm"
4+
const { OnboardingMessageProvider } = ChromeUtils.importESModule(
5+
"resource:///modules/asrouter/OnboardingMessageProvider.sys.mjs"
66
);
77
const { sinon } = ChromeUtils.importESModule(
88
"resource://testing-common/Sinon.sys.mjs"

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ const { ASRouterTargeting } = ChromeUtils.import(
1111
"resource:///modules/asrouter/ASRouterTargeting.jsm"
1212
);
1313

14-
const { OnboardingMessageProvider } = ChromeUtils.import(
15-
"resource:///modules/asrouter/OnboardingMessageProvider.jsm"
14+
const { OnboardingMessageProvider } = ChromeUtils.importESModule(
15+
"resource:///modules/asrouter/OnboardingMessageProvider.sys.mjs"
1616
);
1717

1818
async function waitForClick(selector, win) {

browser/components/tests/browser/browser_browserGlue_upgradeDialog_trigger.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ const { ExperimentFakes } = ChromeUtils.importESModule(
99
const { ExperimentAPI } = ChromeUtils.importESModule(
1010
"resource://nimbus/ExperimentAPI.sys.mjs"
1111
);
12-
const { OnboardingMessageProvider } = ChromeUtils.import(
13-
"resource:///modules/asrouter/OnboardingMessageProvider.jsm"
12+
const { OnboardingMessageProvider } = ChromeUtils.importESModule(
13+
"resource:///modules/asrouter/OnboardingMessageProvider.sys.mjs"
1414
);
1515

1616
XPCOMUtils.defineLazyServiceGetters(this, {

taskcluster/ci/source-test/python.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,7 @@ fxms-schemas:
465465
- 'browser/components/asrouter/content-src/schemas/make-schemas.py'
466466
- 'browser/components/asrouter/content-src/**/*.schema.json'
467467
- 'browser/components/asrouter/modules/CFRMessageProvider.sys.mjs'
468-
- 'browser/components/asrouter/modules/OnboardingMessageProvider.jsm'
468+
- 'browser/components/asrouter/modules/OnboardingMessageProvider.sys.mjs'
469469
- 'browser/components/asrouter/modules/PanelTestProvider.sys.mjs'
470470

471471
condprof:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33

44
"use strict";
55

6-
const { OnboardingMessageProvider } = ChromeUtils.import(
7-
"resource:///modules/asrouter/OnboardingMessageProvider.jsm"
6+
const { OnboardingMessageProvider } = ChromeUtils.importESModule(
7+
"resource:///modules/asrouter/OnboardingMessageProvider.sys.mjs"
88
);
99

1010
const { Spotlight } = ChromeUtils.importESModule(

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ Triggers and actions
180180

181181
.. _CFRMessageProvider: https://searchfox.org/mozilla-central/source/browser/components/asrouter/modules/CFRMessageProvider.jsm
182182
.. _PanelTestProvider: https://searchfox.org/mozilla-central/source/browser/components/asrouter/modules/PanelTestProvider.jsm
183-
.. _OnboardingMessageProvider: https://searchfox.org/mozilla-central/source/browser/components/asrouter/modules/OnboardingMessageProvider.jsm
183+
.. _OnboardingMessageProvider: https://searchfox.org/mozilla-central/source/browser/components/asrouter/modules/OnboardingMessageProvider.sys.mjs
184184
.. _Test_CFRMessageProvider: https://searchfox.org/mozilla-central/source/browser/components/asrouter/tests//xpcshell/test_CFMessageProvider.js
185185
.. _Test_OnboardingMessageProvider: https://searchfox.org/mozilla-central/source/browser/components/asrouter/tests//xpcshell/test_OnboardingMessageProvider.js
186186
.. _Test_PanelTestProvider: https://searchfox.org/mozilla-central/source/browser/components/asrouter/tests//xpcshell/test_PanelTestProvider.js

0 commit comments

Comments
 (0)