Merge pull request #623 from Yavanosta/provide-target-types-filter-configuration

Provide target types filter configuration

Author: roblourens

README.md

@@ -135,6 +135,7 @@ See our wiki page for some configured example apps: [Examples](https://github.co
 * `userDataDir`: Normally, if Chrome is already running when you start debugging with a launch config, then the new instance won't start in remote debugging mode. So by default, the extension launches Chrome with a separate user profile in a temp folder. Use this option to set a different path to use, or set to false to launch with your default user profile.
 * `url`: On a 'launch' config, it will launch Chrome at this URL.
 * `urlFilter`: On an 'attach' config, or a 'launch' config with no 'url' set, search for a page with this url and attach to it. It can also contain wildcards, for example, `"localhost:*/app"` will match either `"http://localhost:123/app"` or `"http://localhost:456/app"`, but not `"https://stackoverflow.com"`.
+* `targetTypes`: On an 'attach' config, or a 'launch' config with no 'url' set, search for a target with one of provided types. Possible target path in Chrome are `page`, `iframe`, `shared_worker`, `service_worker`, `browser`, `webview` and `other`. By default equals to `['page']`.
 * `sourceMaps`: By default, the adapter will use sourcemaps and your original sources whenever possible. You can disable this by setting `sourceMaps` to false.
 * `pathMapping`: This property takes a mapping of URL paths to local paths, to give you more flexibility in how URLs are resolved to local files. `"webRoot": "${workspaceFolder}"` is just shorthand for a pathMapping like `{ "/": "${workspaceFolder}" }`.
 * `smartStep`: Automatically steps over code that doesn't map to source files. Especially useful for debugging with async/await.

package.json

@@ -264,6 +264,11 @@
                 "description": "%chrome.urlFilter.description%",
                 "default": ""
               },
+              "targetTypes": {
+                "type": "array",
+                "description": "%chrome.targetTypes.description%",
+                "default": ""
+              },
               "showAsyncStacks": {
                 "type": "boolean",
                 "description": "%chrome.showAsyncStacks.description%",

package.nls.json

@@ -25,6 +25,7 @@
 	"chrome.timeout.description": "Retry for this number of milliseconds to connect to Chrome. Default is 10000 ms.",
 	"chrome.disableNetworkCache.description": "Controls whether to skip the network cache for each request",
 	"chrome.urlFilter.description": "Will search for a page with this url and attach to it, if found. Can have * wildcards.",
+	"chrome.targetTypes.description": "Will search for a page with one of this types. Equals to ['page'] by default.",
 	"chrome.showAsyncStacks.description": "Show the async calls that led to the current call stack",
 	"chrome.breakOnLoad.description": "Experimental feature -  If true, the debug adapter will attempt to set breakpoints in scripts before they are loaded, so it can hit breakpoints at the beginnings of those scripts. Has a perf impact.",
 	"chrome.breakOnLoadStrategy.description": "The strategy to use for breakOnLoad.",

src/chromeDebug.ts

@@ -5,7 +5,7 @@
 import { ChromeDebugSession, logger, UrlPathTransformer, BaseSourceMapTransformer, telemetry } from 'vscode-chrome-debug-core';
 import * as path from 'path';
 import * as os from 'os';
-import { targetFilter } from './utils';
+import { targetFilterProvider } from './utils';
 
 import { ChromeDebugAdapter } from './chromeDebugAdapter';
 
@@ -18,7 +18,7 @@ ChromeDebugSession.run(ChromeDebugSession.getSession(
         adapter: ChromeDebugAdapter,
         extensionName: EXTENSION_NAME,
         logFilePath: path.resolve(os.tmpdir(), 'vscode-chrome-debug.txt'),
-        targetFilter,
+        targetFilter: targetFilterProvider(),
 
         pathTransformer: UrlPathTransformer,
         sourceMapTransformer: BaseSourceMapTransformer,

src/extension.ts

@@ -5,7 +5,7 @@
 import * as vscode from 'vscode';
 import * as Core from 'vscode-chrome-debug-core';
 
-import { targetFilter } from './utils';
+import { targetFilterProvider } from './utils';
 
 import * as nls from 'vscode-nls';
 const localize = nls.loadMessageBundle();
@@ -50,7 +50,11 @@ export class ChromeConfigurationProvider implements vscode.DebugConfigurationPro
 
             let targets;
             try {
-                targets = await discovery.getAllTargets(config.address || '127.0.0.1', config.port, targetFilter, config.url || config.urlFilter);
+                targets = await discovery.getAllTargets(
+                    config.address || '127.0.0.1',
+                    config.port,
+                    targetFilterProvider(config.targetTypes),
+                    config.url || config.urlFilter);
             } catch (e) {
                 // Target not running?
             }
@@ -111,4 +115,4 @@ function unescapeTargetTitle(title: string): string {
         .replace(/>/g, '>')
         .replace(/'/g, `'`)
         .replace(/"/g, '"');
-}
+}

src/utils.ts

@@ -64,5 +64,6 @@ export class DebounceHelper {
     }
 }
 
-export const targetFilter: chromeConnection.ITargetFilter =
-    target => target && (!target.type || target.type === 'page');
+export const targetFilterProvider =
+    (types: Iterable<string> = ['page']): chromeConnection.ITargetFilter =>
+        target => target && (!target.type || Array.from(types).some(t => t === target.type));