Let users cancel deploy and destroy actions (#1375)

## Changes Let users cancel deploy and destroy actions ## Tests Manual ad existing tests
databricks · Sep 25, 2024 · 33602dd · 33602dd
1 parent ddc5d2a
commit 33602dd
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 24 deletions.
diff --git a/packages/databricks-vscode/src/bundle/models/BundleRemoteStateModel.ts b/packages/databricks-vscode/src/bundle/models/BundleRemoteStateModel.ts
@@ -9,6 +9,7 @@ import {WorkspaceConfigs} from "../../vscode-objs/WorkspaceConfigs";
 import {logging} from "@databricks/databricks-sdk";
 import {Loggers} from "../../logger";
 import {WorkspaceFolderManager} from "../../vscode-objs/WorkspaceFolderManager";
+import {CancellationToken} from "vscode";
 
 /* eslint-disable @typescript-eslint/naming-convention */
 export type BundleResourceModifiedStatus = "created" | "deleted" | "updated";
@@ -63,7 +64,7 @@ export class BundleRemoteStateModel extends BaseModelWithStateCache<BundleRemote
     }
 
     @Mutex.synchronise("mutex")
-    public async deploy(force = false) {
+    public async deploy(force = false, token?: CancellationToken) {
         if (this.target === undefined) {
             throw new Error("Target is undefined");
         }
@@ -77,12 +78,13 @@ export class BundleRemoteStateModel extends BaseModelWithStateCache<BundleRemote
             this.workspaceFolder,
             this.workspaceConfigs.databrickscfgLocation,
             this.logger,
-            force
+            force,
+            token
         );
     }
 
     @Mutex.synchronise("mutex")
-    public async destroy(force = false) {
+    public async destroy(force = false, token: CancellationToken) {
         if (this.target === undefined) {
             throw new Error("Target is undefined");
         }
@@ -96,7 +98,8 @@ export class BundleRemoteStateModel extends BaseModelWithStateCache<BundleRemote
             this.workspaceFolder,
             this.workspaceConfigs.databrickscfgLocation,
             this.logger,
-            force
+            force,
+            token
         );
     }
 

diff --git a/packages/databricks-vscode/src/cli/CliWrapper.ts b/packages/databricks-vscode/src/cli/CliWrapper.ts
@@ -145,6 +145,12 @@ export class ProcessError extends Error {
     }
 }
 
+export class CancellationError extends Error {
+    constructor() {
+        super("Cancelled");
+    }
+}
+
 export async function waitForProcess(
     p: ChildProcessWithoutNullStreams,
     onStdOut?: (data: string) => void,
@@ -195,7 +201,8 @@ async function runBundleCommand(
     outputHandlers: {
         onStdOut?: (data: string) => void;
         onStdError?: (data: string) => void;
-    } = {}
+    } = {},
+    cancellationToken?: CancellationToken
 ) {
     const defaultOutputHandlers = {
         onStdOut: (data: string) => {
@@ -219,27 +226,36 @@ async function runBundleCommand(
     });
 
     logger?.debug(quote([cmd, ...args]), {bundleOpName});
+    const abortController = new AbortController();
+    cancellationToken?.onCancellationRequested(() => abortController.abort());
     let options: SpawnOptionsWithoutStdio = {
         cwd: workspaceFolder.fsPath,
         env: removeUndefinedKeys(env),
+        signal: abortController.signal,
     };
 
     ({cmd, args, options} = getEscapedCommandAndAgrs(cmd, args, options));
     try {
         const p = spawn(cmd, args, options);
-
         const {stdout, stderr} = await waitForProcess(p, onStdOut, onStdError);
         logger?.info(displayLogs.end, {
             bundleOpName,
         });
         logger?.debug("output", {stdout, stderr, bundleOpName});
         return {stdout, stderr};
     } catch (e: any) {
-        logger?.error(`${displayLogs.error} ${e.message ?? ""}`, {
-            ...e,
-            bundleOpName,
-        });
-        throw new ProcessError(e.message, e.code);
+        if (cancellationToken?.isCancellationRequested) {
+            logger?.warn(`${displayLogs.error} Reason: Cancelled`, {
+                bundleOpName,
+            });
+            throw new CancellationError();
+        } else {
+            logger?.error(`${displayLogs.error} ${e.message ?? ""}`, {
+                ...e,
+                bundleOpName,
+            });
+            throw new ProcessError(e.message, e.code);
+        }
     }
 }
 /**
@@ -574,7 +590,8 @@ export class CliWrapper {
         workspaceFolder: Uri,
         configfilePath?: string,
         logger?: logging.NamedLogger,
-        force = false
+        force = false,
+        token?: CancellationToken
     ) {
         await commands.executeCommand("databricks.bundle.showLogs");
         return await runBundleCommand(
@@ -598,7 +615,9 @@ export class CliWrapper {
                 error: "Failed to deploy the bundle.",
             },
             await this.getBundleCommandEnvVars(authProvider, configfilePath),
-            logger
+            logger,
+            {},
+            token
         );
     }
 
@@ -608,7 +627,8 @@ export class CliWrapper {
         workspaceFolder: Uri,
         configfilePath?: string,
         logger?: logging.NamedLogger,
-        force = false
+        force = false,
+        token?: CancellationToken
     ) {
         await commands.executeCommand("databricks.bundle.showLogs");
         return await runBundleCommand(
@@ -629,7 +649,9 @@ export class CliWrapper {
                 error: "Failed to destroy the bundle.",
             },
             await this.getBundleCommandEnvVars(authProvider, configfilePath),
-            logger
+            logger,
+            {},
+            token
         );
     }
 

diff --git a/packages/databricks-vscode/src/ui/bundle-resource-explorer/BundleCommands.ts b/packages/databricks-vscode/src/ui/bundle-resource-explorer/BundleCommands.ts
@@ -91,11 +91,11 @@ export class BundleCommands implements Disposable {
             this.whenContext.setDeploymentState("deploying");
             const mode = await this.configModel.get("mode");
             const target = this.configModel.target;
+            const prettyMode = humaniseMode(mode);
+            const title = `Deploying the bundle to ${prettyMode} target "${target}".`;
             if (mode !== "development") {
                 const choice = await window.showInformationMessage(
-                    `Deploying bundle to ${humaniseMode(
-                        mode
-                    )} target "${target}".`,
+                    title,
                     {modal: true},
                     "Continue"
                 );
@@ -107,9 +107,13 @@ export class BundleCommands implements Disposable {
                 }
             }
             await window.withProgress(
-                {location: ProgressLocation.Notification, cancellable: false},
-                async () => {
-                    await this.bundleRemoteStateModel.deploy(force);
+                {
+                    location: ProgressLocation.Notification,
+                    title: title,
+                    cancellable: true,
+                },
+                async (progress, token) => {
+                    await this.bundleRemoteStateModel.deploy(force, token);
                 }
             );
 
@@ -187,9 +191,13 @@ export class BundleCommands implements Disposable {
         try {
             this.whenContext.setDeploymentState("deploying");
             await window.withProgress(
-                {location: ProgressLocation.Notification, cancellable: false},
-                async () => {
-                    await this.bundleRemoteStateModel.destroy(force);
+                {
+                    location: ProgressLocation.Notification,
+                    title: "Destroying the bundle",
+                    cancellable: true,
+                },
+                async (progress, token) => {
+                    await this.bundleRemoteStateModel.destroy(force, token);
                 }
             );