Improve error display in workflow runs (#218)

fjakobs · web-flow · commit def98017f880 · 2022-11-14T12:28:16.000+01:00
Before: ![Screenshot 2022-11-11 at 15 01 00](https://user-images.githubusercontent.com/40952/201642880-85cf2140-6e73-4734-87d8-a024f482908b.png) After: ![Screenshot 2022-11-14 at 11 56 34](https://user-images.githubusercontent.com/40952/201642984-6a1b7848-d007-478f-bad9-e1d8f6c1c189.png)
diff --git a/packages/databricks-sdk-js/src/services/WorkflowRun.integ.ts b/packages/databricks-sdk-js/src/services/WorkflowRun.integ.ts
@@ -101,4 +101,61 @@ describe(__filename, function () {
             await workspaceService.delete({path: jobPath});
         }
     });
+
+    it("should run a broken notebook job", async () => {
+        const cluster = await Cluster.fromClusterId(
+            integSetup.client,
+            integSetup.cluster.id
+        );
+
+        const jobPath = `/tmp/sdk-js-integ-${integSetup.testRunId}.py`;
+        const workspaceService = new WorkspaceService(integSetup.client);
+
+        await workspaceService.mkdirs({path: "/tmp"});
+
+        await workspaceService.import({
+            path: jobPath,
+            format: "SOURCE",
+            language: "PYTHON",
+            content: Buffer.from(
+                `# Databricks notebook source
+# COMMAND ----------
+            
+pr int("Cell 1")
+            
+# COMMAND ----------
+
+print("Cell 2")`
+            ).toString("base64"),
+            overwrite: true,
+        });
+
+        try {
+            const progress: Array<WorkflowRun> = [];
+            const output = await cluster.runNotebookAndWait({
+                path: `${jobPath}`,
+                onProgress: (
+                    _state: jobs.RunLifeCycleState,
+                    run: WorkflowRun
+                ) => {
+                    progress.push(run);
+                },
+            });
+
+            assert(progress.length > 1);
+            assert.equal(
+                progress[progress.length - 1].lifeCycleState,
+                "INTERNAL_ERROR"
+            );
+
+            assert(
+                output.views &&
+                    output.views.length > 0 &&
+                    output.views[0].content
+            );
+            assert(output.views[0].content.startsWith("<!DOCTYPE html>"));
+        } finally {
+            await workspaceService.delete({path: jobPath});
+        }
+    });
 });
diff --git a/packages/databricks-sdk-js/src/services/WorkflowRun.ts b/packages/databricks-sdk-js/src/services/WorkflowRun.ts
@@ -62,7 +62,10 @@ export class WorkflowRun {
 
     async export(task?: RunTask): Promise<ExportRunOutput> {
         task = task || this.tasks![0];
-        if (this.lifeCycleState !== "TERMINATED") {
+        if (
+            this.lifeCycleState !== "TERMINATED" &&
+            this.lifeCycleState !== "INTERNAL_ERROR"
+        ) {
             throw new Error("Run is not terminated");
         }
         if (!this.tasks || !this.tasks.length) {
diff --git a/packages/databricks-vscode/src/run/WorkflowOutputPanel.ts b/packages/databricks-vscode/src/run/WorkflowOutputPanel.ts
@@ -64,11 +64,30 @@ export class WorkflowOutputPanel {
         });
     }
 
+    private getStateString(runState: jobs.RunLifeCycleState): string {
+        switch (runState) {
+            case "PENDING":
+                return "Pending";
+            case "RUNNING":
+                return "Running";
+            case "TERMINATED":
+                return "Terminated";
+            case "SKIPPED":
+                return "Skipped";
+            case "INTERNAL_ERROR":
+                return "Failed";
+            default:
+                return "Unknown";
+        }
+    }
+
     async updateState(
         cluster: Cluster,
-        state: jobs.RunLifeCycleState,
+        runState: jobs.RunLifeCycleState,
         run: WorkflowRun
     ) {
+        const state = this.getStateString(runState);
+
         this.panel.webview.postMessage({
             type: "status",
             state,
diff --git a/packages/databricks-vscode/src/run/WorkflowRunner.ts b/packages/databricks-vscode/src/run/WorkflowRunner.ts
@@ -22,6 +22,7 @@ import {WorkflowOutputPanel} from "./WorkflowOutputPanel";
 
 export class WorkflowRunner implements Disposable {
     private panels = new Map<string, WorkflowOutputPanel>();
+    private disposables = new Array<Disposable>();
 
     constructor(
         private context: ExtensionContext,
@@ -32,6 +33,7 @@ export class WorkflowRunner implements Disposable {
         for (const panel of this.panels.values()) {
             panel.dispose();
         }
+        this.disposables.forEach((d) => d.dispose());
     }
 
     private async getPanelForUri(uri: Uri) {
@@ -54,6 +56,9 @@ export class WorkflowRunner implements Disposable {
                 ),
                 this.context.extensionUri
             );
+            this.disposables.push(
+                panel.onDidDispose(() => this.panels.delete(key))
+            );
             this.panels.set(key, panel);
         }
 
diff --git a/packages/databricks-vscode/webview-ui/job.html b/packages/databricks-vscode/webview-ui/job.html
@@ -93,7 +93,13 @@
                 display: none;
             }
 
+            .alert-error .error-icon {
+                display: inline-block;
+                padding: 0 8px;
+            }
+
             .alert-error {
+                display: flex;
                 padding: 8px;
                 margin: 8px;
                 color: rgb(200, 45, 76);
@@ -117,7 +123,7 @@
             }
 
             .output.error #error {
-                display: block;
+                display: flex;
             }
 
             .details {
@@ -139,8 +145,29 @@
                 <iframe id="frame"></iframe>
                 <pre id="stdout"></pre>
                 <div class="alert-error" id="error">
-                    <b id="error-description"></b>
-                    <pre id="error-stack"></pre>
+                    <span class="error-icon">
+                        <svg
+                            width="1em"
+                            height="1em"
+                            viewBox="0 0 24 24"
+                            fill="none"
+                            xmlns="http://www.w3.org/2000/svg"
+                            aria-hidden="true"
+                            focusable="false"
+                            class=""
+                        >
+                            <path
+                                fill-rule="evenodd"
+                                clip-rule="evenodd"
+                                d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm0 11c-.55 0-1-.45-1-1V8c0-.55.45-1 1-1s1 .45 1 1v4c0 .55-.45 1-1 1zm-1 2v2h2v-2h-2z"
+                                fill="currentColor"
+                            ></path>
+                        </svg>
+                    </span>
+                    <div>
+                        <b id="error-description"></b>
+                        <pre id="error-stack"></pre>
+                    </div>
                 </div>
             </div>
             <div class="details">
@@ -174,7 +201,7 @@
                     </li>
                     <li>
                         <span class="label">Status:</span>
-                        <span class="value" id="run-status">SYNCING</span>
+                        <span class="value" id="run-status">Synchronizing</span>
                     </li>
                 </ul>
             </div>
