Handle errors when browser launching fails (#78)

Author: calebeby

.changeset/wicked-pumpkins-join.md

@@ -0,0 +1,5 @@
+---
+'pleasantest': patch
+---
+
+Handle errors thrown by browser launcher instead of silently hanging

src/connect-to-browser.ts

@@ -121,12 +121,24 @@ export const connectToBrowser = async (
     detached: true,
     stdio: 'ignore',
   });
-  const wsEndpoint = await new Promise<string>((resolve) => {
+  const wsEndpoint = await new Promise<string>((resolve, reject) => {
     subprocess.send({ browser, headless });
     subprocess.on('message', (msg: any) => {
+      if (msg.error)
+        return reject(new Error(`Failed to start browser: ${msg.error}`));
       if (!msg.browserWSEndpoint) return;
       resolve(msg.browserWSEndpoint);
     });
+  }).catch(async (error) => {
+    subprocess.kill();
+    valueWrittenInMeantime = await updateConfig(
+      configPath,
+      browser,
+      headless,
+      '',
+      'starting',
+    );
+    throw error;
   });
   valueWrittenInMeantime = await updateConfig(
     configPath,

src/start-disowned-browser.ts

@@ -4,52 +4,56 @@ import { promises as fs } from 'fs';
 import puppeteer from 'puppeteer';
 
 process.on('message', async ({ browser, headless }) => {
-  if (browser !== 'chromium')
-    throw new Error(`unrecognized browser: ${browser}`);
-  if (typeof headless !== 'boolean')
-    throw new Error('headless must be a boolean');
+  try {
+    if (browser !== 'chromium')
+      throw new Error(`unrecognized browser: ${browser}`);
+    if (typeof headless !== 'boolean')
+      throw new Error('headless must be a boolean');
 
-  let userDataDir: string | undefined;
-  if (browser === 'chromium') {
-    userDataDir = await fs.mkdtemp(os.tmpdir() + path.sep);
-    const prefs = JSON.stringify({
-      devtools: {
-        preferences: {
-          'panel-selectedTab': JSON.stringify('console'),
-          currentDockState: JSON.stringify('right'),
-          'InspectorView.splitViewState': JSON.stringify({
-            horizontal: { size: 600 },
-            vertical: { size: 450 },
-          }),
+    let userDataDir: string | undefined;
+    if (browser === 'chromium') {
+      userDataDir = await fs.mkdtemp(os.tmpdir() + path.sep);
+      const prefs = JSON.stringify({
+        devtools: {
+          preferences: {
+            'panel-selectedTab': JSON.stringify('console'),
+            currentDockState: JSON.stringify('right'),
+            'InspectorView.splitViewState': JSON.stringify({
+              horizontal: { size: 600 },
+              vertical: { size: 450 },
+            }),
+          },
         },
-      },
+      });
+      const prefsPath = path.join(userDataDir, 'Default', 'Preferences');
+      await fs.mkdir(path.dirname(prefsPath), { recursive: true });
+      await fs.writeFile(prefsPath, prefs);
+    }
+
+    const browserInstance = await puppeteer.launch({
+      headless,
+      devtools: !headless,
+      ignoreDefaultArgs: [
+        // Don't pop up "Chrome is being controlled by automated software"
+        '--enable-automation',
+        // Unsupported flag that pops up a warning
+        '--enable-blink-features=IdleDetection',
+      ],
+      args: [
+        // Don't pop up "Chrome is not your default browser"
+        '--no-default-browser-check',
+        '--disable-features=ChromeLabs', // Remove little beaker icon next to URL bar
+      ],
+      userDataDir,
     });
-    const prefsPath = path.join(userDataDir, 'Default', 'Preferences');
-    await fs.mkdir(path.dirname(prefsPath), { recursive: true });
-    await fs.writeFile(prefsPath, prefs);
+    const allPages = await browserInstance.pages();
+    // Close startup page
+    await Promise.all(allPages.map((p) => p.close()));
+    const browserWSEndpoint = browserInstance.wsEndpoint();
+    process.send!({ browserWSEndpoint });
+    // eslint-disable-next-line no-process-exit
+    browserInstance.on('disconnected', () => process.exit());
+  } catch (error) {
+    process.send!({ error: error.message });
   }
-
-  const browserInstance = await puppeteer.launch({
-    headless,
-    devtools: !headless,
-    ignoreDefaultArgs: [
-      // Don't pop up "Chrome is being controlled by automated software"
-      '--enable-automation',
-      // Unsupported flag that pops up a warning
-      '--enable-blink-features=IdleDetection',
-    ],
-    args: [
-      // Don't pop up "Chrome is not your default browser"
-      '--no-default-browser-check',
-      '--disable-features=ChromeLabs', // Remove little beaker icon next to URL bar
-    ],
-    userDataDir,
-  });
-  const allPages = await browserInstance.pages();
-  // Close startup page
-  await Promise.all(allPages.map((p) => p.close()));
-  const browserWSEndpoint = browserInstance.wsEndpoint();
-  process.send!({ browserWSEndpoint });
-  // eslint-disable-next-line no-process-exit
-  browserInstance.on('disconnected', () => process.exit());
 });