1784699 - ESLint xpcshell test environment should not use the browser environment

Status: RESOLVED FIXED

(Developer Infrastructure :: Lint and Formatting, task, P2)

Description

[Mark Banner (:standard8)]

ESlint's current set-up for xpcshell-tests has the browser environment enabled for that configuration.

This means that items like window, top, name are defined as available in xpcshell-tests, even though they aren't. This hides various bugs, e.g. bug 1784698 and bug 1784697.

As the browser environment is inherited from the main configuration, we need to explicitly turn it off for xpcshell-tests. We can use the priviledged environment for most of the globals that are available to xpcshell.

Comment 1

[Mark Banner (:standard8)]

Try push: https://treeherder.mozilla.org/jobs?repo=try&revision=52e49ce7496b64f5d95b5c30b63d2f654baf6813

Comment 2

[Mark Banner (:standard8)]

Attachment: Bug 1784699 - Correct globals for PAC tests and clarify where they are obtained. r?#necko-reviewers

Depends on D154592

Comment 3

[Mark Banner (:standard8)]

Attachment: Bug 1784699 - Ignore ESLint no-undef warnings in xpcshell-tests where functions are processed in other scopes. r?arai

Depends on D154599

Comment 4

[Mark Banner (:standard8)]

Attachment: Bug 1784699 - Add more ESLint worker annotations to test files. r?arai

Depends on D154600

Comment 5

[Mark Banner (:standard8)]

Attachment: Bug 1784699 - Add Readable/WriteableStream related globals to the list of privileged globals for ESLint. r?arai

Depends on D154601

Comment 6

[Mark Banner (:standard8)]

Attachment: Bug 1784699 - Add some more globals to ESLint xpcshell environment. r?arai

Depends on D154602

Comment 7

[Mark Banner (:standard8)]

Attachment: Bug 1784699 - Move the ESLint Intl definition across to the privileged environment as it fits better there. r?arai

Depends on D154603

Comment 8

[Mark Banner (:standard8)]

Attachment: Bug 1784699 - Add WebAssembly to the ESLint list of privileged globals. r?arai

Depends on D154604

Comment 9

[Mark Banner (:standard8)]

Attachment: Bug 1784699 - Turn off the ESLint browser environment for xpcshell-tests for better represetation of the globals actually available. r?arai

Depends on D154605

Comment 10

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/9cb6ae0b0a6a
Correct globals for PAC tests and clarify where they are obtained. r=necko-reviewers,kershaw
https://hg.mozilla.org/integration/autoland/rev/b93e9f9ddaf8
Ignore ESLint no-undef warnings in xpcshell-tests where functions are processed in other scopes. r=arai,necko-reviewers,kershaw
https://hg.mozilla.org/integration/autoland/rev/fc8e6a61aa51
Add more ESLint worker annotations to test files. r=arai
https://hg.mozilla.org/integration/autoland/rev/afe3ecd91af3
Add Readable/WriteableStream related globals to the list of privileged globals for ESLint. r=arai
https://hg.mozilla.org/integration/autoland/rev/5c0c85ccff5b
Add some more globals to ESLint xpcshell environment. r=arai,application-update-reviewers,bytesized
https://hg.mozilla.org/integration/autoland/rev/ec16c2001460
Move the ESLint Intl definition across to the privileged environment as it fits better there. r=arai
https://hg.mozilla.org/integration/autoland/rev/244de9031beb
Add WebAssembly to the ESLint list of privileged globals. r=arai
https://hg.mozilla.org/integration/autoland/rev/fd501b7a23c3
Turn off the ESLint browser environment for xpcshell-tests for better represetation of the globals actually available. r=arai

Comment 11

[Norisz Fay [:noriszfay]]

https://hg.mozilla.org/mozilla-central/rev/9cb6ae0b0a6a
https://hg.mozilla.org/mozilla-central/rev/b93e9f9ddaf8
https://hg.mozilla.org/mozilla-central/rev/fc8e6a61aa51
https://hg.mozilla.org/mozilla-central/rev/afe3ecd91af3
https://hg.mozilla.org/mozilla-central/rev/5c0c85ccff5b
https://hg.mozilla.org/mozilla-central/rev/ec16c2001460
https://hg.mozilla.org/mozilla-central/rev/244de9031beb
https://hg.mozilla.org/mozilla-central/rev/fd501b7a23c3

Comment 12

[Geoff Lankow (:darktrojan)]

Attachment: Port Bug 1784699 - Turn off the ESLint browser environment for xpcshell-tests. r=#thunderbird-reviewers

Re-enables the browser environment in WebExtensions tests (as in the m-c patch) and in alertTestUtils.js lists alert, confirm, and prompt as globals because they're likely to be defined by the test.

Comment 13

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/9dbbedf44c62
Port Bug 1784699 - Turn off the ESLint browser environment for xpcshell-tests. r=#thunderbird-reviewers,mkmelin

Comment 14

[BugBot [:suhaib / :marco/ :calixte]]

A patch has been attached on this bug, which was already closed. Filing a separate bug will ensure better tracking. If this was not by mistake and further action is needed, please alert the appropriate party. (Or: if the patch doesn't change behavior -- e.g. landing a test case, or fixing a typo -- then feel free to disregard this message)