Skip to content

Commit 5843859

Browse files
committed
docs(desktop): point fixture window composition at isCiIsolatedDisplay
Callers already use the cross-platform helper. Leave isCiLinuxDisplay as the xvfb-only predicate so tests can still assert that case.
1 parent e9cf707 commit 5843859

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

‎scripts/fixture-env.mjs‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,9 +102,9 @@ export function buildFixtureEnv(userDataDir, homeDir, options = {}) {
102102
* protocols crawl. Only that isolated virtual display gets a visible window;
103103
* nobody is watching it.
104104
*
105-
* This is the one ambient read the launch environment needs, kept out of
106-
* `buildFixtureEnv` so the builder stays a pure function. Callers compose it:
107-
* `showWindow: wantVisible || isCiLinuxDisplay()`.
105+
* This helper stays Linux-only so tests can assert the xvfb case in isolation.
106+
* Call sites that also need GitHub macOS runners (App Nap) should compose
107+
* `isCiIsolatedDisplay()` instead.
108108
*
109109
* @param {NodeJS.ProcessEnv} [env]
110110
* @param {NodeJS.Platform} [platform]
@@ -118,6 +118,10 @@ export function isCiLinuxDisplay(env = process.env, platform = process.platform)
118118
* xvfb; GitHub's macOS runners App-Nap background windows the same way. Local
119119
* developer machines stay hidden so a suite does not steal focus.
120120
*
121+
* This is the ambient read the launch environment needs, kept out of
122+
* `buildFixtureEnv` so the builder stays a pure function. Callers compose it:
123+
* `showWindow: wantVisible || isCiIsolatedDisplay()`.
124+
*
121125
* @param {NodeJS.ProcessEnv} [env]
122126
* @param {NodeJS.Platform} [platform]
123127
*/

0 commit comments

Comments
 (0)