Merge pull request #12 from CodeMooseUS/addAttach

CodeMooseUS · web-flow · commit 8899d33a256e · 2018-11-27T07:02:41.000-08:00
Adding an attach feature to the launch.json per Issue #10.
diff --git a/README.md b/README.md
@@ -22,7 +22,8 @@ You can launch the Chrome DevTools hosted in VS Code like you would a debugger,
 To do this in your `launch.json` add a new debug config with two parameters.
 - `type` - The name of the debugger which must be `devtools-for-chrome`. Required.
 - `url` - The url to launch Chrome at. Optional.
-- `request` - Whether a new tab in Chrome should be opened `launch` or to use an exsisting tab `attach` matched by URI. Optional.
+- `file` - The local file path to launch Chrome at. Optional.
+- `request` - Whether a new tab in Chrome should be opened `launch` or to use an exsisting tab `attach` matched on URL. Optional.
 - `name` - A friendly name to show in the VS Code UI. Required.
 ```
 {
@@ -31,8 +32,14 @@ To do this in your `launch.json` add a new debug config with two parameters.
         {
             "type": "devtools-for-chrome",
             "request": "launch",
-            "name": "Launch Chrome",
-            "url": "${workspaceFolder}/index.html"
+            "name": "Launch Chrome DevTools",
+            "file": "${workspaceFolder}/index.html"
+        },
+        {
+            "type": "devtools-for-chrome",
+            "request": "attach",
+            "name": "Attach Chrome DevTools",
+            "url": "http://localhost:8000/"
         }
     ]
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -59,19 +59,35 @@
         "label": "DevTools for Chrome",
         "configurationAttributes": {
           "launch": {
-            "required": [
-              "url"
-            ],
             "properties": {
               "url": {
                 "type": "string",
                 "description": "Absolute uri to launch.",
                 "default": "http://localhost:8080"
               },
-              "request": {
+              "file": {
                 "type": "string",
-                "description": "A value representing whether the debugger should launch a new Chrome tab or attach to an exsisting one.",
-                "default": "launch"
+                "description": "File path to launch.",
+                "default": "${workspaceFolder}/index.html"
+              },
+              "chromePath": {
+                "type": "string",
+                "description": "Absolute path to the Chrome instance to launch.",
+                "default": ""
+              }
+            }
+          },
+          "attach": {
+            "properties": {
+              "url": {
+                "type": "string",
+                "description": "Absolute uri to launch.",
+                "default": "http://localhost:8080"
+              },
+              "file": {
+                "type": "string",
+                "description": "File path to launch.",
+                "default": "${workspaceFolder}/index.html"
               },
               "chromePath": {
                 "type": "string",
@@ -126,6 +142,7 @@
     "@types/node": "^10.5.2",
     "@types/shelljs": "^0.8.0",
     "@types/ws": "^6.0.1",
+    "@types/applicationinsights": "^0.20.0",
     "shelljs": "^0.8.2",
     "ts-node": "^7.0.1",
     "tslint": "^5.11.0",
diff --git a/src/extension.ts b/src/extension.ts
@@ -12,6 +12,7 @@ interface IPackageInfo {
 }
 
 const debuggerType: string = 'devtools-for-chrome';
+const defaultUrl: string = 'about:blank';
 let telemetryReporter: TelemetryReporter;
 
 export function activate(context: vscode.ExtensionContext) {
@@ -31,7 +32,7 @@ export function activate(context: vscode.ExtensionContext) {
     }));
 
     context.subscriptions.push(vscode.commands.registerCommand('devtools-for-chrome.attach', async () => {
-        attach(context, /* viaConfig= */ false);
+        attach(context, /* viaConfig= */ false, defaultUrl);
     }));
 
     vscode.debug.registerDebugConfigurationProvider(debuggerType, {
@@ -45,22 +46,18 @@ export function activate(context: vscode.ExtensionContext) {
         },
 
         resolveDebugConfiguration(folder: vscode.WorkspaceFolder | undefined, config: vscode.DebugConfiguration, token?: vscode.CancellationToken): vscode.ProviderResult<vscode.DebugConfiguration> {
-            if (config && config.type == debuggerType) {
-                if (config.request && config.request.localeCompare('attach', 'en', { sensitivity: 'base' }) == 0) {
-                    attach(context, /* viaConfig= */ true);
-                } else {
-                    let launchUri: string = '';
-                    if (folder.uri.scheme == 'file') {
-                        const baseUrl: string = config.file || config.url;
-                        const replacedUri: string = baseUrl.replace('${workspaceFolder}', folder.uri.path);
-                        launchUri = utils.pathToFileURL(replacedUri);
-                    } else {
-                        launchUri = config.url;
-                    }
-                    launch(context, launchUri, config.chromePath);
+            if (config && config.type === debuggerType) {
+                const targetUri: string = utils.getUrlFromConfig(folder, config);
+                if (config.request && config.request.localeCompare('attach', 'en', { sensitivity: 'base' }) === 0) {
+                    attach(context, /* viaConfig= */ true, targetUri);
+                    telemetryReporter.sendTelemetryEvent('launch/command/attach');
+                } else if (config.request && config.request.localeCompare('launch', 'en', { sensitivity: 'base' }) === 0) {
+                    launch(context, targetUri, config.chromePath);
+                    telemetryReporter.sendTelemetryEvent('launch/command/launch');
                 }
             } else {
                 vscode.window.showErrorMessage('No supported launch config was found.');
+                telemetryReporter.sendTelemetryEvent('launch/error/config_not_found');
             }
             return;
         }
@@ -84,21 +81,21 @@ async function launch(context: vscode.ExtensionContext, launchUrl?: string, chro
             return;
         }
 
-        utils.launchLocalChrome(pathToChrome, port, 'about:blank');
+        utils.launchLocalChrome(pathToChrome, port, defaultUrl);
     }
 
     const target = JSON.parse(await utils.getURL(`http://${hostname}:${port}/json/new?${launchUrl}`));
 
