Add a setting for logging REST traffic (#1466)

Author: isc-bsaviano

package-lock.json

@@ -1466,11 +1466,6 @@
           "default": true,
           "markdownDescription": "Show inline `Copy Invocation` CodeLens action for ClassMethods and Routine Labels."
         },
-        "objectscript.studioActionDebugOutput": {
-          "type": "boolean",
-          "default": false,
-          "description": "Output in JSON format the action that VS Code should perform as requested by the server."
-        },
         "objectscript.autoShowTerminal": {
           "description": "Automatically show terminal when connected to docker-compose.",
           "type": "boolean",
@@ -1606,6 +1601,11 @@
           "description": "Controls whether files in client-side workspace folders that are created, deleted, or changed are automatically synced to the server. Synching will occur whether changes are made due to user actions in VS Code (for example, saving a file that's being actively edited) or outside of VS Code (for example, deleting a file from the OS file explorer while VS Code has its folder open).",
           "type": "boolean",
           "default": true
+        },
+        "objectscript.outputRESTTraffic": {
+          "description": "If true, REST requests and responses to and from InterSystems servers will be logged to the ObjectScript Output channel. This should only be enabled when debugging a potential issue.",
+          "type": "boolean",
+          "default": false
         }
       }
     },
@@ -1793,7 +1793,7 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^5.2.1",
     "eslint-plugin-promise": "^7.1.0",
-    "glob": "^7.1.6",
+    "glob": "^11.0.1",
     "globals": "^15.12.0",
     "mocha": "^9.1.3",
     "path-browserify": "^1.0.1",

package.json

@@ -334,8 +334,27 @@ export class AtelierAPI {
       auth = authRequest;
     }
 
+    const outputTraffic = vscode.workspace.getConfiguration("objectscript").get<boolean>("outputRESTTraffic");
+    let cookie;
+    let reqTs: Date;
+    const outputRequest = () => {
+      outputChannel.appendLine(`+- REQUEST - ${reqTs.toLocaleTimeString()} ----------------------------`);
+      outputChannel.appendLine(`${method} ${proto}://${host}:${port}${path}`);
+      if (cookie) outputChannel.appendLine("COOKIE: <value>");
+      for (const [h, v] of Object.entries(headers)) {
+        // Don't output value of the Authorization header
+        const hUpper = h.toUpperCase();
+        outputChannel.appendLine(`${hUpper}: ${hUpper == "AUTHORIZATION" ? "<value>" : v}`);
+      }
+      if (body) {
+        outputChannel.appendLine(
+          `Body:\n${headers["Content-Type"] == "application/json" ? JSON.stringify(body, null, 2) : body}`
+        );
+      }
+    };
     try {
-      const cookie = await auth;
+      cookie = await auth;
+      reqTs = new Date();
       const response = await axios.request({
         method,
         url: `${proto}://${host}:${port}${path}`,
@@ -350,6 +369,22 @@ export class AtelierAPI {
         signal: options?.timeout ? AbortSignal.timeout(options.timeout) : undefined,
         validateStatus: (status) => status < 504,
       });
+      if (outputTraffic) {
+        outputRequest();
+        outputChannel.appendLine(`+- RESPONSE - ${new Date().toLocaleTimeString()} ---------------------------`);
+        outputChannel.appendLine(`${response.status} ${response.statusText}`);
+        for (const [h, v] of Object.entries(response.headers)) {
+          // Don't output value of the Set-Cookie header
+          const hUpper = h.toUpperCase();
+          outputChannel.appendLine(`${hUpper}: ${hUpper == "SET-COOKIE" ? "<value>" : v}`);
+        }
+        if (response.data) {
+          outputChannel.appendLine(
+            `Body:\n${typeof response.data == "object" ? JSON.stringify(response.data, null, 2) : response.data}`
+          );
+        }
+        outputChannel.appendLine(`+- END ----------------------------------------------`);
+      }
       if (response.status === 503) {
         // User likely ran out of licenses
         throw {
@@ -394,7 +429,7 @@ export class AtelierAPI {
         throw {
           statusCode: response.status,
           message: response.statusText,
-          errorText: `Non-JSON response to ${path} request. Is the web server suppressing detailed errors?`,
+          errorText: `Body of '${response.status} ${response.statusText}' response to ${path} request is not JSON. Is the web server suppressing detailed errors?`,
         };
       }
       const data: Atelier.Response = response.data;
@@ -446,6 +481,13 @@ export class AtelierAPI {
 
       return data;
     } catch (error) {
+      if (outputTraffic && !error.statusCode) {
+        // Only output errors here if they were "hard" errors, not HTTP response errors
+        outputRequest();
+        outputChannel.appendLine(`+- ERROR --------------------------------------------`);
+        outputChannel.appendLine(`${JSON.stringify(error, null, 2)}`);
+        outputChannel.appendLine(`+- END ----------------------------------------------`);
+      }
       // always discard the cached authentication promise
       authRequestMap.delete(target);
 

src/api/index.ts

@@ -119,9 +119,6 @@ export class StudioActions {
       outputChannel.appendLine(errorText);
       outputChannel.show(true);
     }
-    if (vscode.workspace.getConfiguration("objectscript").get("studioActionDebugOutput")) {
-      outputChannel.appendLine(JSON.stringify(userAction));
-    }
     switch (serverAction) {
       case 0:
         /// do nothing
@@ -292,10 +289,6 @@ export class StudioActions {
       ? [type.toString(), action.id, this.name, answer, msg]
       : [type.toString(), action.id, this.name, selectedText];
 
-    if (vscode.workspace.getConfiguration("objectscript").get("studioActionDebugOutput")) {
-      outputChannel.appendLine(`${query.slice(0, query.indexOf("("))}(${JSON.stringify(parameters).slice(1, -1)})`);
-    }
-
     return vscode.window.withProgress(
       {
         cancellable: false,

src/commands/studio.ts

@@ -1,6 +1,6 @@
 import * as path from "path";
 import * as Mocha from "mocha";
-import * as glob from "glob";
+import { glob } from "glob";
 
 export function run(): Promise<void> {
   // Create the mocha test
@@ -11,26 +11,14 @@ export function run(): Promise<void> {
 
   const testsRoot = path.resolve(__dirname, "..");
 
-  return new Promise((c, e) => {
-    glob("**/**.test.js", { cwd: testsRoot }, (err, files) => {
-      if (err) {
-        return e(err);
-      }
-
-      // Add files to the test suite
-      files.forEach((f) => mocha.addFile(path.resolve(testsRoot, f)));
+  return glob("**/**.test.js", { cwd: testsRoot }).then((files) => {
+    // Add files to the test suite
+    files.forEach((f) => mocha.addFile(path.resolve(testsRoot, f)));
 
-      try {
-        // Run the mocha test
-        mocha.run((failures) => {
-          if (failures > 0) {
-            e(new Error(`${failures} tests failed.`));
-          } else {
-            c();
-          }
-        });
-      } catch (err) {
-        e(err);
+    // Run the mocha test
+    mocha.run((failures) => {
+      if (failures > 0) {
+        throw new Error(`${failures} tests failed.`);
       }
     });
   });