Merge pull request #214 from codefori/feature/self_stack

worksofliam · web-flow · commit 2929931d4604 · 2024-03-25T17:15:24.000-04:00
Add SelfIleStackFrame and InitialStackData interfaces for SELF
diff --git a/src/config.ts b/src/config.ts
@@ -31,6 +31,7 @@ export async function onConnectOrServerInstall(): Promise<boolean> {
   const instance = getInstance();
 
   Config.setConnectionName(instance.getConnection().currentConnectionName);
+  determineFeatures();
 
   await ServerComponent.initialise().then(installed => {
     if (installed) {
@@ -75,8 +76,6 @@ export async function onConnectOrServerInstall(): Promise<boolean> {
 export function setupConfig(context: ExtensionContext) {
   Config = new ConnectionStorage(context);
 
-  getInstance().onEvent(`connected`, onConnectOrServerInstall);
-
   getInstance().onEvent(`disconnected`, async () => {
     JobManagerView.setVisible(false);
     JobManager.endAll();
diff --git a/src/extension.ts b/src/extension.ts
@@ -7,7 +7,7 @@ import * as JSONServices from "./language/json";
 import * as resultsProvider from "./views/results";
 
 import { getInstance, loadBase } from "./base";
-import { JobManager, determineFeatures, fetchSystemInfo, setupConfig, turnOffAllFeatures } from "./config";
+import { JobManager, fetchSystemInfo, onConnectOrServerInstall, setupConfig, turnOffAllFeatures } from "./config";
 import { queryHistory } from "./views/queryHistoryView";
 import { ExampleBrowser } from "./views/examples/exampleBrowser";
 import { languageInit } from "./language";
@@ -83,8 +83,8 @@ export function activate(context: vscode.ExtensionContext): Db2i {
   instance.onEvent(`connected`, () => {
     // We need to fetch the system info
     fetchSystemInfo().then(() => {
-      determineFeatures();
       // Refresh the examples when we have it, so we only display certain examples
+      onConnectOrServerInstall();
       exampleBrowser.refresh();
       selfCodesView.setRefreshEnabled(Configuration.get(`autoRefreshSelfCodesView`) || false)
     })
diff --git a/src/views/examples/exampleBrowser.ts b/src/views/examples/exampleBrowser.ts
@@ -4,7 +4,7 @@ import { getInstance } from "../../base";
 import { OSData, fetchSystemInfo } from "../../config";
 import { getServiceInfo } from "../../database/serviceInfo";
 
-const openExampleCommand = `vscode-db2i.examples.open`;
+export const openExampleCommand = `vscode-db2i.examples.open`;
 
 export class ExampleBrowser implements TreeDataProvider<any> {
   private _onDidChangeTreeData: EventEmitter<TreeItem | undefined | null | void> = new EventEmitter<TreeItem | undefined | null | void>();
diff --git a/src/views/jobManager/jobManagerView.ts b/src/views/jobManager/jobManagerView.ts
@@ -175,7 +175,7 @@ export class JobManagerView implements TreeDataProvider<any> {
             quickPick.onDidChangeSelection(async () => {
               const selections = quickPick.selectedItems;
               // SET SYSIBMADM.SELFCODES = SYSIBMADM.VALIDATE_SELF('-514, -204, -501, +30, -199');
-              if (selections && selections[0].label !== currentSelfCodes) {
+              if (selections && selections[0] && selections[0].label !== currentSelfCodes) {
                 const code = selections[0].label as SelfValue;
                 try {
                   await selected.job.setSelfState(code);
diff --git a/src/views/jobManager/selfCodes/nodes.ts b/src/views/jobManager/selfCodes/nodes.ts
@@ -1,3 +1,19 @@
+
+export interface SelfIleStackFrame {
+  ORD: number;
+  TYPE: string;
+  LIB: string;
+  PGM: string;
+  MODULE: string;
+  PROC: string;
+  STMT: string;
+  ACTGRP: string;
+}
+
+export interface InitialStackData {
+  initial_stack: SelfIleStackFrame[];
+}
+
 export interface SelfCodeNode {
   JOB_NAME: string,
   USER_NAME: string;
@@ -9,6 +25,14 @@ export interface SelfCodeNode {
   STMTTEXT: string;
   MESSAGE_TEXT: string;
   MESSAGE_SECOND_LEVEL_TEXT: string;
+
+  PROGRAM_LIBRARY: string;
+  PROGRAM_NAME: string;
+  PROGRAM_TYPE: "*PGM"|"*SRVPGM";
+  MODULE_NAME: string;
+  CLIENT_APPLNAME: string
+  CLIENT_PROGRAMID: string;
+  INITIAL_STACK: InitialStackData;
 }
 
 export type SelfValue = "*ALL" | "*ERROR" | "*WARNING" | "*NONE";
diff --git a/src/views/jobManager/selfCodes/selfCodesResultsView.ts b/src/views/jobManager/selfCodes/selfCodesResultsView.ts
@@ -10,7 +10,9 @@ import {
   Disposable
 } from "vscode";
 import { JobManager } from "../../../config";
-import { SelfCodeNode } from "./nodes";
+import { SelfCodeNode, SelfIleStackFrame } from "./nodes";
+import { openExampleCommand } from "../../examples/exampleBrowser";
+import { SQLExample } from "../../examples";
 
 type ChangeTreeDataEventType = SelfCodeTreeItem | undefined | null | void;
 
@@ -42,14 +44,14 @@ export class selfCodesResultsView implements TreeDataProvider<any> {
         this.setRefreshEnabled(false, true);
       }),
       vscode.commands.registerCommand(`vscode-db2i.self.copySqlStatement`, async (item: SelfCodeTreeItem) => {
-        if (item && item.selfCodeNode.STMTTEXT) {
-          await vscode.env.clipboard.writeText(item.selfCodeNode.STMTTEXT);
+        if (item && item.error.STMTTEXT) {
+          await vscode.env.clipboard.writeText(item.error.STMTTEXT);
           vscode.window.showInformationMessage(`SQL statement copied to clipboard.`);
         }
       }),
       vscode.commands.registerCommand(`vscode-db2i.self.displayDetails`, async (item: SelfCodeTreeItem) => {
-        if (item && item.selfCodeNode) {
-          const jsonData = JSON.stringify(item.selfCodeNode, null, 2);
+        if (item && item.error) {
+          const jsonData = JSON.stringify(item.error, null, 2);
           const document = await vscode.workspace.openTextDocument({
             content: jsonData,
             language: `json`
@@ -81,13 +83,18 @@ export class selfCodesResultsView implements TreeDataProvider<any> {
   async getSelfCodes(): Promise<SelfCodeNode[]> {
     const selected = JobManager.getSelection();
     if (selected) {
-      const content = `SELECT job_name, user_name, reason_code, logged_time, logged_sqlstate, logged_sqlcode, matches, stmttext, 
-                          message_text, message_second_level_text 
-                      FROM qsys2.sql_error_log, lateral 
-                          (select * from TABLE(SYSTOOLS.SQLCODE_INFO(logged_sqlcode)))
+      const content = `SELECT 
+                        job_name, user_name, reason_code, logged_time, logged_sqlstate, logged_sqlcode, matches, stmttext, message_text, message_second_level_text,
+                        program_library, program_name, program_type, module_name, client_applname, client_programid, initial_stack
+                      FROM qsys2.sql_error_log, lateral (select * from TABLE(SYSTOOLS.SQLCODE_INFO(logged_sqlcode)))
                       where user_name = current_user
                       order by logged_time desc`;
-      const data: SelfCodeNode[] = await JobManager.runSQL<SelfCodeNode>(content, undefined);
+
+      const data: SelfCodeNode[] = (await JobManager.runSQL<SelfCodeNode>(content)).map((row) => ({
+        ...row,
+        INITIAL_STACK: JSON.parse(row.INITIAL_STACK as unknown as string)
+      }));
+
       return data;
     }
     return;
@@ -100,28 +107,20 @@ export class selfCodesResultsView implements TreeDataProvider<any> {
   getTreeItem(element: any): TreeItem | Thenable<TreeItem> {
     return element;
   }
-  async getChildren(element?: any): Promise<any[]> {
+
+  async getChildren(element?: SelfCodeTreeItem|SelfErrorStackItem): Promise<any[]> {
     if (element) {
-      return [];
+      if (element instanceof SelfCodeTreeItem) {
+        return element.getChilden();
+      } else if (element instanceof SelfErrorStackItem) {
+        return element.getChildren();
+      }
     } else {
       const selfCodes = await this.getSelfCodes();
 
       if (selfCodes) {
         return selfCodes.map((error) => {
-          const label = `${error.LOGGED_SQLSTATE} (${error.LOGGED_SQLCODE}) ${error.REASON_CODE != null ? error.REASON_CODE : ""}`;
-          const details = `${error.MESSAGE_TEXT}`; // ${error.MATCHES < 100 ? hitsTxt : '💯'.padStart(10, ' ')} 🔥`;
-          const hoverMessage = new vscode.MarkdownString(
-            `**SQL Statement💻:** ${error.STMTTEXT}\n\n---\n\n**SQL Job🛠️:** ${error.JOB_NAME}\n\n---\n\n**Occurrences🔥:** ${error.MATCHES}\n\n---\n\n**Details✏️:** ${error.MESSAGE_SECOND_LEVEL_TEXT}`
-          );
-          hoverMessage.isTrusted = true;
-          const treeItem = new SelfCodeTreeItem(
-            label,
-            details,
-            hoverMessage,
-            vscode.TreeItemCollapsibleState.None,
-            error
-          );
-          treeItem.contextValue = `selfCodeNode`;
+          const treeItem = new SelfCodeTreeItem(error);
           return treeItem;
         });
       }
@@ -148,24 +147,117 @@ export class selfCodesResultsView implements TreeDataProvider<any> {
   }
 }
 export class SelfCodeTreeItem extends TreeItem {
-  selfCodeNode: SelfCodeNode;
-
   constructor(
-    public readonly errorMessage: string,
-    public readonly details: string,
-    public readonly hoverMessage: vscode.MarkdownString,
-    public readonly collapsibleState: vscode.TreeItemCollapsibleState,
-    error: SelfCodeNode
+    public error: SelfCodeNode
   ) {
-    super(errorMessage, collapsibleState);
-    this.selfCodeNode = error;
-    this.tooltip = hoverMessage; // Hover text
-    this.description = details; // Additional details shown in the tree view
+    const label = `${error.LOGGED_SQLSTATE} (${error.LOGGED_SQLCODE}) ${error.REASON_CODE != null ? error.REASON_CODE : ""}`;
+    super(label, vscode.TreeItemCollapsibleState.Collapsed);
+
+    const hover = new vscode.MarkdownString(
+      [
+        `**💻 SQL Statement:** ${error.STMTTEXT}`,
+        ``, ``,
+        `---`,
+        ``, ``,
+        `**🛠️ SQL Job:** ${error.JOB_NAME}`,
+        ``, ``,
+        `---`,
+        ``, ``,
+        `**🔥 Occurrences:** ${error.MATCHES}`,
+        ``, ``,
+        `---`,
+        ``, ``,
+        `**✏️ Details:** ${error.MESSAGE_SECOND_LEVEL_TEXT}`
+      ].join(`\n`)
+    );
+    hover.isTrusted = true;
+
+    this.tooltip = hover;
+
+    this.description = error.MESSAGE_TEXT; // Additional details shown in the tree view
     this.resourceUri = vscode.Uri.from({
       scheme: `selfCodeTreeView`,
       path: error.MATCHES.toString()
     })
+
     this.iconPath = error.LOGGED_SQLCODE < 0 ? new vscode.ThemeIcon(`error`): new vscode.ThemeIcon(`warning`);
+    this.contextValue = `selfCodeNode`;
+  }
+
+  getChilden(): TreeItem[] {
+    const validStack = this.error.INITIAL_STACK.initial_stack
+      .sort((a, b) => a.ORD - b.ORD) // Ord, low to high
+      .filter((stack) => stack.LIB !== `QSYS`);
+
+    const items = [
+      new SelfErrorStatementItem(this.error.STMTTEXT),
+      new SelfErrorNodeItem(`Job`, this.error.JOB_NAME),
+      new SelfErrorNodeItem(`Client Name`, this.error.CLIENT_APPLNAME),
+      new SelfErrorNodeItem(`Client Program`, this.error.CLIENT_PROGRAMID),
+      new SelfErrorNodeItem(`Object`, `${this.error.PROGRAM_LIBRARY}/${this.error.PROGRAM_NAME} (${this.error.PROGRAM_TYPE}, ${this.error.MODULE_NAME})`),
+    ]
+
+    if (validStack.length > 0) {
+      items.push(new SelfErrorStackItem(validStack));
+    }
+
+    return items;
+  }
+}
+
+class SelfErrorStatementItem extends TreeItem {
+  constructor(statement: string) {
+    super(`Statement`, vscode.TreeItemCollapsibleState.None);
+    this.iconPath = new vscode.ThemeIcon(`database`);
+    this.description = statement;
+
+    const hoverable = new vscode.MarkdownString();
+    hoverable.appendCodeblock(statement, `sql`);
+    this.tooltip = hoverable;
+
+    const example: SQLExample = {
+      name: `Statement`,
+      content: [statement]
+    }
+    
+    this.command = {
+      command: openExampleCommand,
+      title: `Open example`,
+      arguments: [example]
+    };
+  }
+}
+
+class SelfErrorNodeItem extends TreeItem {
+  constructor(label: string, description: string) {
+    super(label, vscode.TreeItemCollapsibleState.None);
+    this.iconPath = new vscode.ThemeIcon(`info`);
+    this.description = description;
+  }
+}
+
+class SelfErrorStackItem extends TreeItem {
+  constructor(private stack: SelfIleStackFrame[]) {
+    super(`Stack`, vscode.TreeItemCollapsibleState.Collapsed);
+    this.iconPath = new vscode.ThemeIcon(`debug`);
+    this.contextValue = `selfCodeStack`;
+
+    this.resourceUri = vscode.Uri.from({
+      scheme: `selfCodeTreeView`,
+      path: stack.length.toString()
+    })
+  }
+
+  getChildren(): SelfErrorStackFrameItem[] {
+    return this.stack.map((stackCall) => new SelfErrorStackFrameItem(stackCall));
+  }
+}
+
+class SelfErrorStackFrameItem extends TreeItem {
+  constructor(stackCall: SelfIleStackFrame) {
+    super(`${stackCall.PROC}:${stackCall.STMT}`, vscode.TreeItemCollapsibleState.None);
+    this.description = `${stackCall.LIB}/${stackCall.PGM} (${stackCall.TYPE}, ${stackCall.MODULE})`;
+    this.contextValue = `selfCodeStackCall`;
   }
 }
 
@@ -185,8 +277,7 @@ export class SelfTreeDecorationProvider implements FileDecorationProvider {
       
       if (!isNaN(errorCount) && errorCount > 0) {
         return {
-          badge: errorCount < 100 ? errorCount.toString() : '💯',
-          tooltip: `Occurrences: ${errorCount}`
+          badge: errorCount < 100 ? errorCount.toString() : '💯'
         }
       }
     }
