2067577 - Adjust lint rules to require SpecialPowers.pushPrefEnv for preference changes in browser tests

Status: RESOLVED FIXED

(Thunderbird :: General, task)

Description

[Toby Pilling [:tobyp]]

Browser tests should use SpecialPowers.pushPrefEnv() instead of directly changing preferences with Services.prefs to ensure preferences are restored automatically, including when a test fails before reaching its cleanup code.

After the direct preference changes have been migrated in bug 1982429 and bug 2066871, add ESLint enforcement for browser-test paths matching /test/*/browser/.

The lint check should report:

Services.prefs.set*Pref(...)
Services.prefs.clearUserPref(...)

The diagnostic should direct developers to use SpecialPowers.pushPrefEnv() with set or clear as appropriate.

Tests that intentionally exercise the preference service directly can use narrowly scoped ESLint exemptions.

Comment 1

[Toby Pilling [:tobyp]]

Attachment: Bug 2067577 - Require SpecialPowers.pushPrefEnv for preference changes in browser tests. r=#thunderbird-reviewers

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/566f7f744b4a
Require SpecialPowers.pushPrefEnv for preference changes in browser tests. r=mkmelin