Add support for debugging REST services (#1043)

Author: isc-bsaviano

docs/RunDebug.md

@@ -114,6 +114,11 @@ This extension uses WebSockets to communicate with the InterSystems server durin
 
 Debugging commands and items on the **Run** menu function much as they do for other languages supported by VS Code. For information on VS Code debugging, see the documentation resources listed at the start of this section. 
 
+{: #rest}
+## Debugging a REST Service
+
+The InterSystems ObjectScript Extension provides a [Webview](https://code.visualstudio.com/api/extension-guides/webview)-based graphical user interface that allows you to send a REST request and automatically start debugging the process on the server that handles it. With the InterSystems file that you want to debug open in the active text editor, you can show the GUI using the `Debug REST Service...` command. The command can be accessed in the command palette, editor context menu or editor tab context menu. Follow the directions in the GUI to build your REST request and click the `Start Debugging` button to send the request and connect the debugger. Be sure you have a breakpoint set somewhere in the code that handles the request.
+
 ## Troubleshooting Debugger Issues
 
 If you are experiencing issues using the debugger, please follow these steps before opening an issue on GitHub:

package.json

@@ -323,6 +323,10 @@
         {
           "command": "vscode-objectscript.importLocalFilesServerSide",
           "when": "false"
+        },
+        {
+          "command": "vscode-objectscript.showRESTDebugWebview",
+          "when": "editorLangId =~ /^objectscript/ && vscode-objectscript.connectActive"
         }
       ],
       "view/title": [
@@ -489,6 +493,11 @@
           "command": "vscode-objectscript.exportCurrentFile",
           "when": "resourceScheme == objectscript && vscode-objectscript.connectActive",
           "group": "objectscript@8"
+        },
+        {
+          "command": "vscode-objectscript.showRESTDebugWebview",
+          "when": "editorLangId =~ /^objectscript/ && vscode-objectscript.connectActive",
+          "group": "objectscript@9"
         }
       ],
       "editor/title": [
@@ -513,6 +522,11 @@
           "command": "vscode-objectscript.showClassDocumentationPreview",
           "group": "1_open",
           "when": "resourceLangId == objectscript-class"
+        },
+        {
+          "command": "vscode-objectscript.showRESTDebugWebview",
+          "group": "1_open",
+          "when": "resourceLangId =~ /^objectscript/ && vscode-objectscript.connectActive"
         }
       ],
       "touchBar": [
@@ -1064,6 +1078,11 @@
         "category": "ObjectScript",
         "command": "vscode-objectscript.importLocalFilesServerSide",
         "title": "Import Local Files..."
+      },
+      {
+        "category": "ObjectScript",
+        "command": "vscode-objectscript.showRESTDebugWebview",
+        "title": "Debug REST Service..."
       }
     ],
     "keybindings": [
@@ -1484,13 +1503,20 @@
                   "number",
                   "string"
                 ],
-                "description": "ID of process to attach to.",
+                "description": "ID of the process to attach to.",
                 "default": "${command:PickProcess}"
               },
               "system": {
                 "type": "boolean",
-                "description": "Enable to attach to system process.",
+                "description": "Enable attaching to system processes.",
                 "default": false
+              },
+              "cspDebugId": {
+                "type": [
+                  "number",
+                  "string"
+                ],
+                "description": "The CSP debug ID to use to identify the target process. If provided, 'processId' is ignored."
               }
             }
           }

src/api/index.ts

@@ -715,4 +715,9 @@ export class AtelierAPI {
   public async getEnsClassList(type: number): Promise<Atelier.Response> {
     return this.request(1, "GET", `${this.ns}/ens/classes/${type}`);
   }
+
+  // v2+
+  public async getCSPDebugId(): Promise<Atelier.Response<Atelier.Content<number>>> {
+    return this.request(2, "GET", "%SYS/cspdebugid");
+  }
 }