Job cancallation (#2763)

Add the ability to cancel jobs from the Quantum Workspace tree view.

Author: billti

source/vscode/package.json

@@ -205,6 +205,10 @@
           "command": "qsharp-vscode.downloadRawResults",
           "when": "qsharp-vscode.treeItemSupportsDownload"
         },
+        {
+          "command": "qsharp-vscode.cancelJob",
+          "when": "qsharp-vscode.treeItemIsCancelable"
+        },
         {
           "command": "qsharp-vscode.getQir",
           "when": "resourceLangId == qsharp || resourceLangId == openqasm"
@@ -272,6 +276,11 @@
           "group": "inline",
           "when": "view == quantum-workspaces && viewItem == qir-target"
         },
+        {
+          "command": "qsharp-vscode.cancelJob",
+          "group": "inline",
+          "when": "view == quantum-workspaces && viewItem == job-cancelable"
+        },
         {
           "command": "qsharp-vscode.downloadResults",
           "group": "inline",
@@ -424,6 +433,12 @@
         "title": "Download Azure Quantum job results as text",
         "icon": "$(output)"
       },
+      {
+        "command": "qsharp-vscode.cancelJob",
+        "category": "QDK",
+        "title": "Cancel Azure Quantum job",
+        "icon": "$(stop-circle)"
+      },
       {
         "command": "qsharp-vscode.createNotebook",
         "category": "QDK",

source/vscode/src/azure/commands.ts

@@ -33,6 +33,7 @@ import {
   WorkspaceTreeProvider,
 } from "./treeView";
 import {
+  cancelPendingJob,
   getAzurePortalWorkspaceLink,
   getJobFiles,
   getPythonCodeForWorkspace,
@@ -76,6 +77,7 @@ export async function initAzureWorkspaces(context: vscode.ExtensionContext) {
       let supportsQir = false;
       let supportsDownload = false;
       let isWorkspace = false;
+      let isCancelable = false;
 
       if (e.selection.length === 1) {
         currentTreeItem = e.selection[0] as WorkspaceTreeItem;
@@ -90,6 +92,9 @@ export async function initAzureWorkspaces(context: vscode.ExtensionContext) {
           if (job.status === "Succeeded" && job.outputDataUri) {
             supportsDownload = true;
           }
+          if (job.status === "Waiting" || job.status === "Executing") {
+            isCancelable = true;
+          }
         }
         if (currentTreeItem.type === "workspace") {
           isWorkspace = true;
@@ -113,6 +118,11 @@ export async function initAzureWorkspaces(context: vscode.ExtensionContext) {
         `${qsharpExtensionId}.treeItemIsWorkspace`,
         isWorkspace,
       );
+      await vscode.commands.executeCommand(
+        "setContext",
+        `${qsharpExtensionId}.treeItemIsCancelable`,
+        isCancelable,
+      );
     }),
   );
 
@@ -236,6 +246,43 @@ export async function initAzureWorkspaces(context: vscode.ExtensionContext) {
     ),
   );
 
+  async function cancelJob(arg?: WorkspaceTreeItem) {
+    // Could be run via the treeItem icon or the menu command.
+    const treeItem = arg || currentTreeItem;
+    if (treeItem?.type !== "job") return;
+
+    const job = treeItem.itemData as Job;
+
+    // Confirm cancellation with the user
+    const confirm = await vscode.window.showWarningMessage(
+      `Are you sure you want to cancel the job "${job.name}"?`,
+      { modal: true },
+      { title: "Yes", isCloseAffordance: false },
+      { title: "No", isCloseAffordance: true },
+    );
+    if (confirm?.title !== "Yes") return;
+
+    try {
+      // Get the token
+      const token = await getTokenForWorkspace(treeItem.workspace);
+      if (!token) throw "Unable to get an authentication token";
+
+      // Call the network request
+      await cancelPendingJob(treeItem.workspace, token, job.id);
+
+      // Report success/failure to the user
+      vscode.window.showInformationMessage(
+        "The cancel request has been submitted.",
+      );
+    } catch (e: any) {
+      log.error("Failed to cancel the job: ", e);
+      vscode.window.showErrorMessage("Failed to cancel the job.", {
+        modal: true,
+        detail: e instanceof Error ? e.message : undefined,
+      });
+    }
+  }
+
   async function downloadResults(arg?: WorkspaceTreeItem, showText?: boolean) {
     // Could be run via the treeItem icon or the menu command.
     const treeItem = arg || currentTreeItem;
@@ -287,6 +334,13 @@ export async function initAzureWorkspaces(context: vscode.ExtensionContext) {
     }
   }
 
+  context.subscriptions.push(
+    vscode.commands.registerCommand(
+      `${qsharpExtensionId}.cancelJob`,
+      async (arg: WorkspaceTreeItem) => await cancelJob(arg),
+    ),
+  );
+
   context.subscriptions.push(
     vscode.commands.registerCommand(
       `${qsharpExtensionId}.downloadResults`,

source/vscode/src/azure/networkRequests.ts

@@ -49,10 +49,16 @@ export async function azureRequest(
     }
 
     log.debug(`Got response ${response.status} ${response.statusText}`);
-    const result = await response.json();
-    log.trace("Response value: ", result);
 
-    return result;
+    // No payload is expected from delete requests
+    if (method === "DELETE") {
+      return;
+    } else {
+      const result = await response.json();
+      log.trace("Response value: ", result);
+
+      return result;
+    }
   } catch (e) {
     if (associationId) {
       sendTelemetryEvent(

source/vscode/src/azure/treeView.ts

@@ -243,11 +243,14 @@ export class WorkspaceTreeItem extends vscode.TreeItem {
         this.collapsibleState = vscode.TreeItemCollapsibleState.None;
         switch (job.status) {
           case "Executing":
+            this.contextValue = "job-cancelable";
+          // falls through
           case "Finishing":
             this.iconPath = new vscode.ThemeIcon("run-all");
             break;
           case "Waiting":
             this.iconPath = new vscode.ThemeIcon("loading~spin");
+            this.contextValue = "job-cancelable";
             break;
           case "Cancelled":
             this.iconPath = new vscode.ThemeIcon("circle-slash");

source/vscode/src/azure/workspaceActions.ts

@@ -577,6 +577,18 @@ export async function submitJob(
   return { jobId, storageUris, quantumUris, token };
 }
 
+export async function cancelPendingJob(
+  workspace: WorkspaceConnection,
+  token: string,
+  jobId: string,
+): Promise<void> {
+  const quantumUris = new QuantumUris(workspace.endpointUri, workspace.id);
+
+  const cancelJobUri = quantumUris.jobs(jobId);
+
+  await azureRequest(cancelJobUri, token, undefined, "DELETE", undefined);
+}
+
 async function putJobData(
   quantumUris: QuantumUris,
   storageUris: StorageUris,