Merge pull request #329 from gjsjohnmurray/fix-328

fix #328 resolve the server spec fully, including credentials

Author: gjsjohnmurray

src/commands/addServerNamespaceToWorkspace.ts

@@ -1,6 +1,6 @@
 import * as vscode from "vscode";
 import { AtelierAPI } from "../api";
-import { panel } from "../extension";
+import { panel, resolveConnectionSpec } from "../extension";
 
 export async function addServerNamespaceToWorkspace(): Promise<void> {
   const serverManagerApi = await getServerManagerApi();
@@ -18,18 +18,30 @@ export async function addServerNamespaceToWorkspace(): Promise<void> {
   }
   // Get its namespace list
   let uri = vscode.Uri.parse(`isfs://${serverName}/?ns=%SYS`);
+  await resolveConnectionSpec(serverName);
+  // Prepare a displayable form of its connection spec as a hint to the user
+  const connSpec = await serverManagerApi.getServerSpec(serverName);
+  const connDisplayString = `${connSpec.webServer.scheme}://${connSpec.webServer.host}:${connSpec.webServer.port}/${connSpec.webServer.pathPrefix}`;
+  // Connect and fetch namespaces
   const api = new AtelierAPI(uri);
-  const allNamespaces: string[] = await api
+  const allNamespaces: string[] | undefined = await api
     .serverInfo()
     .then((data) => data.result.content.namespaces)
-    .catch(() => []);
-  // Clear the panel entry this created
+    .catch((reason) => {
+      // Notify user about serverInfo failure
+      vscode.window.showErrorMessage(
+        reason.message || `Failed to fetch namespace list from  server at ${connDisplayString}`
+      );
+      return undefined;
+    });
+  // Clear the panel entry created by the connection
   panel.text = "";
   panel.tooltip = "";
-  // Prepare a displayable form of its connection spec as a hint to the user
-  const connSpec = await serverManagerApi.getServerSpec(serverName);
-  const connDisplayString = `${connSpec.webServer.scheme}://${connSpec.webServer.host}:${connSpec.webServer.port}/${connSpec.webServer.pathPrefix}`;
-  // Handle serveInfo having failed or returned no namespaces
+  // Handle serverInfo failure
+  if (!allNamespaces) {
+    return;
+  }
+  // Handle serverInfo having returned no namespaces
   if (!allNamespaces.length) {
     vscode.window.showErrorMessage(`No namespace list returned by server at ${connDisplayString}`);
     return;

src/extension.ts

@@ -163,7 +163,23 @@ let serverManagerApi: any;
 // Map of the intersystems.server connection specs we have resolved via the API to that extension
 const resolvedConnSpecs = new Map<string, any>();
 
-// Accessor for the connection specs
+/**
+ * If servermanager extension is available, fetch the connection spec unless already cached.
+ * Prompt for credentials if necessary.
+ * @param serverName authority element of an isfs uri, or `objectscript.conn.server` property
+ */
+export async function resolveConnectionSpec(serverName: string): Promise<void> {
+  if (serverManagerApi && serverManagerApi.getServerSpec) {
+    if (serverName && serverName !== "" && !resolvedConnSpecs.has(serverName)) {
+      const connSpec = await serverManagerApi.getServerSpec(serverName);
+      if (connSpec) {
+        resolvedConnSpecs.set(serverName, connSpec);
+      }
+    }
+  }
+}
+
+// Accessor for the cache of resolved connection specs
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 export function getResolvedConnectionSpec(key: string, dflt: any): any {
   return resolvedConnSpecs.has(key) ? resolvedConnSpecs.get(key) : dflt;
@@ -418,15 +434,8 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
     toCheck.set(configName, uri);
   });
   toCheck.forEach(async function (uri, configName) {
-    if (serverManagerApi && serverManagerApi.getServerSpec) {
-      const serverName = uri.scheme === "file" ? config("conn", configName).server : configName;
-      if (serverName && serverName !== "" && !resolvedConnSpecs.has(serverName)) {
-        const connSpec = await serverManagerApi.getServerSpec(serverName);
-        if (connSpec) {
-          resolvedConnSpecs.set(serverName, connSpec);
-        }
-      }
-    }
+    const serverName = uri.scheme === "file" ? config("conn", configName).server : configName;
+    await resolveConnectionSpec(serverName);
     checkConnection(true, uri);
   });