fix: remove --inspect in node to fix useV3 breaking

Fixes #289

Author: connor4312

src/nodeDebugConfigurationProvider.ts

@@ -19,6 +19,7 @@ import { NvmResolver, INvmResolver } from './targets/node/nvmResolver';
 import { EnvironmentVars } from './common/environmentVars';
 import { resolveProcessId } from './ui/processPicker';
 import { BaseConfigurationProvider } from './baseConfigurationProvider';
+import { fixInspectFlags } from './ui/configurationUtils';
 
 // eslint-disable-next-line
 const config = require('../package.json');
@@ -95,22 +96,7 @@ export class NodeDebugConfigurationProvider extends BaseConfigurationProvider<An
       }
 
       // remove manual --inspect flags, which are no longer needed and interfere
-      if (config.runtimeArgs) {
-        const resolved: string[] = [];
-        for (const arg of config.runtimeArgs) {
-          const flags = /^--inspect(-brk)?(=|$)/.exec(arg);
-          if (!flags) {
-            resolved.push(arg);
-          } else if (flags[1]) {
-            // --inspect-brk
-            config.stopOnEntry = config.stopOnEntry ?? true;
-          } else {
-            // simple --inspect, ignored
-          }
-        }
-
-        config.runtimeArgs = resolved;
-      }
+      fixInspectFlags(config);
     }
 
     // "attach to process via picker" support

src/targets/node/nodeLauncher.ts

@@ -17,6 +17,7 @@ import { NodePathProvider } from './nodePathProvider';
 import { exists } from '../../common/fsUtils';
 import { logger } from '../../common/logging/logger';
 import { LogTag } from '../../common/logging';
+import { fixInspectFlags } from '../../ui/configurationUtils';
 
 /**
  * Tries to get the "program" entrypoint from the config. It a program
@@ -60,19 +61,23 @@ export class NodeLauncher extends NodeLauncherBase<INodeLaunchConfiguration> {
    * @inheritdoc
    */
   protected resolveParams(params: AnyLaunchConfiguration): INodeLaunchConfiguration | undefined {
+    let config: INodeLaunchConfiguration | undefined;
     if (params.type === Contributions.NodeDebugType && params.request === 'launch') {
-      return params;
-    }
-
-    if (
+      config = { ...params };
+    } else if (
       params.type === Contributions.ChromeDebugType &&
       params.server &&
       'program' in params.server
     ) {
-      return params.server;
+      config = { ...params.server };
+    }
+
+    if (!config) {
+      return undefined;
     }
 
-    return undefined;
+    fixInspectFlags(config);
+    return config;
   }
 
   /**

src/test/node/node-runtime-inspect-flag-handling-does-not-break-with-inspect-flag.txt

@@ -0,0 +1,7 @@
+{
+    allThreadsStopped : false
+    description : Paused on debugger statement
+    reason : pause
+    threadId : <number>
+}
+<anonymous> @ ${fixturesDir}/test.js:2:1

src/test/node/node-runtime-inspect-flag-handling-treats-inspect-brk-as-stoponentry.txt

@@ -0,0 +1,7 @@
+{
+    allThreadsStopped : false
+    description : Paused on breakpoint
+    reason : breakpoint
+    threadId : <number>
+}
+<anonymous> @ ${fixturesDir}/test.js:1:1

src/test/node/node-runtime.test.ts

@@ -88,6 +88,29 @@ describe('node runtime', () => {
     });
   });
 
+  describe('inspect flag handling', () => {
+    itIntegrates('does not break with inspect flag', async ({ r }) => {
+      createFileTree(testFixturesDir, { 'test.js': ['console.log("hello world");', 'debugger;'] });
+      const handle = await r.runScript('test.js', {
+        runtimeArgs: ['--inspect'],
+      });
+      handle.load();
+      await waitForPause(handle);
+      handle.assertLog({ substring: true });
+    });
+
+    itIntegrates('treats inspect-brk as stopOnEntry', async ({ r }) => {
+      createFileTree(testFixturesDir, { 'test.js': ['console.log("hello world");'] });
+      const handle = await r.runScript('test.js', {
+        cwd: testFixturesDir,
+        runtimeArgs: ['--inspect-brk'],
+      });
+      handle.load();
+      await waitForPause(handle);
+      handle.assertLog({ substring: true });
+    });
+  });
+
   describe('stopOnEntry', () => {
     beforeEach(() =>
       createFileTree(testFixturesDir, { 'test.js': '', 'bar.js': 'require("./test")' }),

src/ui/configurationUtils.ts

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------
+ * Copyright (C) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------*/
+
+import { ResolvingNodeLaunchConfiguration } from '../configuration';
+
+/**
+ * Removes and handles any --inspect or --inspect-brk flags from the launch
+ * configuration. These aren't needed and don't work with the new debugger.
+ */
+export function fixInspectFlags(config: ResolvingNodeLaunchConfiguration) {
+  if (!config.runtimeArgs) {
+    return;
+  }
+
+  const resolved: string[] = [];
+  for (const arg of config.runtimeArgs) {
+    const flags = /^--inspect(-brk)?(=|$)/.exec(arg);
+    if (!flags) {
+      resolved.push(arg);
+    } else if (flags[1]) {
+      // --inspect-brk
+      config.stopOnEntry = config.stopOnEntry || true;
+    } else {
+      // simple --inspect, ignored
+    }
+  }
+
+  config.runtimeArgs = resolved;
+}