Merge pull request #195 from codefori/feature/cancel

Feature/cancel

Author: worksofliam

package.json

@@ -347,6 +347,12 @@
         "category": "Db2 for i",
         "icon": "$(notebook-execute)"
       },
+      {
+        "command": "vscode-db2i.statement.cancel",
+        "title": "Cancel",
+        "category": "Db2 for i",
+        "icon": "$(stop)"
+      },
       {
         "command": "vscode-db2i.editorExplain.withRun",
         "title": "Run and explain statement",
@@ -598,16 +604,21 @@
       ],
       "editor/title": [
         {
-          "when": "editorLangId == sql && code-for-ibmi:connected == true",
-          "group": "navigation@sql",
+          "when": "editorLangId == sql && code-for-ibmi:connected == true && vscode-db2i:statementCanCancel != true",
+          "group": "navigation@1",
           "submenu": "sql/editor/context"
+        },
+        {
+          "command": "vscode-db2i.statement.cancel",
+          "when": "editorLangId == sql && vscode-db2i:statementCanCancel == true",
+          "group": "navigation@1"
         }
       ],
       "sql/editor/context": [
         {
           "command": "vscode-db2i.runEditorStatement",
-          "when": "editorLangId == sql",
-          "group": "1_general@sql"
+          "when": "editorLangId == sql && vscode-db2i:statementCanCancel != true",
+          "group": "navigation@1"
         },
         {
           "command": "vscode-db2i.editorExplain.withRun",

src/connection/manager.ts

@@ -11,10 +11,12 @@ export interface JobInfo {
   job: SQLJob;
 }
 
+const NO_SELECTED_JOB = -1;
+
 export class SQLJobManager {
   private totalJobs = 0;
   private jobs: JobInfo[] = [];
-  selectedJob: number = -1;
+  selectedJob: number = NO_SELECTED_JOB;
 
   constructor() { }
 
@@ -50,13 +52,13 @@ export class SQLJobManager {
   }
 
   getRunningJobs() {
-    return this.jobs.filter(info => [JobStatus.Ready, JobStatus.Active].includes(info.job.getStatus()));
+    return this.jobs.filter(info => [JobStatus.Ready, JobStatus.Busy].includes(info.job.getStatus()));
   }
 
   async endAll() {
     await Promise.all(this.jobs.map(current => current.job.close()));
     this.jobs = [];
-    this.selectedJob = -1;
+    this.selectedJob = NO_SELECTED_JOB;
   }
 
   async closeJob(index?: number) {
@@ -86,12 +88,12 @@ export class SQLJobManager {
     return this.jobs.find(info => info.name === name);
   }
 
-  setSelection(selectedName: string): boolean {
+  setSelection(selectedName: string): JobInfo|undefined {
     const jobExists = this.jobs.findIndex(info => info.name === selectedName);
 
     this.selectedJob = jobExists;
 
-    return (this.selectedJob >= 0);
+    return this.jobs[jobExists];
   }
 
   /**
@@ -103,7 +105,6 @@ export class SQLJobManager {
    * @returns 
    */
   async runSQL<T>(query: string, opts?: QueryOptions): Promise<T[]> {
-
     // 2147483647 is NOT arbitrary. On the server side, this is processed as a Java
     // int. This is the largest number available without overflow (Integer.MAX_VALUE)
     const rowsToFetch = 2147483647;

src/connection/sqlJob.ts

@@ -1,4 +1,3 @@
-import { CommandResult } from "@halcyontech/vscode-ibmi-types";
 import { getInstance } from "../base";
 import { ServerComponent } from "./serverComponent";
 import { JDBCOptions, ConnectionResult, Rows, QueryResult, JobLogEntry, CLCommandResult, VersionCheckResult, GetTraceDataResult, ServerTraceDest, ServerTraceLevel, SetConfigResult, QueryOptions, ExplainResults } from "./types";
@@ -8,7 +7,7 @@ import { EventEmitter } from "stream";
 export enum JobStatus {
   NotStarted = "notStarted",
   Ready = "ready",
-  Active = "active",
+  Busy = "busy",
   Ended = "ended"
 }
 
@@ -36,7 +35,6 @@ const TransactionCountQuery = [
 const DB2I_VERSION = (process.env[`DB2I_VERSION`] || `<version unknown>`) + ((process.env.DEV) ? ``:`-dev`);
 
 export class SQLJob {
-
   private static uniqueIdCounter: number = 0;
   private channel: any;
   private responseEmitter: EventEmitter = new EventEmitter();
@@ -130,7 +128,6 @@ export class SQLJob {
 
     let req: ReqRespFmt = JSON.parse(content);
     this.channel.stdin.write(content + `\n`);
-    this.status = JobStatus.Active;
     return new Promise((resolve, reject) => {
       this.responseEmitter.on(req.id, (x: string) => {
         this.responseEmitter.removeAllListeners(req.id);
@@ -140,7 +137,9 @@ export class SQLJob {
   }
 
   getStatus() {
-    return this.status;
+    const currentListenerCount = this.responseEmitter.eventNames().length;
+
+    return currentListenerCount > 0 ? JobStatus.Busy : this.status;
   }
 
   async connect(): Promise<ConnectionResult> {
@@ -204,6 +203,20 @@ export class SQLJob {
     return new Query(this, sql, opts);
   }
 
+  async requestCancel(): Promise<boolean> {
+    const instance = getInstance();
+    const content = instance.getContent();
+
+    // Note that this statement is run via the base extension since it has to be done on a job other than the one whose SQL is getting canceled
+    await content.runSQL(`CALL QSYS2.CANCEL_SQL('${this.id}')`);
+
+    const [row] = await content.runSQL(`select V_SQL_STMT_STATUS as STATUS from table(qsys2.get_job_info('${this.id}'))`) as {STATUS: string|null}[];
+
+    if (row && row.STATUS === `ACTIVE`) return false;
+
+    return true;
+  }
+
   async getVersion(): Promise<VersionCheckResult> {
     const verObj = {
       id: SQLJob.getNewUniqueId(),
@@ -304,7 +317,7 @@ export class SQLJob {
   }
 
   underCommitControl() {
-    return this.options["transaction isolation"] !== `none`;
+    return this.options["transaction isolation"] && this.options["transaction isolation"] !== `none`;
   }
 
   async getPendingTransactions() {

src/views/jobManager/jobManagerView.ts

@@ -2,14 +2,15 @@ import vscode, { ProgressLocation, TreeDataProvider, TreeItemCollapsibleState, U
 import { JobManager } from "../../config";
 import { JobInfo } from "../../connection/manager";
 import { ServerComponent } from "../../connection/serverComponent";
-import { SQLJob, TransactionEndType } from "../../connection/sqlJob";
+import { JobStatus, SQLJob, TransactionEndType } from "../../connection/sqlJob";
 import { JDBCOptions, ServerTraceDest, ServerTraceLevel } from "../../connection/types";
 import { ConfigGroup, ConfigManager } from "./ConfigManager";
 import { editJobUi } from "./editJob";
 import { displayJobLog } from "./jobLog";
 import { selfCodesMap } from "./selfCodes/selfCodes";
 import { SelfCodesQuickPickItem } from "./selfCodes/selfCodesBrowser";
 import { updateStatusBar } from "./statusBar";
+import { setCancelButtonVisibility } from "../results";
 
 const selectJobCommand = `vscode-db2i.jobManager.selectJob`;
 const activeColor = new vscode.ThemeColor(`minimapGutter.addedBackground`);
@@ -302,6 +303,9 @@ export class JobManagerView implements TreeDataProvider<any> {
   refresh() {
     this._onDidChangeTreeData.fire();
     updateStatusBar();
+
+    const selectedJob = JobManager.getSelection();
+    setCancelButtonVisibility(selectedJob && selectedJob.job.getStatus() === JobStatus.Busy);
   }
 
   getTreeItem(element: vscode.TreeItem) {

src/views/jobManager/statusBar.ts

@@ -5,7 +5,7 @@ import { getInstance } from "../../base";
 
 const item = window.createStatusBarItem(`sqlJob`, StatusBarAlignment.Left);
 
-export async function updateStatusBar(options: {newJob?: boolean} = {}) {
+export async function updateStatusBar(options: {newJob?: boolean, canceling?: boolean, jobIsBusy?: boolean, executing?: boolean} = {}) {
   const instance = getInstance();
   const connection = instance.getConnection();
 
@@ -16,6 +16,15 @@ export async function updateStatusBar(options: {newJob?: boolean} = {}) {
     let backgroundColour: ThemeColor|undefined = undefined;
     let toolTipItems = [];
 
+    if (options.executing) {
+      text = `$(sync~spin) Executing...`;
+    } else
+    if (options.canceling) {
+      text = `$(sync~spin) Canceling...`;
+    } else
+    if (options.jobIsBusy) {
+      text = `🙁 Job is busy`;
+    } else
     if (options.newJob) {
       text = `$(sync~spin) Spinning up job...`;
     } else