version 0.7.1

Bumps [js-yaml](https://github.com/nodeca/js-yaml) from 3.12.0 to 3.13.1.
- [Release notes](https://github.com/nodeca/js-yaml/releases)
- [Changelog](https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md)
- [Commits](https://github.com/nodeca/js-yaml/compare/3.12.0...3.13.1)

Signed-off-by: dependabot[bot] <support@github.com>

CHANGELOG.md

@@ -1,5 +1,29 @@
 # Change Log
 
+### version 0.7.1
+* Added the [Buy Me A Coffee](https://www.buymeacoffee.com/adelphes) link to the README
+
+### version 0.7.0
+* Fix logcat not displaying
+* Fix breakpoints not triggering on Windows
+* Added kotlin folder to list of known source locations
+* Upgraded dependencies to resolve a number of security vulnerabilites
+* Updated README with info about prelaunch build task
+* Added MIT license file
+
+### version 0.6.2
+* Fix broken logcat command due to missing dependency
+
+### version 0.6.1
+* Regenerate package-lock.json to remove event-stream vulnerability - https://github.com/dominictarr/event-stream/issues/116
+
+### version 0.6.0
+* Fix issue with breakpoints not enabling correctly
+* Fix issue with JDWP failure on breakpoint hit
+* Added support for diagnostic logs using trace configuration option
+* Updated default apkFile path to match current releases of Android Studio
+* Updated package dependencies
+
 ### version 0.5.0
 * Debugger support for Kotlin source files
 * Exception UI

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Dave Holoway
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -20,7 +20,7 @@ You must have [Android SDK Platform Tools](https://developer.android.com/studio/
 * This is a preview version so expect the unexpected. Please log any issues you find on [GitHub](https://github.com/adelphes/android-dev-ext/issues).  
 * This extension **will not build your app**.  
 If you use gradle (or Android Studio), you can build your app from the command-line using `./gradlew assembleDebug`.
-> You must use gradle or some other build procedure to create your APK. Once built, the extension can deploy and launch your app, allowing you to debug it in the normal way.  
+> You must use gradle or some other build procedure to create your APK. Once built, the extension can deploy and launch your app, allowing you to debug it in the normal way. See the section below on how to configure a VSCode task to automatically build your app before launching a debug session.
 * Some debugger options are yet to be implemented. You cannot set conditional breakpoints and watch expressions must be simple variables.
 * If you require a must-have feature that isn't there yet, let us know on [GitHub](https://github.com/adelphes/android-dev-ext/issues).  
 * This extension does not provide any additional code completion or other editing enhancements.
@@ -54,6 +54,52 @@ The following settings are used to configure the debugger:
         ]
     }
 
+## Building your app automatically
+
+This extension will not build your App. If you would like to run a build each time a debug session is started, you can add a `preLaunchTask` option to your `launch.json` configuration which invokes a build task.
+
+#### .vscode/launch.json
+Add a `preLaunchTask` item to the launch configuration:
+```json
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "android",
+            "request": "launch",
+            "name": "App Build & Launch",
+            "preLaunchTask": "run gradle",
+        }
+    ]
+}
+```
+Add a new task to run the build command:
+#### .vscode/tasks.json
+```json
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "run gradle",
+            "type": "shell",
+            "command": "${workspaceFolder}/gradlew",
+            "args": ["assembleDebug"]
+        }
+    ]
+}
+```
+
+## Powered by coffee
+
+The Android Developer Extension is a completely free, fully open-source project. If you've found the extension useful, you
+can support it by [buying me a coffee](https://www.buymeacoffee.com/adelphes).
+
+If you use ApplePay or Google Pay, you can scan the code with your phone camera:
+
+![BuyMeACoffee Code](https://raw.githubusercontent.com/adelphes/android-dev-ext/master/images/bmac-code.png)
+
+Every coffee makes a difference, so thanks for adding your support.
+
 ## Questions / Problems
 
 If you run into any problems, tell us on [GitHub](https://github.com/adelphes/android-dev-ext/issues) or contact me on [Twitter](https://twitter.com/daveholoway).

package.json

@@ -2,7 +2,7 @@
     "name": "android-dev-ext",
     "displayName": "Android",
     "description": "Android debugging support for VS Code",
-    "version": "0.5.0",
+    "version": "0.7.1",
     "publisher": "adelphes",
     "preview": true,
     "license": "MIT",
@@ -43,7 +43,7 @@
         "debuggers": [
             {
                 "type": "android",
-                "label": "Android Debug",
+                "label": "Android",
                 "program": "./src/debugMain.js",
                 "runtime": "node",
                 "configurationAttributes": {
@@ -62,7 +62,7 @@
                             "apkFile": {
                                 "type": "string",
                                 "description": "Fully qualified path to the built APK (Android Application Package)",
-                                "default": "${workspaceRoot}/app/build/outputs/apk/app-debug.apk"
+                                "default": "${workspaceRoot}/app/build/outputs/apk/debug/app-debug.apk"
                             },
                             "adbPort": {
                                 "type": "integer",
@@ -93,6 +93,11 @@
                                 "type": "string",
                                 "description": "Target Device ID (as indicated by 'adb devices'). Use this to specify which device is used for deployment when multiple devices are connected.",
                                 "default": ""
+                            },
+                            "trace": {
+                                "type": "boolean",
+                                "description": "Set to true to output debugging logs for diagnostics",
+                                "default": "false"
                             }
                         }
                     }
@@ -100,10 +105,10 @@
                 "initialConfigurations": [
                     {
                         "type": "android",
-                        "name": "Android Debug",
+                        "name": "Android",
                         "request": "launch",
                         "appSrcRoot": "${workspaceRoot}/app/src/main",
-                        "apkFile": "${workspaceRoot}/app/build/outputs/apk/app-debug.apk",
+                        "apkFile": "${workspaceRoot}/app/build/outputs/apk/debug/app-debug.apk",
                         "adbPort": 5037
                     }
                 ],
@@ -116,7 +121,7 @@
                             "request": "launch",
                             "name": "${2:Launch App}",
                             "appSrcRoot": "^\"\\${workspaceRoot}/app/src/main\"",
-                            "apkFile": "^\"\\${workspaceRoot}/app/build/outputs/apk/app-debug.apk\"",
+                            "apkFile": "^\"\\${workspaceRoot}/app/build/outputs/apk/debug/app-debug.apk\"",
                             "adbPort": 5037
                         }
                     }
@@ -126,23 +131,24 @@
         ]
     },
     "scripts": {
-        "postinstall": "node ./node_modules/vscode/bin/install",
+        "prepare": "node ./node_modules/vscode/bin/install",
         "test": "node ./node_modules/vscode/bin/test"
     },
     "dependencies": {
-        "vscode-debugprotocol": "^1.20.0",
+        "long": "^4.0.0",
-        "vscode-debugadapter": "^1.20.0",
+        "uuid": "^3.3.2",
-        "long": "^3.2.0",
+        "vscode-debugadapter": "^1.32.0",
-        "ws": "^1.1.1",
+        "vscode-debugprotocol": "^1.32.0",
+        "ws": "^7.1.2",
         "xmldom": "^0.1.27",
-        "xpath": "^0.0.23"
+        "xpath": "^0.0.27"
     },
     "devDependencies": {
-        "typescript": "^2.0.3",
+        "@types/mocha": "^5.2.5",
-        "vscode": "^1.0.0",
+        "@types/node": "^10.12.5",
-        "mocha": "^2.3.3",
+        "eslint": "^5.9.0",
-        "eslint": "^3.6.0",
+        "mocha": "^5.2.0",
-        "@types/node": "^6.0.40",
+        "typescript": "^3.1.6",
-        "@types/mocha": "^2.2.32"
+        "vscode": "^1.1.26"
     }
-}
+}

src/contentprovider.js

@@ -44,7 +44,7 @@ class AndroidContentProvider /*extends TextDocumentContentProvider*/ {
     provideLogcatDocumentContent(uri) {
         // LogcatContent depends upon AndroidContentProvider, so we must delay-load this
         const { LogcatContent } = require('./logcat');
-        var doc = this._docs[uri] = new LogcatContent(this, uri);
+        var doc = this._docs[uri] = new LogcatContent(uri.query);
         return doc.content;
     }
 }

src/debugMain.js

@@ -17,7 +17,7 @@ const { ADBClient } = require('./adbclient');
 const { Debugger } = require('./debugger');
 const $ = require('./jq-promise');
 const { AndroidThread } = require('./threads');
-const { D, isEmptyObject } = require('./util');
+const { D, onMessagePrint, isEmptyObject } = require('./util');
 const { AndroidVariables } = require('./variables');
 const { evaluate } = require('./expressions');
 const ws_proxy = require('./wsproxy').proxy.Server(6037, 5037);
@@ -73,6 +73,9 @@ class AndroidDebugSession extends DebugSession {
         // flag to distinguish unexpected disconnection events (initiated from the device) vs user-terminated requests
         this._isDisconnecting = false;
 
+        // trace flag for printing diagnostic messages to the client Output Window
+        this.trace = false;
+
 		// this debugger uses one-based lines and columns
 		this.setDebuggerLinesStartAt1(true);
 		this.setDebuggerColumnsStartAt1(true);
@@ -106,14 +109,19 @@ class AndroidDebugSession extends DebugSession {
 	}
 
     LOG(msg) {
-        D(msg);
+        if (!this.trace) {
+            D(msg);
+        }
         // VSCode no longer auto-newlines output
         this.sendEvent(new OutputEvent(msg + os.EOL));
     }
 
     WARN(msg) {
         D(msg = 'Warning: '+msg);
-        this.sendEvent(new OutputEvent(msg + os.EOL));
+        // the message will already be sent if trace is enabled
+        if (!this.trace) {
+            this.sendEvent(new OutputEvent(msg + os.EOL));
+        }
     }
 
     failRequest(msg, response) {
@@ -223,6 +231,10 @@ class AndroidDebugSession extends DebugSession {
     }
 
 	launchRequest(response/*: DebugProtocol.LaunchResponse*/, args/*: LaunchRequestArguments*/) {
+        if (args && args.trace) {
+            this.trace = args.trace;
+            onMessagePrint(this.LOG.bind(this));
+        }
 
         try { D('Launching: ' + JSON.stringify(args)); } catch(ex) {}
         // app_src_root must end in a path-separator for correct validation of sub-paths
@@ -360,6 +372,9 @@ class AndroidDebugSession extends DebugSession {
                 this.sendResponse(response);
                 return this.dbgr.resume();
             })
+            .then(() => {
+                this.LOG('Application started');
+            })
             .fail(e => {
                 // exceptions use message, adbclient uses msg
                 this.LOG('Launch failed: '+(e.message||e.msg||'No additional information is available'));
@@ -468,12 +483,12 @@ class AndroidDebugSession extends DebugSession {
                 }
                 catch (err) { continue }
                 // ignore folders not starting with a known top-level Android folder
-                if (!/^(assets|res|src|main|java)([\\/]|$)/.test(p)) continue;
+                if (!/^(assets|res|src|main|java|kotlin)([\\/]|$)/.test(p)) continue;
                 // is this a package folder
-                var pkgmatch = p.match(/^(src|main|java)[\\/](.+)/);
+                var pkgmatch = p.match(/^(src|main|java|kotlin)[\\/](.+)/);
                 if (pkgmatch && /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(pkgmatch[2].split(/[\\/]/).pop())) {
                     // looks good - add it to the list
-                    const src_folder = pkgmatch[1]; // src, main or java
+                    const src_folder = pkgmatch[1]; // src, main, java or kotlin
                     const pkgname = pkgmatch[2].replace(/[\\/]/g,'.');
                     src_packages.packages[pkgname] = {
                         package: pkgname,
@@ -521,6 +536,7 @@ class AndroidDebugSession extends DebugSession {
     }
 
     configurationDoneRequest(response/*, args*/) {
+        D('configurationDoneRequest');
         this.waitForConfigurationDone.resolve();
         this.sendResponse(response);
     }
@@ -551,13 +567,14 @@ class AndroidDebugSession extends DebugSession {
     }
 
     onBreakpointStateChange(e) {
+        D('onBreakpointStateChange');
         e.breakpoints.forEach(javabp => {
             // if there's no associated vsbp we're deleting it, so just ignore the update
             if (!javabp.vsbp) return;
             var verified = !!javabp.state.match(/set|enabled/);
             javabp.vsbp.verified = verified;
             javabp.vsbp.message = null;
-            this.sendEvent(new BreakpointEvent('updated', javabp.vsbp));
+            this.sendEvent(new BreakpointEvent('changed', javabp.vsbp));
         });
     }
 
@@ -582,6 +599,14 @@ class AndroidDebugSession extends DebugSession {
             return bp;
         }
 
+        const sendBPResponse = (response, breakpoints) => {
+            D('setBreakPointsRequest response ' + JSON.stringify(breakpoints.map(bp => bp.verified)));
+            response.body = {
+                breakpoints,
+            };
+    		this.sendResponse(response);
+        }
+
         // the file must lie inside one of the source packages we found (and it must be have a .java extension)
         var srcfolder = path.dirname(srcfpn);
         var pkginfo;
@@ -589,6 +614,14 @@ class AndroidDebugSession extends DebugSession {
             if ((pkginfo = this.src_packages.packages[pkg]).package_path === srcfolder) break;
             pkginfo = null;
         }
+        // if we didn't find an exact path match, look for a case-insensitive match
+        if (!pkginfo) {
+            for (var pkg in this.src_packages.packages) {
+                if ((pkginfo = this.src_packages.packages[pkg]).package_path.localeCompare(srcfolder, undefined, { sensitivity: 'base' }) === 0) break;
+                pkginfo = null;
+            }
+        }
+
         // if it's not in our source packages, check if it's in the Android source file cache
         if (!pkginfo && is_subpath_of(srcfpn, this._android_sources_path)) {
             // create a fake pkginfo to use to construct the bp
@@ -597,10 +630,7 @@ class AndroidDebugSession extends DebugSession {
         if (!pkginfo || !/\.(java|kt)$/i.test(srcfpn)) {
             // source file is not a java file or is outside of the known source packages
             // just send back a list of unverified breakpoints
-            response.body = {
+            sendBPResponse(response, args.breakpoints.map(bp => unverified_breakpoint(bp, 'The breakpoint location is not valid')));
-                breakpoints: args.breakpoints.map(bp => unverified_breakpoint(bp, 'The breakpoint location is not valid'))
-            };
-    		this.sendResponse(response);
             return;
         }
 
@@ -667,10 +697,7 @@ class AndroidDebugSession extends DebugSession {
                     this._setup_breakpoints(this._queue[0]).then(javabp_arr => {
                         // send back the VS Breakpoint instances
                         var response = this._queue[0].response;
-                        response.body = {
+                        sendBPResponse(response, javabp_arr.map(javabp => javabp.vsbp));
-                            breakpoints: javabp_arr.map(javabp => javabp.vsbp)
-                        };
-                        this._dbgr.sendResponse(response);
                         // .. and do the next one
                         this._queue.shift();
                         this._next();

src/debugger.js

@@ -1425,6 +1425,15 @@ Debugger.prototype = {
             cmd: this.JDWP.Commands.lineTable(methodinfo.owningclass, methodinfo),
         })
             .then(function (linetable, methodinfo) {
+                // if the request failed, just return a blank table
+                if (linetable.errorcode) {
+                    linetable = {
+                        errorcode: linetable.errorcode,
+                        start: '00000000000000000000000000000000',
+                        end: '00000000000000000000000000000000',
+                        lines:[],
+                    }
+                }
                 // the linetable does not correlate code indexes with line numbers
                 // - location searching relies on the table being ordered by code indexes
                 linetable.lines.sort(function (a, b) {

src/jdwp.js

@@ -1,5 +1,5 @@
 const $ = require('./jq-promise');
-const { atob,btoa,D,getutf8bytes,fromutf8bytes,intToHex } = require('./util');
+const { btoa,D,E,getutf8bytes,fromutf8bytes,intToHex } = require('./util');
 /*
     JDWP - The Java Debug Wire Protocol
 */
@@ -96,8 +96,8 @@ function _JDWP() {
             return;
 		}
 		
-		if (this.errorcode != 0) {
+		if (this.errorcode !== 0) {
-		    console.error("Command failed: error " + this.errorcode, this);
+		    E(`JDWP command failed '${this.command.name}'. Error ${this.errorcode}`, this);
         }
 		
 		if (!this.errorcode && this.command && this.command.replydecodefn) {
@@ -109,7 +109,10 @@ function _JDWP() {
 			return;
 		}
 
-		this.decoded = {empty:true};
+		this.decoded = {
+            empty: true,
+            errorcode: this.errorcode,
+        };
 	}
 
 	this.decodereply = function(ths,s) {

src/jq-promise.js

@@ -40,7 +40,7 @@ var Deferred = exports.Deferred = function(p, parent) {
             var faildef = $.Deferred(null, this);
             var p = this._promise.catch(function(a) {
                 if (a.stack) {
-                    console.error(a.stack);
+                    util.E(a.stack);
                     a = [a];
                 }
                 if (this.def._context === null && this.def._parent)

src/logcat.js

@@ -15,10 +15,8 @@ const { D } = require('./util');
  */
 class LogcatContent {
 
-    constructor(provider/*: AndroidContentProvider*/, uri/*: Uri*/) {
+    constructor(deviceid) {
-        this._provider = provider;
+        this._logcatid = deviceid;
-        this._uri = uri;
-        this._logcatid = uri.query;
         this._logs = [];
         this._htmllogs = [];
         this._oldhtmllogs = [];
@@ -27,7 +25,7 @@ class LogcatContent {
         this._refreshRate = 200;    // ms
         this._state = '';
         this._htmltemplate = '';
-        this._adbclient = new ADBClient(uri.query);
+        this._adbclient = new ADBClient(deviceid);
         this._initwait = new Promise((resolve, reject) => {
             this._state = 'connecting';
             LogcatContent.initWebSocketServer()
@@ -79,8 +77,11 @@ class LogcatContent {
         });
     }
     sendClientMessage(msg) {
-        var clients = LogcatContent._wss.clients.filter(client => client._logcatid === this._logcatid);
+        LogcatContent._wss.clients.forEach(client => {
-        clients.forEach(client => client.send(msg+'\n'));   // include a newline to try and persuade a buffer write
+            if (client._logcatid === this._logcatid) {
+                client.send(msg + '\n');   // include a newline to try and persuade a buffer write
+            }
+        })
     }
     sendDisconnectMsg() {
         this.sendClientMessage(':disconnect');
@@ -113,7 +114,7 @@ class LogcatContent {
     }
     updateLogs() {
         // no point in formatting the data if there are no connected clients
-        var clients = LogcatContent._wss.clients.filter(client => client._logcatid === this._logcatid);
+        var clients = [...LogcatContent._wss.clients].filter(client => client._logcatid === this._logcatid);
         if (clients.length) {
             var lines = '<div class="logblock">' + this._htmllogs.join('') + '</div>';
             clients.forEach(client => client.send(lines));
@@ -189,14 +190,19 @@ LogcatContent.initWebSocketServer = function () {
         port: wssport,
         retries: 0,
         tryCreateWSS() {
-            this.wss = new WebSocketServer({ host: '127.0.0.1', port: this.port }, () => {
+            const wsopts = {
+                host: '127.0.0.1',
+                port: this.port,
+                clientTracking: true,
+            };
+            this.wss = new WebSocketServer(wsopts, () => {
                 // success - save the info and resolve the deferred
                 LogcatContent._wssport = this.port;
                 LogcatContent._wssstartport = this.startport;
                 LogcatContent._wss = this.wss;
-                this.wss.on('connection', client => {
+                this.wss.on('connection', (client, req) => {
                     // the client uses the url path to signify which logcat data it wants
-                    client._logcatid = client.upgradeReq.url.match(/^\/?(.*)$/)[1];
+                    client._logcatid = req.url.match(/^\/?(.*)$/)[1];
                     var lc = LogcatContent.byLogcatID[client._logcatid];
                     if (lc) lc.onClientConnect(client);
                     else client.close();
@@ -276,6 +282,21 @@ function openLogcatWindow(vscode) {
     .then(devices => {
         if (!Array.isArray(devices)) return;    // user cancelled (or no devices connected)
         devices.forEach(device => {
+            if (vscode.window.createWebviewPanel) {
+                const panel = vscode.window.createWebviewPanel(
+                    'androidlogcat', // Identifies the type of the webview. Used internally
+                    `logcat-${device.serial}`, // Title of the panel displayed to the user
+                    vscode.ViewColumn.One, // Editor column to show the new webview panel in.
+                    {
+                        enableScripts: true,
+                    }
+                );
+                const logcat = new LogcatContent(device.serial);
+                logcat.content.then(html => {
+                    panel.webview.html = html;
+                });
+                return;
+            }
             var uri = AndroidContentProvider.getReadLogcatUri(device.serial);
             return vscode.commands.executeCommand("vscode.previewHtml",uri,vscode.ViewColumn.Two);
         });

src/util.js

@@ -1,13 +1,18 @@
 const crypto = require('crypto');
 
 var nofn = function () { };
-var D = exports.D = console.log.bind(console);
+const messagePrintCallbacks = new Set();
-var E = exports.E = console.error.bind(console);
+var D = exports.D = (...args) => (console.log(...args), messagePrintCallbacks.forEach(cb => cb(...args)))
-var W = exports.W = console.warn.bind(console);
+var E = exports.E = (...args) => (console.error(...args), messagePrintCallbacks.forEach(cb => cb(...args)))
+var W = exports.W = (...args) => (console.warn(...args), messagePrintCallbacks.forEach(cb => cb(...args)))
 var DD = nofn, cl = D, printf = D;
 var print_jdwp_data = nofn;// _print_jdwp_data;
 var print_packet = nofn;//_print_packet;
 
+exports.onMessagePrint = function(cb) {
+    messagePrintCallbacks.add(cb);
+}
+
 Array.first = function (arr, fn, defaultvalue) {
 	var idx = Array.indexOfFirst(arr, fn);
 	return idx < 0 ? defaultvalue : arr[idx];
@@ -622,9 +627,9 @@ exports.dumparr = function (arr, offset, count) {
 }
 
 exports.btoa = function (arr) {
-	return new Buffer(arr, 'binary').toString('base64');
+	return Buffer.from(arr, 'binary').toString('base64');
 }
 
 exports.atob = function (base64) {
-	return new Buffer(base64, 'base64').toString('binary');
+	return Buffer.from(base64, 'base64').toString('binary');
 }