1780543 - Audit eslint-env mozilla/frame-script consumer

Status: RESOLVED FIXED

(Developer Infrastructure :: Lint and Formatting, task)

Description

[Tooru Fujisawa [:arai]]

Frame scripts are supposed to have /* eslint-env mozilla/frame-script */ line, but there are 2 problematic cases:

• the file is a frame script, but it doesn't have /* eslint-env mozilla/frame-script */ line
• the file is not a frame script, but it has /* eslint-env mozilla/frame-script */ line

One case of the latter is remote page scripts, that has subset of frame-script environment this is unrelated environment.
We should add dedicate environment for it and use it instead.

https://searchfox.org/mozilla-central/rev/a352cc827575823676717d53766c39710b54201a/toolkit/components/remotepagemanager/RemotePageManagerChild.jsm#23-33

Cu.exportFunction(this.sendAsyncMessage.bind(this), window, {
  defineAs: "RPMSendAsyncMessage",
});
Cu.exportFunction(this.addMessageListener.bind(this), window, {
  defineAs: "RPMAddMessageListener",
  allowCallbacks: true,
});
Cu.exportFunction(this.removeMessageListener.bind(this), window, {
  defineAs: "RPMRemoveMessageListener",
  allowCallbacks: true,
});

Comment 1

[Tooru Fujisawa [:arai]]

looks like I misunderstood about RPM* propreties defined in frame-script.js.

mozilla/frame-script definition seems to have mix of frame script and remote pages,
and RPM* properties must be moved to remote page environment.

Comment 2

[Tooru Fujisawa [:arai]]

Attachment: Bug 1780543 - Part 1: Use eslint-env mozilla/frame-script consistently in frame script. r?Standard8!

Comment 3

[Tooru Fujisawa [:arai]]

Attachment: Bug 1780543 - Part 2: Use eslint-env mozilla/frame-script consistently in test frame script. r?Standard8!

Depends on D152426

Comment 4

[Tooru Fujisawa [:arai]]

Attachment: Bug 1780543 - Part 3: Add mozilla/process-script environment as alias to frame-script. r?Standard8!

Depends on D152427

Comment 5

[Tooru Fujisawa [:arai]]

Attachment: Bug 1780543 - Part 4: Add mozilla/remote-page environment. r?Standard8!

Depends on D152428

Comment 6

[Tooru Fujisawa [:arai]]

Attachment: Bug 1780543 - Part 5: Add mozilla/chrome-script environment. r?Standard8!

Depends on D152429

Comment 7

[Tooru Fujisawa [:arai]]

Attachment: Bug 1780543 - Part 6: Stop using mozilla/frame-script in unrelated files. r?Standard8!

Depends on D152430

Comment 8

[Tooru Fujisawa [:arai]]

Attachment: Bug 1780543 - Part 7: Update frame-script and process-script environment. r?Standard8!

Depends on D152431

Comment 9

[Mark Banner (:standard8)]

Thank you for working on this, it is really nice to have these split up into more meaningful names and scopes.

In addition to my document comments, please could you update this section of the docs? Probably pointing it to the environment page would be helpful.

Comment 10

[Tooru Fujisawa [:arai]]

Attachment: Bug 1780543 - Part 8: Remove unused eslint rule. r?Standard8!

Depends on D152432

Comment 11

[Tooru Fujisawa [:arai]]

Attachment: Bug 1780543 - Part 9: Move SpecialPowers sandbox global definition into separate file. r?Standard8!

Also define Components and Services, that's enabled by default on sandbox.

Depends on D152646

Comment 12

[Tooru Fujisawa [:arai]]

Attachment: Bug 1780543 - Part 10: Use SpecialPowers sandbox definition in import-content-task-globals.js. r?Standard8!

Also update the list of variables.

Depends on D152647

Comment 13

[Tooru Fujisawa [:arai]]

Attachment: Bug 1780543 - Part 11: Update document for environment. r?Standard8!

Depends on D152648

Comment 14

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/b3feda5b27e1
Part 1: Use eslint-env mozilla/frame-script consistently in frame script. r=Standard8,webdriver-reviewers,geckoview-reviewers,jdescottes,calu
https://hg.mozilla.org/integration/autoland/rev/ae908c7f89f2
Part 2: Use eslint-env mozilla/frame-script consistently in test frame script. r=Standard8,webdriver-reviewers,perftest-reviewers,sparky,jdescottes
https://hg.mozilla.org/integration/autoland/rev/e0ba4db5a86b
Part 3: Add mozilla/process-script environment as alias to frame-script. r=Standard8,perftest-reviewers,webcompat-reviewers,necko-reviewers,twisniewski,sparky,dragana
https://hg.mozilla.org/integration/autoland/rev/3b36e3518d0f
Part 4: Add mozilla/remote-page environment. r=Standard8
https://hg.mozilla.org/integration/autoland/rev/fe18343ba5e6
Part 5: Add mozilla/chrome-script environment. r=Standard8
https://hg.mozilla.org/integration/autoland/rev/d17b9468e8e1
Part 6: Stop using mozilla/frame-script in unrelated files. r=Standard8,necko-reviewers,dragana
https://hg.mozilla.org/integration/autoland/rev/6c9f57ac30c3
Part 7: Update frame-script and process-script environment. r=Standard8
https://hg.mozilla.org/integration/autoland/rev/2751a3bb2d57
Part 8: Remove unused eslint rule. r=Standard8,geckoview-reviewers,calu
https://hg.mozilla.org/integration/autoland/rev/54b6884df84e
Part 9: Move SpecialPowers sandbox global definition into separate file. r=Standard8
https://hg.mozilla.org/integration/autoland/rev/dda806f50320
Part 10: Use SpecialPowers sandbox definition in import-content-task-globals.js. r=Standard8
https://hg.mozilla.org/integration/autoland/rev/b1c809ded882
Part 11: Update document for environment. r=Standard8

Comment 15

[Marian-Vasile Laza]

https://hg.mozilla.org/mozilla-central/rev/b3feda5b27e1
https://hg.mozilla.org/mozilla-central/rev/ae908c7f89f2
https://hg.mozilla.org/mozilla-central/rev/e0ba4db5a86b
https://hg.mozilla.org/mozilla-central/rev/3b36e3518d0f
https://hg.mozilla.org/mozilla-central/rev/fe18343ba5e6
https://hg.mozilla.org/mozilla-central/rev/d17b9468e8e1
https://hg.mozilla.org/mozilla-central/rev/6c9f57ac30c3
https://hg.mozilla.org/mozilla-central/rev/2751a3bb2d57
https://hg.mozilla.org/mozilla-central/rev/54b6884df84e
https://hg.mozilla.org/mozilla-central/rev/dda806f50320
https://hg.mozilla.org/mozilla-central/rev/b1c809ded882