Attempt to improve error detection

Update message for accuracy

Remove debug logging

Remove unnecessary logging

Suggest to users that Deno may be failing to run tests

Provide feedback even when tests take long

Author: belcar-s

src/commands/tests.sidebar.ts

@@ -3,9 +3,6 @@ import {
   NotificationRequest,
   nova,
   Process,
-  TextEditor,
-  Transferrable,
-  Workspace,
   wrapCommand,
 } from "../nova_utils.ts";
 import TestsDataProvider, {
@@ -62,8 +59,6 @@ export function registerRunAll(testsDataProvider: TestsDataProvider) {
       "state.json",
     );
 
-    console.log(hiddenWorkspaceDataPath);
-
     function warningWasShown(path: string): boolean {
       try {
         const file = nova.fs.open(path) as FileTextMode;
@@ -81,11 +76,8 @@ export function registerRunAll(testsDataProvider: TestsDataProvider) {
           );
         }
         nova.fs.open(path, "x").close();
-        console.log("hi");
         const file = nova.fs.open(path, "w");
-        console.log("hii");
         file.write(JSON.stringify({ warningWasShown: false }));
-        console.log("hiii");
         file.close();
         return warningWasShown(path);
       }
@@ -110,7 +102,6 @@ export function registerRunAll(testsDataProvider: TestsDataProvider) {
 
       const oldFile = nova.fs.open(hiddenWorkspaceDataPath) as FileTextMode;
       const data = JSON.parse(oldFile.readlines().join("\n"));
-      console.log(JSON.stringify(data));
       oldFile.close();
       nova.fs.remove(hiddenWorkspaceDataPath);
       nova.fs.open(hiddenWorkspaceDataPath, "x").close();
@@ -120,6 +111,16 @@ export function registerRunAll(testsDataProvider: TestsDataProvider) {
       file.close();
     }
 
+    const timeoutID = setTimeout(() => {
+      const stillRunningNotificationRequest = new NotificationRequest(
+        "co.gwil.deno.notifications.runningTests",
+      );
+      stillRunningNotificationRequest.title = "The tests are still being run.";
+      stillRunningNotificationRequest.body =
+        "It's just taking a while. Please wait.";
+      nova.notifications.add(stillRunningNotificationRequest);
+    }, 3 * 1000);
+
     try {
       await testsDataProvider.runTests();
       testsDataProvider.treeView.reload();
@@ -139,6 +140,8 @@ export function registerRunAll(testsDataProvider: TestsDataProvider) {
         // shown as a Nova message regardless; doesn't produce a crash
         throw e;
       }
+    } finally {
+      clearTimeout(timeoutID);
     }
   }
 }

src/sidebars.ts

@@ -3,6 +3,9 @@ import { TreeItem } from "./nova_utils.ts";
 export interface Element {
   toTreeItem: () => TreeItem;
   children: Element[];
+  path?: string;
+  uri?: string;
+  shouldDisambiguate?: boolean;
 }
 
 export class Header implements Element {

src/tests/TestsDataProvider.ts

@@ -2,6 +2,8 @@ import {
   Color,
   ColorComponents,
   ColorFormat, // It is, actually, read. I think this message is due to a @ts-expect-error.
+  getOverridableBoolean,
+  NotificationRequest,
   nova,
   Process,
   TreeDataProvider,
@@ -45,6 +47,7 @@ class Test implements Element {
       this.passed ? passedColorComponents : failedColorComponents,
     );
     item.descriptiveText = this.passed ? "Passed" : "Failed";
+    item.contextValue = "test";
 
     return item;
   }
@@ -81,6 +84,8 @@ export class TestFile implements Element {
       : TreeItemCollapsibleState.None;
     item.contextValue = "file";
     item.identifier = this.path;
+    item.command = "co.gwil.deno.sidebars.tests.commands.open";
+
     return item;
   }
 }
@@ -161,15 +166,26 @@ export default class TestsDataProvider implements TreeDataProvider<Element> {
     // The above process is carried out instead of replacing the `this.files` property. I prefer this because it does not remove test results from the sidebar.
   }
 
-  runTests() {
+  runTests(tests?: string[]) {
     if (!nova.workspace.path) {
       throw new Error("This function requires a workspace path.");
     }
 
-    const paths = this.files.map((file) => file.path);
+    const paths = tests ?? this.files.map((file) => file.path);
+    const args = ["test", "-A"];
+
+    if (getOverridableBoolean("co.gwil.deno.config.enableUnstable")) {
+      args.push("--unstable");
+    }
+    const potentialImportMapLocation = nova.workspace.config.get(
+      "co.gwil.deno.config.import-map",
+    );
+    if (potentialImportMapLocation) {
+      args.push("--import-map=" + potentialImportMapLocation);
+    }
 
     const options = {
-      args: ["deno", "test", "-A", ...paths],
+      args: ["deno", ...args, ...paths],
       cwd: nova.workspace.path,
     };
     const denoProcess = new Process("/usr/bin/env", options);
@@ -184,10 +200,14 @@ export default class TestsDataProvider implements TreeDataProvider<Element> {
     const output: TestFile[] = [];
 
     let loggingError: UnexpectedLogError | null = null;
-    denoProcess.onStdout((line) => {
+    denoProcess.onStderr((line) => {
       // remove newline
       line = line.slice(0, -1);
       console.log(line);
+    });
+    denoProcess.onStdout((line) => {
+      line = line.slice(0, -1);
+
       // remove control (?) characters that make output colorful
       line = line.replace(
         CONTROL_REGEXP,
@@ -224,13 +244,44 @@ export default class TestsDataProvider implements TreeDataProvider<Element> {
       }
     });
 
-    const onExit = new Promise((resolve, reject) => {
+    const onExit = new Promise<TestFile[]>((resolve, reject) => {
       denoProcess.onDidExit(() => {
         // TODO: explore the dangers regarding tests that take long to execute
-        this.files = output;
         if (loggingError) {
           reject(loggingError);
         } else {
+          for (const file of output) {
+            const analogousIndex = this.files.findIndex(
+              (oldFile) => oldFile.path == file.path,
+            );
+            if (analogousIndex != -1) {
+              this.files[analogousIndex] = file;
+            } else {
+              this.files.push(file);
+            }
+          }
+
+          const paths = output.map((file) => file.path);
+          const missingFiles = this.files.filter(
+            (file) => !paths.includes(file.path),
+          );
+          for (
+            const file of missingFiles
+          ) {
+            file.children = [new Header("Failed to run")];
+          }
+
+          if (missingFiles.length) {
+            const configurationErrorNotificationRequest =
+              new NotificationRequest(
+                "co.gwil.deno.notifications.unexpectedEmptiness",
+              );
+            configurationErrorNotificationRequest.title = "Expecting more?";
+            configurationErrorNotificationRequest.body =
+              "Deno may be failing to run some tests. Check the extension console for logging.";
+            nova.notifications.add(configurationErrorNotificationRequest);
+          }
+
           resolve(output);
         }
       });