fix(e2e): support headless/headful env var toggle (#6558)

sanity-io · May 14, 2024 · 92260a4 · 92260a4
1 parent 20b66b1
commit 92260a4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/playwright.config.ts b/playwright.config.ts
@@ -7,6 +7,7 @@ import {readBoolEnv, readEnv} from './test/e2e/helpers/envVars'
 loadEnvFiles()
 
 const CI = readBoolEnv('CI', false)
+const HEADLESS = readBoolEnv('HEADLESS', true)
 
 /**
  * Excludes the GitHub reporter until https://github.com/microsoft/playwright/issues/19817 is resolved, since it creates a lot of noise in our PRs.
@@ -22,13 +23,14 @@ function excludeGithub(reporters: PlaywrightTestConfig['reporter']) {
 const playwrightConfig = createPlaywrightConfig({
   projectId: readEnv('SANITY_E2E_PROJECT_ID'),
   token: readEnv('SANITY_E2E_SESSION_TOKEN'),
-  playwrightOptions(config) {
+  playwrightOptions(config): PlaywrightTestConfig {
     return {
       ...config,
       reporter: excludeGithub(config.reporter),
       use: {
         ...config.use,
         baseURL: 'http://localhost:3339',
+        headless: HEADLESS,
       },
       webServer: {
         ...config.webServer,

diff --git a/test/e2e/helpers/envVars.ts b/test/e2e/helpers/envVars.ts
@@ -3,6 +3,7 @@ type KnownEnvVar =
   | 'SANITY_E2E_PROJECT_ID'
   | 'SANITY_E2E_DATASET'
   | 'CI'
+  | 'HEADLESS'
 
 /**
  * Read an environment variable, parsing the response as a boolean, using loose