Initial work to enable and see tracing data for specific jobs (#54)

worksofliam · web-flow · commit bfcbb8722bcf · 2023-07-20T14:54:58.000-05:00
* Initial work to enable and see tracing data for specific jobs

* Support for opening a file trace
diff --git a/package.json b/package.json
@@ -295,6 +295,16 @@
         "category": "Db2 for i",
         "icon": "$(info)"
       },
+      {
+        "command": "vscode-db2i.jobManager.enableTracing",
+        "title": "Enable Tracing",
+        "category": "Db2 for i"
+      },
+      {
+        "command": "vscode-db2i.jobManager.getTrace",
+        "title": "Get Trace Data",
+        "category": "Db2 for i"
+      },
       {
         "command": "vscode-db2i.jobManager.newConfig",
         "title": "Save settings to config",
@@ -336,6 +346,14 @@
           "command": "vscode-db2i.jobManager.viewJobLog",
           "when": "never"
         },
+        {
+          "command": "vscode-db2i.jobManager.enableTracing",
+          "when": "never"
+        },
+        {
+          "command": "vscode-db2i.jobManager.getTrace",
+          "when": "never"
+        },
         {
           "command": "vscode-db2i.jobManager.newConfig",
           "when": "never"
@@ -496,6 +514,16 @@
           "when": "view == jobManager && viewItem == sqlJob",
           "group": "inline"
         },
