copy debug object to JSON

Author: marcellourbani

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## [1.7.6] 2024-04-13
+
+### Added
+
+-export debug object as JSON
+
 ## [1.7.2] 2023-10-31
 
 ### Added

client/src/adt/debugger/abapDebugSession.ts

@@ -19,6 +19,9 @@ export interface AbapDebugSessionCfg extends DebugSession {
 export class AbapDebugSession extends LoggingDebugSession {
     private closed?: () => void
     private static sessions = new Map<string, AbapDebugSession>()
+    public static get activeSessions() {
+        return this.sessions.size
+    }
     private lasttargetId = 0
     static byConnection(connId: string) {
         return AbapDebugSession.sessions.get(connId)

client/src/adt/debugger/variableManager.ts

@@ -1,8 +1,11 @@
-import { debugMetaIsComplex, DebugMetaType, DebugVariable } from "abap-adt-api"
+import { ADTClient, debugMetaIsComplex, DebugMetaType, DebugVariable } from "abap-adt-api"
 import { Handles, Scope } from "vscode-debugadapter"
 import { DebugProtocol } from "vscode-debugprotocol"
 import { DebugListener } from "./debugListener"
 import { idThread, STACK_THREAD_MULTIPLIER } from "./debugService"
+import { AbapFsCommands, command } from "../../commands"
+import { env, window } from "vscode"
+import { AbapDebugSession } from "./abapDebugSession"
 
 interface Variable {
     id: string,
@@ -24,6 +27,7 @@ const isDebugVariable = (v: DebugVariable | { id: string; name: string }): v is
 export class VariableManager {
     private handles = new Map<number, Handles<Variable>>()// will be overwritten at first use
     private currentStackId = 0
+    private static lastCalled: VariableManager | undefined
 
     private variableHandles(threadId: number) {
         const handle = this.handles.get(threadId)
@@ -54,6 +58,7 @@ export class VariableManager {
         const threadId = idThread(frameId)
         const client = this.client(threadId)
         if (!client) return []
+        VariableManager.lastCalled = this
         const currentStack = this.stackTrace(threadId).find(s => s.id === frameId)
         if (currentStack && !isNaN(currentStack.stackPosition) && frameId !== this.currentStackId) {
             await client.debuggerGoToStack(currentStack.stackUri || currentStack.stackPosition)
@@ -80,12 +85,77 @@ export class VariableManager {
         }
         return client.debuggerChildVariables([parent.id]).then(r => r.variables)
     }
+    async dumpJson(client: ADTClient, name: string | DebugVariable) {
+        const v = typeof name !== "string" ? name : await client.debuggerVariables([name]).then(v => v[0])
+        if (!v) return
+        switch (v.META_TYPE) {
+            case "simple":
+                if (v.TECHNICAL_TYPE.match(/B|S|I|INT8|P|N|DECFLOAT16|DECFLOAT34|F/)) return Number(v.VALUE)
+                return v.VALUE.trimEnd()
+            case "string":
+                return v.VALUE.trimEnd()
+            case "structure":
+                const comps = await client.debuggerChildVariables([v.ID]).then(r => r.variables)
+                const str: any = {}
+                for (const comp of comps) {
+                    const cv = await this.dumpJson(client, comp)
+                    str[comp.NAME] = cv
+                }
+                return str
+            case "table":
+                const outlines: any[] = []
+                const keys = [...Array(v.TABLE_LINES).keys()].map(k => `${v.NAME}[${k + 1}]`)
+                const linevars = await client.debuggerVariables(keys)
+                for (const lv of linevars) {
+                    const line = await this.dumpJson(client, lv)
+                    outlines.push(line)
+                }
+                return outlines
+            case "unknown":
+            case "dataref":
+            case "boxedcomp":
+            case "anonymcomp":
+            case "objectref":
+            case "class":
+            case "object":
+            case "boxref":
+            case "anonymcomp":
+                return `Unprocessable:${v.META_TYPE}`
+        }
+    }
+
+    private static currentClient(variablesReference: number): [VariableManager, ADTClient] | undefined {
+        const vm = VariableManager.lastCalled
+        if (!vm) return
+        const threadId = idThread(variablesReference)
+        const client = vm.client(threadId)
+        if (!client) return
+        return [vm, client]
+    }
+
+    @command(AbapFsCommands.exportToJson)
+    private static async exportJson(arg: { container: { variablesReference: number }, variable: { name: string } }) {
+        const [vm, client] = this.currentClient(arg.container.variablesReference) || []
+        if (!vm || !client) {
+            window.showErrorMessage("No active debug session detected")
+            return
+        }
+        if (AbapDebugSession.activeSessions > 1) window.showWarningMessage("Multiple debug session detected. might export from wrong one")
+        const json = await vm.dumpJson(client, arg.variable.name)
+        env.clipboard.writeText(JSON.stringify(json, null, 1))
+
+    }
     async evaluate(expression: string, frameId?: number): Promise<DebugProtocol.EvaluateResponse["body"] | undefined> {
         try {
             const threadId = frameId && idThread(frameId)
             if (!threadId) return
             const client = this.client(threadId)
             if (!client) return
+            const jse = expression.match(/^json\((.*)\)\s*$/)
+            if (jse?.[1]) {
+                const json = await this.dumpJson(client, jse[1])
+                return { result: JSON.stringify(json, null, 1), variablesReference: 0 }
+            }
             const v = await client.debuggerVariables([expression])
             if (!v[0]) return
             return { result: variableValue(v[0]), variablesReference: this.variableReference(v[0], threadId) }
@@ -107,7 +177,8 @@ export class VariableManager {
                 name: `${v.NAME}`,
                 value: variableValue(v),
                 variablesReference: this.variableReference(v, vari.threadId),
-                memoryReference: `${v.ID}`
+                memoryReference: `${v.ID}`,
+                evaluateName: `${v.ID}`
             }))
             return variables
         }

client/src/commands/registry.ts

@@ -19,6 +19,7 @@ export const AbapFsCommands = {
   showDump: "abapfs.showDump",
   refreshDumps: "abapfs.refreshDumps",
   tableContents: "abapfs.tableContents",
+  exportToJson: "abapfs.exportToJson",
   // atc
   atcChecks: "abapfs.atcChecks",
   atcIgnore: "abapfs.atcIgnore",

package.json

@@ -205,6 +205,10 @@
         "command": "abapfs.search",
         "title": "AbapFs Search for object"
       },
+      {
+        "command": "abapfs.exportToJson",
+        "title": "Export to JSON (clipboard)"
+      },
       {
         "command": "abapfs.create",
         "title": "AbapFs Create object"
@@ -1091,6 +1095,12 @@
           "when": "resourceScheme == adt",
           "group": "4_search@1"
         }
+      ],
+      "debug/variables/context": [
+        {
+          "command": "abapfs.exportToJson",
+          "when": "debugType == abap"
+        }
       ]
     },
     "configuration": {
@@ -1293,4 +1303,4 @@
       }
     }
   }
-}
+}