Enable Puppeteer new headless mode by default

marp-team · Sep 20, 2024 · 07c0007 · 07c0007
1 parent 78e74b8
commit 07c0007
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/src/utils/puppeteer.ts b/src/utils/puppeteer.ts
@@ -15,7 +15,11 @@ let executablePath: string | undefined | false = false
 let wslTmp: string | undefined
 
 export const enableHeadless = (): 'shell' | true =>
- process.env.PUPPETEER_HEADLESS_MODE?.toLowerCase() === 'new' ? true : 'shell'
+ ['old', 'legacy', 'shell'].includes(
+ process.env.PUPPETEER_HEADLESS_MODE?.toLowerCase() ?? ''
+ )
+ ? 'shell'
+ : true
 
 const isShebang = (path: string) => {
  let fd: number | null = null

diff --git a/test/utils/puppeteer.ts b/test/utils/puppeteer.ts
@@ -201,14 +201,14 @@ describe('#generatePuppeteerLaunchArgs', () => {
  })
 
  describe('with PUPPETEER_HEADLESS_MODE env', () => {
- it('uses legacy headless mode if PUPPETEER_HEADLESS_MODE was empty', async () => {
+ it('uses headless mode if PUPPETEER_HEADLESS_MODE was empty', async () => {
  try {
  process.env.PUPPETEER_HEADLESS_MODE = ''
 
  const { headless } =
  await puppeteerUtils().generatePuppeteerLaunchArgs()
 
- expect(headless).toBe('shell')
+ expect(headless).toBe(true)
  } finally {
  delete process.env.PUPPETEER_HEADLESS_MODE
  }
@@ -252,6 +252,19 @@ describe('#generatePuppeteerLaunchArgs', () => {
  delete process.env.PUPPETEER_HEADLESS_MODE
  }
  })
+
+ it('uses legacy headless mode if PUPPETEER_HEADLESS_MODE was "shell"', async () => {
+ try {
+ process.env.PUPPETEER_HEADLESS_MODE = 'shell'
+
+ const { headless } =
+ await puppeteerUtils().generatePuppeteerLaunchArgs()
+
+ expect(headless).toBe('shell')
+ } finally {
+ delete process.env.PUPPETEER_HEADLESS_MODE
+ }
+ })
  })
 
  describe('with CHROME_PATH env in macOS', () => {