-    if (!target || !target.webSocketDebuggerUrl || target.webSocketDebuggerUrl == '') {
+    if (!target || !target.webSocketDebuggerUrl || target.webSocketDebuggerUrl === '') {
         vscode.window.showErrorMessage(`Could not find the launched Chrome tab: (${launchUrl}).`);
         telemetryReporter.sendTelemetryEvent('launch/error/tab_not_found', telemetryProps);
-        attach(context, viaConfig);
+        attach(context, viaConfig, defaultUrl);
     } else {
         DevToolsPanel.createOrShow(context, target.webSocketDebuggerUrl);
     }
 }
 
-async function attach(context: vscode.ExtensionContext, viaConfig: boolean) {
+async function attach(context: vscode.ExtensionContext, viaConfig: boolean, targetUrl: string) {
     const telemetryProps = { viaConfig: `${viaConfig}` };
     telemetryReporter.sendTelemetryEvent('attach', telemetryProps);
 
@@ -111,14 +108,32 @@ async function attach(context: vscode.ExtensionContext, viaConfig: boolean) {
 
         responseArray.forEach(i => {
             i = utils.fixRemoteUrl(hostname, port, i);
-            items.push({ label: i.title, description: i.url, detail: i.webSocketDebuggerUrl });
+            items.push({
+                label: i.title,
+                description: i.url,
+                detail: i.webSocketDebuggerUrl
+            });
         });
 
-        vscode.window.showQuickPick(items).then((selection) => {
-            if (selection) {
-                DevToolsPanel.createOrShow(context, selection.detail as string);
+        let targetWebsocketUrl = '';
+        if (typeof targetUrl === 'string' && targetUrl.length > 0 && targetUrl !== defaultUrl) {
+            const matches = items.filter(i => targetUrl.localeCompare(i.description, 'en', { sensitivity: 'base' }) === 0);
+            if (matches && matches.length > 0 ) {
+                targetWebsocketUrl = matches[0].detail;
+            } else {
+                vscode.window.showErrorMessage(`Couldn't attach to ${targetUrl}.`);
             }
-        });
+        }
+
+        if (targetWebsocketUrl && targetWebsocketUrl.length > 0) {
+            DevToolsPanel.createOrShow(context, targetWebsocketUrl as string);
+        } else {
+            vscode.window.showQuickPick(items).then((selection) => {
+                if (selection) {
+                    DevToolsPanel.createOrShow(context, selection.detail as string);
+                }
+            });
+        }
     } else {
         telemetryReporter.sendTelemetryEvent('attach/error/no_json_array', telemetryProps);
     }
@@ -331,10 +346,10 @@ class DevToolsPanel {
     private _getDevtoolsState() {
         const allPrefsKey = 'devtools-preferences';
         const allPrefs: any = this._context.workspaceState.get(allPrefsKey) ||
-        {
-            uiTheme: '"dark"',
-            screencastEnabled: false
-        };
+            {
+                uiTheme: '"dark"',
+                screencastEnabled: false
+            };
         this._panel.webview.postMessage(`preferences:${JSON.stringify(allPrefs)}`);
     }
 
@@ -359,7 +374,7 @@ class DevToolsPanel {
             content = '';
         }
 
-        this._panel.webview.postMessage(`setUrl:${JSON.stringify({id: request.id, content})}`);
+        this._panel.webview.postMessage(`setUrl:${JSON.stringify({ id: request.id, content })}`);
     }
 
     private _update() {
diff --git a/src/utils.ts b/src/utils.ts
@@ -6,6 +6,7 @@ import * as net from 'net';
 import * as os from 'os';
 import * as path from 'path';
 import * as url from 'url';
+import * as vscode from 'vscode';
 
 export function getURL(aUrl: string, options: https.RequestOptions = {}): Promise<string> {
     return new Promise((resolve, reject) => {
@@ -140,4 +141,18 @@ export function forceForwardSlashes(aUrl: string): string {
     return aUrl
         .replace(/\\\//g, '/') // Replace \/ (unnecessarily escaped forward slash)
         .replace(/\\/g, '/');
+}
+
+export function getUrlFromConfig(folder: vscode.WorkspaceFolder, config: vscode.DebugConfiguration): string {
+    let outUrlString = '';
+
+    if (config.file) {
+        outUrlString = config.file;
+        outUrlString = outUrlString.replace('${workspaceFolder}', folder.uri.path);
+        outUrlString = pathToFileURL(outUrlString);
+    } else if (config.url) {
+        outUrlString = config.url;
+    }
+
+    return outUrlString;
 }
diff --git a/tslint.json b/tslint.json
@@ -62,6 +62,7 @@
         "no-internal-module": true,
         "no-trailing-whitespace": true,
         "no-null-keyword": true,
-        "prefer-const": true
+        "prefer-const": true,
+        "triple-equals": true
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,8 @@ You can launch the Chrome DevTools hosted in VS Code like you would a debugger,`
`22`	`22`	To do this in your `launch.json` add a new debug config with two parameters.
`23`	`23`	- `type` - The name of the debugger which must be `devtools-for-chrome`. Required.
`24`	`24`	- `url` - The url to launch Chrome at. Optional.
`25`		-- `request` - Whether a new tab in Chrome should be opened `launch` or to use an exsisting tab `attach` matched by URI. Optional.
	`25`	+- `file` - The local file path to launch Chrome at. Optional.
	`26`	+- `request` - Whether a new tab in Chrome should be opened `launch` or to use an exsisting tab `attach` matched on URL. Optional.
`26`	`27`	- `name` - A friendly name to show in the VS Code UI. Required.
`27`	`28`	```
`28`	`29`	`{`
@@ -31,8 +32,14 @@ To do this in your `launch.json` add a new debug config with two parameters.
`31`	`32`	`{`
`32`	`33`	`"type": "devtools-for-chrome",`
`33`	`34`	`"request": "launch",`
`34`		`- "name": "Launch Chrome",`
`35`		`- "url": "${workspaceFolder}/index.html"`
	`35`	`+ "name": "Launch Chrome DevTools",`
	`36`	`+ "file": "${workspaceFolder}/index.html"`
	`37`	`+ },`
	`38`	`+ {`
	`39`	`+ "type": "devtools-for-chrome",`
	`40`	`+ "request": "attach",`
	`41`	`+ "name": "Attach Chrome DevTools",`
	`42`	`+ "url": "http://localhost:8000/"`
`36`	`43`	`}`
`37`	`44`	`]`
`38`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,7 @@`
`62`	`62`	`"no-internal-module": true,`
`63`	`63`	`"no-trailing-whitespace": true,`
`64`	`64`	`"no-null-keyword": true,`
`65`		`- "prefer-const": true`
	`65`	`+ "prefer-const": true,`
	`66`	`+ "triple-equals": true`
`66`	`67`	`}`
`67`	`68`	`}`