Improve putDoc() and viewOthers() error handling

Author: isc-bsaviano

src/api/index.ts

@@ -13,7 +13,7 @@ import {
   checkConnection,
   schemas,
 } from "../extension";
-import { currentWorkspaceFolder, outputConsole, outputChannel } from "../utils";
+import { currentWorkspaceFolder, outputConsole } from "../utils";
 
 const DEFAULT_API_VERSION = 1;
 import * as Atelier from "./atelier";
@@ -337,18 +337,16 @@ export class AtelierAPI {
         return this.cookies;
       }
 
-      if (!response.ok) {
-        throw { statusCode: response.status, message: response.statusText };
-      }
-
       const buffer = await response.buffer();
       const data: Atelier.Response = JSON.parse(buffer.toString("utf-8"));
 
-      /// decode encoded content
+      // Decode encoded content
       if (data.result && data.result.enc && data.result.content) {
         data.result.enc = false;
         data.result.content = Buffer.from(data.result.content.join(""), "base64");
       }
+
+      // Handle console output
       if (data.console) {
         // Let studio actions handle their console output
         const isStudioAction =
@@ -360,18 +358,21 @@ export class AtelierAPI {
           outputConsole(data.console);
         }
       }
+
+      // Handle any errors
+      if (data.status.summary !== "") {
+        // This is a 500 server error or a query request with malformed SQL
+        throw { statusCode: response.status, message: response.statusText, errorText: data.status.summary };
+      }
       if (data.result.status && data.result.status !== "") {
-        const status: string = data.result.status;
-        outputChannel.appendLine(status);
-        throw new Error(data.result.status);
+        // This is a 4XX error on a doc request
+        throw { statusCode: response.status, message: response.statusText, errorText: data.result.status };
       }
-      if (data.status.summary) {
-        throw new Error(data.status.summary);
-      } else if (data.result.status) {
-        throw new Error(data.result.status);
-      } else {
-        return data;
+      if (response.status >= 400) {
+        // The request errored out, but didn't give us an error string back
+        throw { statusCode: response.status, message: response.statusText, errorText: "" };
       }
+      return data;
     } catch (error) {
       if (error.code === "ECONNREFUSED") {
         authRequestMap.delete(target);

src/commands/compile.ts

@@ -94,11 +94,6 @@ async function importFile(file: CurrentFile, ignoreConflict?: boolean): Promise<
       checkChangedOnServer(file, true);
     })
     .catch((error) => {
-      if (error.statusCode == 400) {
-        outputChannel.appendLine(error.error.result.status);
-        vscode.window.showErrorMessage(error.error.result.status);
-        return Promise.reject();
-      }
       if (error.statusCode == 409) {
         return vscode.window
           .showErrorMessage(
@@ -140,9 +135,18 @@ What do you want to do?`,
             }
             return Promise.reject();
           });
+      } else {
+        if (error.errorText && error.errorText !== "") {
+          outputChannel.appendLine("\n" + error.errorText);
+          vscode.window.showErrorMessage(
+            `Failed to save file '${file.name}' on the server. Check output channel for details.`,
+            "Dismiss"
+          );
+        } else {
+          vscode.window.showErrorMessage(`Failed to save file '${file.name}' on the server.`, "Dismiss");
+        }
+        return Promise.reject();
       }
-      vscode.window.showErrorMessage(error.message);
-      return Promise.reject();
     });
 }
 

src/commands/viewOthers.ts

@@ -2,7 +2,7 @@ import * as vscode from "vscode";
 import { AtelierAPI } from "../api";
 import { config } from "../extension";
 import { DocumentContentProvider } from "../providers/DocumentContentProvider";
-import { currentFile } from "../utils";
+import { currentFile, outputChannel } from "../utils";
 
 export async function viewOthers(): Promise<void> {
   const file = currentFile();
@@ -145,6 +145,7 @@ export async function viewOthers(): Promise<void> {
     .then((info) => {
       const listOthers = getOthers(info) || [];
       if (!listOthers.length) {
+        vscode.window.showInformationMessage("There are no other documents to open.", "Dismiss");
         return;
       }
       if (listOthers.length === 1) {
@@ -155,5 +156,12 @@ export async function viewOthers(): Promise<void> {
         });
       }
     })
-    .catch((err) => console.error(err));
+    .catch((err) => {
+      if (err.errorText && err.errorText !== "") {
+        outputChannel.appendLine("\n" + err.errorText);
+        vscode.window.showErrorMessage(`Failed to get other documents. Check output channel for details.`, "Dismiss");
+      } else {
+        vscode.window.showErrorMessage(`Failed to get other documents.`, "Dismiss");
+      }
+    });
 }

src/providers/FileSystemProvider/FileSystemProvider.ts

@@ -225,8 +225,8 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
           )
           .catch((error) => {
             // Throw all failures
-            if (error.error?.result?.status) {
-              throw vscode.FileSystemError.Unavailable(error.error.result.status);
+            if (error.errorText && error.errorText !== "") {
+              throw vscode.FileSystemError.Unavailable(error.errorText);
             }
             throw vscode.FileSystemError.Unavailable(error.message);
           })