refactor: improve logging and comments

Author: jakobrosenberg

src/Device.js

@@ -118,6 +118,15 @@ class Device {
     subscribe(() => this.onChanged());
 
     this.busy.subscribe((val) => this.log.debugShort(val ? "busy..." : "idle."));
+    this.busy.subscribe(
+      (isBusy) =>
+        !isBusy &&
+        this.adapter.__proxyMeta.isBusy &&
+        this.log.error(
+          "Device is not busy, but the adapter queue is active. Current task:",
+          [...this.adapter.__proxyMeta.history].pop()
+        )
+    );
 
     this.readUntil = createReadUntil();
     this.readUntil(/\n>>> [^\n]*$/, (matches) => this.busy.set(!matches), { callOnFalse: true });
@@ -231,7 +240,7 @@ class Device {
    */
   async runScript(script, options) {
     options = Object.assign({}, runScriptDefaults, options);
-    this.log.debug(`runScript:\n\n${script}\n\n`);
+    this.log.debug(`queued runScript:\n\n${script}\n\n`);
     this.busy.set(true);
     const start = Date.now();
     const result = await this.adapter.runScript(script + "\n\r\n\r\n", options);
@@ -497,6 +506,7 @@ class Device {
    * }} options
    */
   async upload(source, destination, options) {
+    this.log.debug("upload", source, "to", destination);
     destination = posix.join(this.config.rootPath, destination.replace(/[\/\\]+/g, "/"));
     await this.adapter.mkdirs(dirname(destination));
 

src/providers/FilesystemProvider.js

@@ -27,13 +27,13 @@ class FileSystemProvider {
       return await device.adapter.remove(uri.path, isDir);
     } catch (err) {
       if (err.message.endsWith(" ENOENT")) throw vscode.FileSystemError.FileNotFound(`Could not find '${uri.path}'.`);
-      else this.pymakr.notifier.notifications.uncaughtError(err)
+      else this.pymakr.notifier.notifications.uncaughtError(err);
     }
   }
 
   watch(uri, options) {
     // todo?
-    return new vscode.Disposable(() => { });
+    return new vscode.Disposable(() => {});
   }
 
   async rename(oldUri, newUri) {
@@ -50,7 +50,7 @@ class FileSystemProvider {
    * @param {vscode.Uri} uri
    */
   async readFile(uri) {
-    this.log.debug('read file', uri)
+    this.log.debug("read file", uri);
     const device = this._getDevice(uri);
     return device.adapter.getFile(uri.path);
   }

src/stores/devices.js

@@ -10,7 +10,7 @@ const { SerialPort } = require("serialport");
  */
 const rawSerialToDeviceInput = (raw) => ({
   address: raw.path,
-  name: raw.friendlyName || raw.path.replace(/^\/dev\//, ''),
+  name: raw.friendlyName || raw.path.replace(/^\/dev\//, ""),
   protocol: "serial",
   id: raw.serialNumber,
   raw,
@@ -60,7 +60,7 @@ const createDevicesStore = (pymakr) => {
       );
 
   const registerUSBDevices = async () => {
-    pymakr.log.traceShort("register USB devices");
+    pymakr.log.trace("register USB devices");
     const rawSerials = await SerialPort.list();
     const deviceInputs = rawSerials.map(rawSerialToDeviceInput);
     const inputIds = deviceInputs.map((deviceInput) => deviceInput.id);