1765156 - Provide the equivalent of ChromeUtils.import via SpecialPowers

Status: RESOLVED FIXED

(Testing :: Mochitest, task)

Description

[Tooru Fujisawa [:arai]]

Currently SpecialPowers provides JSM import feature by SpecialPowers.Cu.import, but it has difference between ChromeUtils.import.

ChromeUtils.import returns exports object, but SpecialPowers.Cu.import returns global object.
The former supports lexical variables, but the latter doesn't have them, so
the latter requires variables defined on the JSM's global this property.

To my understanding, this is part of the reason why we have this.Foo = Foo in JSM code.

We can temporarily provide SpecialPowers.ChromeUtils_import or something that performs ChromeUtils.import, and replace SpecialPowers.Cu.import with it,
and then remove this.Foo = Foo in JSM code.

Comment 1

[Tooru Fujisawa [:arai]]

bug 1765167 needs SpecialPowers.ChromeUtils_import, to replace the Cu.import usage in EventUtils.js
https://searchfox.org/mozilla-central/rev/4b3039b48c3cb67774270ebcc2a7d8624d888092/testing/mochitest/tests/SimpleTest/EventUtils.js#61

Comment 2

[Andrew McCreight [:mccr8]]

This should probably be in Testing::Mochitest or something along those lines, rather than Firefox::General.

Comment 3

[Tooru Fujisawa [:arai]]

Given bug 1758481, it would make sense to drop the 2nd parameter from SpecialPowers.ChromeUtils_import implementation,
to avoid adding more consumer of the 2nd parameter.

Comment 4

[Tooru Fujisawa [:arai]]

Attachment: Bug 1765156 - Part 1: Add SpecialPowers.ChromeUtils. r?kmag!

Depends on D144081

Comment 5

[Tooru Fujisawa [:arai]]

Attachment: Bug 1765156 - Part 2: Use SpecialPowers.ChromeUtils.import in browser/. r=kmag!

Depends on D144082

Comment 6

[Tooru Fujisawa [:arai]]

Attachment: Bug 1765156 - Part 3: Use SpecialPowers.ChromeUtils.import in dom/. r=kmag!

Depends on D144083

Comment 7

[Tooru Fujisawa [:arai]]

Attachment: Bug 1765156 - Part 4: Use SpecialPowers.ChromeUtils.import in editor/. r=kmag!

Depends on D144084

Comment 8

[Tooru Fujisawa [:arai]]

Attachment: Bug 1765156 - Part 5: Use SpecialPowers.ChromeUtils.import in extensions/. r=kmag!

Depends on D144085

Comment 9

[Tooru Fujisawa [:arai]]

Attachment: Bug 1765156 - Part 6: Use SpecialPowers.ChromeUtils.import in js/xpconnect/. r=kmag!

Depends on D144086

Comment 10

[Tooru Fujisawa [:arai]]

Attachment: Bug 1765156 - Part 7: Use SpecialPowers.ChromeUtils.import in layout/. r=kmag!

Depends on D144087

Comment 11

[Tooru Fujisawa [:arai]]

Attachment: Bug 1765156 - Part 8: Use SpecialPowers.ChromeUtils.import in mobile/. r=kmag!

Depends on D144088

Comment 12

[Tooru Fujisawa [:arai]]

Attachment: Bug 1765156 - Part 9: Use SpecialPowers.ChromeUtils.import in testing/. r=kmag!

Depends on D144089

Comment 13

[Tooru Fujisawa [:arai]]

Attachment: Bug 1765156 - Part 10: Use SpecialPowers.ChromeUtils.import in toolkit/components/extensions/. r=kmag!

Depends on D144090

Comment 14

[Tooru Fujisawa [:arai]]

Attachment: Bug 1765156 - Part 11: Use SpecialPowers.ChromeUtils.import in toolkit/components/passwordmgr/. r=kmag!

Depends on D144091

Comment 15

[Tooru Fujisawa [:arai]]

