fix(debugging): do not pass NODE_OPTIONS='--inspect' to subprocesses

fixes #11030
vercel · Mar 19, 2020 · c7ac253 · c7ac253
1 parent 087a887
commit c7ac253
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/packages/next/server/lib/utils.ts b/packages/next/server/lib/utils.ts
@@ -8,3 +8,8 @@ export function printAndExit(message: string, code = 1) {
 
   process.exit(code)
 }
+
+export function getNodeOptionsWithoutInspect() {
+  const NODE_INSPECT_RE = /--inspect(-brk)?(=\S+)? ?/
+  return (process.env.NODE_OPTIONS || '').replace(NODE_INSPECT_RE, '')
+}
diff --git a/packages/next/server/next-dev-server.ts b/packages/next/server/next-dev-server.ts
@@ -31,6 +31,7 @@ import ErrorDebug from './error-debug'
 import HotReloader from './hot-reloader'
 import { findPageFile } from './lib/find-page-file'
 import Worker from 'jest-worker'
+import { getNodeOptionsWithoutInspect } from './lib/utils'
 
 if (typeof React.Suspense === 'undefined') {
   throw new Error(
@@ -88,11 +89,19 @@ export default class DevServer extends Server {
         forkOptions: {
           env: {
             ...process.env,
+<<<<<<< HEAD
             // discard process.env.NODE_OPTIONS --inspect flag otherwise two debuggers are started in inspect
             // mode when users will try to debug their Next.js application with NODE_OPTIONS='--inspect' next dev
             NODE_OPTIONS: process.env.NODE_OPTIONS
               ? process.env.NODE_OPTIONS.replace(/--inspect(-brk)?(=\S+)? ?/, '')
               : '',
+=======
+            // discard --inspect/--inspect-brk flags from process.env.NODE_OPTIONS. Otherwise multiple Node.js debuggers
+            // would be started if user launch Next.js in debugging mode. The number of debuggers is linked to
+            // the number of workers Next.js tries to launch. The only worker users are interested in debugging
+            // is the main Next.js one
+            NODE_OPTIONS: getNodeOptionsWithoutInspect(),
+>>>>>>> fix(debugging): do not pass NODE_OPTIONS='--inspect' to subprocesses
           },
         },
       }

diff --git a/test/integration/cli/test/index.test.js b/test/integration/cli/test/index.test.js
@@ -88,6 +88,16 @@ describe('CLI Usage', () => {
       expect(output).toMatch(new RegExp(`http://localhost:${port}`))
     })
 
+    test("NODE_OPTIONS='--inspect'", async () => {
+      // this test checks that --inspect works by launching a single debugger for the main Next.js process,
+      // not for its subprocesses
+      const port = await findPort()
+      const output = await runNextCommandDev([dir, '--port', port], true, {
+        env: { NODE_OPTIONS: '--inspect' },
+      })
+      expect(output).toMatch(new RegExp(`http://localhost:${port}`))
+    })
+
     test('-p', async () => {
       const port = await findPort()
       const output = await runNextCommandDev([dir, '-p', port], true)