feat: improve error handling when taskfiles contain errors (#25)

Author: pd93

CHANGELOG.md

@@ -2,7 +2,9 @@
 
 ## Unreleased
 
-- Added the ability to sort tasks in the tree view.
+- Improve error handling in when Taskfiles contain errors (#25 by @pd93).
+- Added a new command: `Task: Show Debug Panel` to show the Task debug panel (#25 by @pd93).
+- Added the ability to sort tasks in the tree view (#20 by @pd93).
   - Configurable via `task.tree.sort` setting (values: `"default"` (default), `"alphanumeric"` or `"none"`).
 
 ## v0.1.1 - 2021-03-27

package.json

@@ -102,6 +102,12 @@
         "title": "Open Usage",
         "category": "Task",
         "icon": "$(globe)"
+      },
+      {
+        "command": "vscode-task.showDebugPanel",
+        "title": "Show Debug Panel",
+        "category": "Task",
+        "icon": "$(debug)"
       }
     ],
     "viewsContainers": {
@@ -124,18 +130,23 @@
     "viewsWelcome": [
       {
         "view": "vscode-task.tasks",
-        "contents": "Task not installed. Click the button below to install it.\n[Install Task](command:vscode-task.openInstallation)\nTo learn more about how to use Task [read our docs](https://taskfile.dev).",
+        "contents": "Task not installed. Click the button below to install it.\n[Install Task](command:vscode-task.openInstallation)\nTo learn more about how to use Task, [read our docs](https://taskfile.dev).",
         "when": "vscode-task:status == 'notInstalled'"
       },
       {
         "view": "vscode-task.tasks",
-        "contents": "Task is out of date. Click the button below to update it.\n[Update Task](command:vscode-task.openInstallation)\nTo learn more about how to use Task [read our docs](https://taskfile.dev).",
+        "contents": "Task is out of date. Click the button below to update it.\n[Update Task](command:vscode-task.openInstallation)\nTo learn more about how to use Task, [read our docs](https://taskfile.dev).",
         "when": "vscode-task:status == 'outOfDate'"
       },
       {
         "view": "vscode-task.tasks",
-        "contents": "No Taskfile found in this workspace. Click the button below to get started and initialize a new Taskfile.\n[Initialize Taskfile](command:vscode-task.init)\nTo learn more about how to use Task [read our docs](https://taskfile.dev).",
+        "contents": "No Taskfile found in this workspace. Click the button below to get started and initialize a new Taskfile.\n[Initialize Taskfile](command:vscode-task.init)\nTo learn more about how to use Task, [read our docs](https://taskfile.dev).",
         "when": "vscode-task:status == 'noTaskfile'"
+      },
+      {
+        "view": "vscode-task.tasks",
+        "contents": "An error occurred while reading the Taskfile. [Check the output panel](command:vscode-task.showDebugPanel) for more information\nTo learn more about how to use Task, [read our docs](https://taskfile.dev).",
+        "when": "vscode-task:status == 'error'"
       }
     ],
     "menus": {

src/services/taskfile.ts

@@ -14,6 +14,23 @@ type ReleaseResponse = Endpoints["GET /repos/{owner}/{repo}/releases/latest"]["r
 
 const minimumRequiredVersion = '3.23.0';
 const minimumRequiredVersionForSorting = '3.24.0';
+const minimumRequiredVersionForExitCodes = '3.24.0';
+
+// General exit codes
+const errCodeOK = 0;
+const errCodeUnknown = 1;
+
+// Taskfile related exit codes
+const errCodeTaskfileNotFound = 100;
+const errCodeTaskfileAlreadyExists = 101;
+const errCodeTaskfileInvalid = 102;
+
+// Task related exit codes
+const errCodeTaskNotFound = 200;
+const errCodeTaskRunError = 201;
+const errCodeTaskInternal = 202;
+const errCodeTaskNameConflict = 203;
+const errCodeTaskCalledTooManyTimes = 204;
 
 class TaskfileService {
     private static _instance: TaskfileService;
@@ -150,7 +167,7 @@ class TaskfileService {
         }
     }
 
-    public async read(dir: string): Promise<models.Taskfile> {
+    public async read(dir: string): Promise<models.Taskfile | undefined> {
         log.info(`Searching for taskfile in: "${dir}"`);
         return await new Promise((resolve, reject) => {
             let additionalFlags = "";
@@ -163,10 +180,29 @@ class TaskfileService {
                 }
             }
             let command = this.command(`--list-all --json${additionalFlags}`);
-            cp.exec(command, { cwd: dir }, (err: cp.ExecException | null, stdout: string) => {
+            cp.exec(command, { cwd: dir }, (err: cp.ExecException | null, stdout: string, stderr: string) => {
                 if (err) {
                     log.error(err);
-                    return reject();
+                    // TODO: Bump the minimum required version to remove this conditional
+                    let shouldDisplayError = false;
+                    if (err.code && this.version && this.version.compare(minimumRequiredVersionForExitCodes) >= 0) {
+                        let exitCodesToDisplayErrorsFor = [
+                            errCodeTaskfileInvalid,
+                        ];
+                        if (exitCodesToDisplayErrorsFor.includes(err.code)) {
+                            shouldDisplayError = true;
+                        }
+                    } else {
+                        if (err.message.toLowerCase().includes("failed to parse")) {
+                            shouldDisplayError = true;
+                        }
+                    }
+                    // Display an error message
+                    if (shouldDisplayError) {
+                        vscode.window.showErrorMessage(stderr);
+                        return reject();
+                    }
+                    return resolve(undefined);
                 }
                 var taskfile: models.Taskfile = JSON.parse(stdout);
                 if (path.dirname(taskfile.location) !== dir) {

src/task.ts

@@ -17,7 +17,7 @@ export class TaskExtension {
 
     public async update(checkForUpdates?: boolean): Promise<void> {
         // Do version checks
-        await services.taskfile.checkInstallation(checkForUpdates).then((status): Promise<PromiseSettledResult<models.Taskfile>[]> => {
+        await services.taskfile.checkInstallation(checkForUpdates).then((status): Promise<PromiseSettledResult<models.Taskfile | undefined>[]> => {
 
             // Set the status
             vscode.commands.executeCommand('setContext', 'vscode-task:status', status);
@@ -28,16 +28,26 @@ export class TaskExtension {
             }
 
             // Read taskfiles
-            let p: Promise<models.Taskfile>[] = [];
+            let p: Promise<models.Taskfile | undefined>[] = [];
             vscode.workspace.workspaceFolders?.forEach((folder) => {
                 p.push(services.taskfile.read(folder.uri.fsPath));
             });
             return Promise.allSettled(p);
 
         // If there are no valid taskfiles, set the status to "noTaskfile"
         }).then(results => {
-            this._taskfiles = results.filter(result => result.status === "fulfilled").map(result => <PromiseFulfilledResult<any>>result).map(result => result.value);
-            if (this._taskfiles.length === 0) {
+            this._taskfiles = results
+                .filter(result => result.status === "fulfilled")
+                .map(result => <PromiseFulfilledResult<any>>result)
+                .map(result => result.value)
+                .filter(value => value !== undefined);
+            let rejected = results
+                .filter(result => result.status === "rejected")
+                .map(result => <PromiseRejectedResult>result)
+                .map(result => result.reason);
+            if (rejected.length > 0) {
+                vscode.commands.executeCommand('setContext', 'vscode-task:status', "error");
+            } else if (this._taskfiles.length === 0) {
                 vscode.commands.executeCommand('setContext', 'vscode-task:status', "noTaskfile");
             }
         });
@@ -180,6 +190,11 @@ export class TaskExtension {
             log.info("Command: vscode-task.openUsage");
             vscode.env.openExternal(vscode.Uri.parse('https://taskfile.dev/usage'));
         }));
+
+        // Show debug window
+        context.subscriptions.push(vscode.commands.registerCommand('vscode-task.showDebugPanel', () => {
+            log.channel.show();
+        }));
     }
 
     public registerListeners(context: vscode.ExtensionContext): void {

src/utils/log.ts

@@ -4,7 +4,7 @@ class Log {
     private static _instance: Log;
 
     constructor(
-        private _channel: vscode.OutputChannel = vscode.window.createOutputChannel("Task (Debug)")
+        public channel: vscode.OutputChannel = vscode.window.createOutputChannel("Task (Debug)")
     ) { }
 
     public static get instance() {
@@ -13,12 +13,12 @@ class Log {
 
     info(v: any) {
         console.log(v);
-        this._channel.appendLine(v);
+        this.channel.appendLine(v);
     }
 
     error(err: any) {
         console.error(err);
-        this._channel.appendLine(err);
+        this.channel.appendLine(err);
     }
 }