+        {
+          "command": "vscode-db2i.jobManager.enableTracing",
+          "when": "view == jobManager && viewItem == sqlJob",
+          "group": "trace@1"
+        },
+        {
+          "command": "vscode-db2i.jobManager.getTrace",
+          "when": "view == jobManager && viewItem == sqlJob",
+          "group": "trace@2"
+        },
         {
           "command": "vscode-db2i.jobManager.newConfig",
           "when": "view == jobManager && viewItem == sqlJob",
diff --git a/src/connection/serverComponent.ts b/src/connection/serverComponent.ts
@@ -35,7 +35,11 @@ export class ServerComponent {
     return this.outputChannel;
   }
 
-  static writeOutput(jsonString: string) {
+  static writeOutput(jsonString: string, show = false) {
+    if (show) {
+      this.outputChannel.show();
+    }
+    
     if (this.outputChannel) {
       this.outputChannel.appendLine(jsonString);
     }
diff --git a/src/connection/sqlJob.ts b/src/connection/sqlJob.ts
@@ -34,6 +34,8 @@ export class SQLJob {
   private channel: any;
   private responseEmitter: EventEmitter = new EventEmitter();
   private status: JobStatus = JobStatus.NotStarted;
+
+  private traceFile: string|undefined;
   private isTracingChannelData: boolean = false;
 
   id: string | undefined;
@@ -153,6 +155,11 @@ export class SQLJob {
 
     return version;
   }
+
+  getTraceFilePath(): string|undefined {
+    return this.traceFile;
+  }
+
   async getTraceData(): Promise<GetTraceDataResult> {
     const tracedataReqObj = {
       id: SQLJob.getNewUniqueRequestId(),
@@ -166,16 +173,19 @@ export class SQLJob {
     if (rpy.success !== true) {
       throw new Error(rpy.error || `Failed to get trace data from backend`);
     }
+
     return rpy;
   }
-  //TODO: add/modify this API to allow manipulation of JTOpen tracing, and add tests
+
   async setTraceConfig(dest: ServerTraceDest, level: ServerTraceLevel): Promise<SetConfigResult> {
     const reqObj = {
       id: SQLJob.getNewUniqueRequestId(),
       type: `setconfig`,
       tracedest: dest,
       tracelevel: level
     };
+    
+    this.isTracingChannelData = true;
 
     const result = await this.send(JSON.stringify(reqObj));
 
@@ -184,6 +194,9 @@ export class SQLJob {
     if (rpy.success !== true) {
       throw new Error(rpy.error || `Failed to set trace options on backend`);
     }
+
+    this.traceFile = (rpy.tracedest && rpy.tracedest[0] === `/` ? rpy.tracedest : undefined);
+
     return rpy;
   }
 
diff --git a/src/views/jobManager/jobManagerView.ts b/src/views/jobManager/jobManagerView.ts
@@ -1,9 +1,11 @@
-import vscode, { MarkdownString, ProgressLocation, ThemeIcon, TreeItem, TreeItemCollapsibleState, commands, env, window, workspace } from "vscode";
+import vscode, { MarkdownString, ProgressLocation, ThemeIcon, TreeItem, TreeItemCollapsibleState, Uri, commands, env, window, workspace } from "vscode";
 import { TreeDataProvider } from "vscode";
 import { Config, JobManager } from "../../config";
-import { JobInfo } from "../../connection/manager";
+import { JobInfo, SQLJobManager } from "../../connection/manager";
 import { editJobUi } from "./editJob";
 import { displayJobLog } from "./jobLog";
+import { ServerTraceDest, ServerTraceLevel } from "../../connection/types";
+import { ServerComponent } from "../../connection/serverComponent";
 import { updateStatusBar } from "./statusBar";
 import { TransactionEndType } from "../../connection/sqlJob";
 import { ConfigGroup, ConfigManager } from "./ConfigManager";
@@ -24,9 +26,9 @@ export class JobManagerView implements TreeDataProvider<any> {
       ...ConfigManager.initialiseSaveCommands(),
 
       vscode.commands.registerCommand(`vscode-db2i.jobManager.newJob`, async () => {
-        await window.withProgress({location: ProgressLocation.Window}, async (progress) => {
+        await window.withProgress({ location: ProgressLocation.Window }, async (progress) => {
           try {
-            progress.report({message: `Spinning up SQL job...`});
+            progress.report({ message: `Spinning up SQL job...` });
             await JobManager.newJob();
           } catch (e) {
             window.showErrorMessage(e.message);
@@ -103,15 +105,15 @@ export class JobManagerView implements TreeDataProvider<any> {
         if (selected) {
           editJobUi(selected.job.options, selected.name).then(newOptions => {
             if (newOptions) {
-              window.withProgress({location: ProgressLocation.Window}, async (progress) => {
-                progress.report({message: `Ending current job`});
+              window.withProgress({ location: ProgressLocation.Window }, async (progress) => {
+                progress.report({ message: `Ending current job` });
 
                 await selected.job.close();
 
-                progress.report({message: `Starting new job`});
+                progress.report({ message: `Starting new job` });
 
                 selected.job.options = newOptions;
-                
+
                 try {
                   await selected.job.connect();
                 } catch (e) {
@@ -125,6 +127,50 @@ export class JobManagerView implements TreeDataProvider<any> {
         }
       }),
 
+      vscode.commands.registerCommand(`vscode-db2i.jobManager.enableTracing`, async (node?: SQLJobItem) => {
+        if (node) {
+          const id = node.label as string;
+          const selected = await JobManager.getJob(id);
+
+          ServerComponent.writeOutput(`Enabling tracing for ${selected.name} (${selected.job.id})`, true);
+
+          selected.job.setTraceConfig(ServerTraceDest.IN_MEM, ServerTraceLevel.DATASTREAM);
+        }
+      }),
+
+      vscode.commands.registerCommand(`vscode-db2i.jobManager.getTrace`, async (node?: SQLJobItem) => {
+        if (node) {
+          const id = node.label as string;
+          const selected = await JobManager.getJob(id);
+
+          const possibleFile = selected.job.getTraceFilePath();
+
+          if (possibleFile) {
+            // Trace was written to a file
+            vscode.workspace.openTextDocument(Uri.from({
+              scheme: `streamfile`,
+              path: possibleFile
+            })).then(doc => {
+              vscode.window.showTextDocument(doc);
+            });
+            
+          } else {
+            // This likely means IN_MEM was used
+            const trace = await selected.job.getTraceData();
+            if (trace.success) {
+              vscode.workspace.openTextDocument({
+                content: trace.tracedata.trim()
+              }).then(doc => {
+                vscode.window.showTextDocument(doc);
+              })
+
+            } else {
+              ServerComponent.writeOutput(`Unable to get trace data for ${selected.name} (${selected.job.id}):`, true);
+              ServerComponent.writeOutput(trace.error);
+            }
+          }
+        }
+      }),
       vscode.commands.registerCommand(`vscode-db2i.jobManager.jobCommit`, async (node?: SQLJobItem) => {
         const id = node ? node.label as string : undefined;
         let selected = id ? JobManager.getJob(id) : JobManager.getSelection();
@@ -193,17 +239,17 @@ export class JobManagerView implements TreeDataProvider<any> {
   async getChildren(element: ConfigGroup): Promise<SQLJobItem[]> {
     if (element) {
       return ConfigManager.getConfigTreeItems();
-      
+
     } else {
-      let nodes = 
+      let nodes =
         JobManager
           .getRunningJobs()
           .map((info, index) => new SQLJobItem(info, index === JobManager.selectedJob));
 
       if (ConfigManager.hasSavedItems()) {
         nodes.push(new ConfigGroup());
       }
-      
+
       return nodes;
     }
   }

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,11 @@ export class ServerComponent {`
`35`	`35`	`return this.outputChannel;`
`36`	`36`	`}`
`37`	`37`
`38`		`- static writeOutput(jsonString: string) {`
	`38`	`+ static writeOutput(jsonString: string, show = false) {`
	`39`	`+ if (show) {`
	`40`	`+ this.outputChannel.show();`
	`41`	`+ }`
	`42`	`+`
`39`	`43`	`if (this.outputChannel) {`
`40`	`44`	`this.outputChannel.appendLine(jsonString);`
`41`	`45`	`}`