Attachment: Bug 1765156 - Part 12: Use SpecialPowers.ChromeUtils.import in toolkit/. r=kmag!

Depends on D144092

Comment 16

[Tooru Fujisawa [:arai]]

:mccr8, can I have your opinion about the API design here?
The current WIP patches above adds SpecialPowers.ChromeUtils_import function with single parameter.

The other possibility are:

• Expose the entire ChromeUtils as SpecialPowers.ChromeUtils, and let the consumer call SpecialPowers.ChromeUtils.import
• Expose ChromeUtils.import as SpecialPowers.import or something with shorter name

Comment 17

[Andrew McCreight [:mccr8]]

Kris is probably a better person to ask about this.

Comment 18

[Kris Maglione [:kmag]]

I would lean towards just exposing SpecialPowers.ChromeUtils, but I would also be OK with SpecialPowers.import

Comment 19

[Tooru Fujisawa [:arai]]

Note for testing
Some pre-existing test-verify failures are expected with this patch stack.

Comment 20

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/c754789316ab
Part 1: Add SpecialPowers.ChromeUtils. r=kmag
https://hg.mozilla.org/integration/autoland/rev/1c2a9d039e65
Part 2: Use SpecialPowers.ChromeUtils.import in browser/. r=kmag
https://hg.mozilla.org/integration/autoland/rev/ca2494740fc0
Part 3: Use SpecialPowers.ChromeUtils.import in dom/. r=kmag
https://hg.mozilla.org/integration/autoland/rev/534748aa61db
Part 4: Use SpecialPowers.ChromeUtils.import in editor/. r=kmag
https://hg.mozilla.org/integration/autoland/rev/dd7eb05d40c9
Part 5: Use SpecialPowers.ChromeUtils.import in extensions/. r=kmag
https://hg.mozilla.org/integration/autoland/rev/ff0e0d60d30c
Part 6: Use SpecialPowers.ChromeUtils.import in js/xpconnect/. r=kmag
https://hg.mozilla.org/integration/autoland/rev/bb3c4b716945
Part 7: Use SpecialPowers.ChromeUtils.import in layout/. r=kmag
https://hg.mozilla.org/integration/autoland/rev/a06b5b3f366d
Part 8: Use SpecialPowers.ChromeUtils.import in mobile/. r=geckoview-reviewers,agi
https://hg.mozilla.org/integration/autoland/rev/6c4e9b18e436
Part 9: Use SpecialPowers.ChromeUtils.import in testing/. r=kmag
https://hg.mozilla.org/integration/autoland/rev/4f77ac47c966
Part 10: Use SpecialPowers.ChromeUtils.import in toolkit/components/extensions/. r=kmag
https://hg.mozilla.org/integration/autoland/rev/c1cc78ae7763
Part 11: Use SpecialPowers.ChromeUtils.import in toolkit/components/passwordmgr/. r=kmag
https://hg.mozilla.org/integration/autoland/rev/29adb3089e10
Part 12: Use SpecialPowers.ChromeUtils.import in toolkit/. r=kmag

Comment 21

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/c754789316ab
https://hg.mozilla.org/mozilla-central/rev/1c2a9d039e65
https://hg.mozilla.org/mozilla-central/rev/ca2494740fc0
https://hg.mozilla.org/mozilla-central/rev/534748aa61db
https://hg.mozilla.org/mozilla-central/rev/dd7eb05d40c9
https://hg.mozilla.org/mozilla-central/rev/ff0e0d60d30c
https://hg.mozilla.org/mozilla-central/rev/bb3c4b716945
https://hg.mozilla.org/mozilla-central/rev/a06b5b3f366d
https://hg.mozilla.org/mozilla-central/rev/6c4e9b18e436
https://hg.mozilla.org/mozilla-central/rev/4f77ac47c966
https://hg.mozilla.org/mozilla-central/rev/c1cc78ae7763
https://hg.mozilla.org/mozilla-central/rev/29adb3089e10