Fix incompatibilities with pre-OAuth2 version of Server Manager (#1820)

Author: isc-klu

package-lock.json

@@ -1718,7 +1718,7 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.39.2",
-    "@intersystems-community/intersystems-servermanager": "^3.14.0",
+    "@intersystems-community/intersystems-servermanager": "^3.14.1",
     "@types/istextorbinary": "2.3.1",
     "@types/minimatch": "6.0.0",
     "@types/mocha": "^10.0.10",

package.json

@@ -2,7 +2,7 @@ import axios from "axios";
 import * as httpsModule from "https";
 import * as vscode from "vscode";
 import * as semver from "semver";
-import {
+import BasicAuthorization, {
   getResolvedConnectionSpec,
   config,
   extensionContext,
@@ -57,7 +57,7 @@ export interface ConnectionSettings {
   port: number;
   superserverPort?: number;
   pathPrefix?: string;
-  ns: string;
+  ns: string | undefined;
   auth: Authorization;
   docker?: boolean;
   dockerService?: string;
@@ -171,7 +171,7 @@ export class AtelierAPI {
       webServer: { scheme, host, port, pathPrefix = "" },
       auth,
     } = connSpec;
-    this._config.auth = auth;
+    this._config.auth = auth ?? new BasicAuthorization();
     this._config.https = scheme == "https";
     this._config.host = host;
     this._config.port = port;
@@ -200,7 +200,7 @@ export class AtelierAPI {
 
   public terminalUrl(): string {
     const { host, https, port, apiVersion, pathPrefix } = this.config;
-    return apiVersion >= 7
+    return apiVersion! >= 7
       ? `${https ? "wss" : "ws"}://${host}:${port}${pathPrefix}/api/atelier/v${apiVersion}/%25SYS/terminal`
       : "";
   }
@@ -232,7 +232,11 @@ export class AtelierAPI {
 
   private setConnection(workspaceFolderName: string, namespace?: string): void {
     this.configName = workspaceFolderName;
-    const conn = config("conn", workspaceFolderName);
+    const rawConn = config("conn", workspaceFolderName);
+    const conn = {
+      ...rawConn,
+      auth: new BasicAuthorization(rawConn.username, rawConn.password),
+    };
     let serverName = workspaceFolderName.toLowerCase();
     if (config("intersystems.servers", workspaceFolderName).has(serverName)) {
       this.externalServer = true;
@@ -254,7 +258,7 @@ export class AtelierAPI {
         webServer: { scheme, host, port, pathPrefix = "" },
         auth,
         superServer,
-      } = getResolvedConnectionSpec(serverName, config("intersystems.servers", workspaceFolderName).get(serverName));
+      } = getResolvedConnectionSpec(serverName, config("intersystems.servers", workspaceFolderName).get(serverName))!;
       this._config = {
         serverName,
         active: this.externalServer ? !inactiveServerIds.has(serverName) : conn.active,
@@ -333,7 +337,7 @@ export class AtelierAPI {
     if (!active || !port || !host) {
       return Promise.reject();
     }
-    if (minVersion > apiVersion) {
+    if (minVersion > apiVersion!) {
       return Promise.reject(`${path} not supported by API version ${apiVersion}`);
     }
     const originalPath = path;
@@ -348,7 +352,7 @@ export class AtelierAPI {
       if (!params) {
         return "";
       }
-      const result = [];
+      const result: string[] = [];
       Object.keys(params).forEach((key) => {
         const value = params[key];
         if (typeof value === "boolean") {
@@ -379,7 +383,7 @@ export class AtelierAPI {
 
     const cookies = this.cookies;
     const mapKey = this.mapKey();
-    let auth: Promise<any>;
+    let auth: Promise<any> | undefined;
     let authRequest = authRequestMap.get(mapKey);
     if (cookies.length || (method === "HEAD" && !originalPath)) {
       // Only send basic authorization if username and password specified (including blank, for unauthenticated access)
@@ -417,7 +421,7 @@ export class AtelierAPI {
       }
     };
     try {
-      cookie = await auth;
+      cookie = await auth!;
       reqTs = new Date();
       const response = await axios.request({
         method,
@@ -598,7 +602,7 @@ export class AtelierAPI {
             .slice(data.version.indexOf(") ") + 2)
             .split(" ")
             .shift()
-        ).version;
+        )!.version;
         if (this.ns && this.ns.length && !data.namespaces.includes(this.ns) && checkNs) {
           throw {
             code: "WrongNamespace",
@@ -649,7 +653,7 @@ export class AtelierAPI {
     const params: Record<string, string> = {};
     name = this.transformNameIfCsp(name);
     if (
-      this.config.apiVersion >= 4 &&
+      this.config.apiVersion! >= 4 &&
       vscode.workspace
         .getConfiguration(
           "objectscript",

src/api/index.ts

@@ -17,7 +17,9 @@ import { isfsConfig, IsfsUriParam } from "../utils/FileProviderUtil";
  * @param message The prefix of the message to show when the server manager API can't be found.
  * @returns An object containing `serverName` and `namespace`, or `undefined`.
  */
-async function pickServerAndNamespace(message?: string): Promise<{ serverName: string; namespace: string }> {
+async function pickServerAndNamespace(
+  message?: string
+): Promise<{ serverName: string; namespace: string } | undefined> {
   if (!serverManagerApi) {
     vscode.window.showErrorMessage(
       `${
@@ -29,7 +31,7 @@ async function pickServerAndNamespace(message?: string): Promise<{ serverName: s
   }
   // Get user's choice of server
   const options: vscode.QuickPickOptions = { ignoreFocusOut: true };
-  const serverName: string = await serverManagerApi.pickServer(undefined, options);
+  const serverName: string | undefined = await serverManagerApi.pickServer(undefined, options);
   if (!serverName) {
     return;
   }
@@ -40,13 +42,13 @@ async function pickServerAndNamespace(message?: string): Promise<{ serverName: s
   return { serverName, namespace };
 }
 
-async function pickNamespaceOnServer(serverName: string): Promise<string> {
+async function pickNamespaceOnServer(serverName: string): Promise<string | undefined> {
   // Get its namespace list
   const uri = vscode.Uri.parse(`isfs://${serverName}:%sys/`);
   await resolveConnectionSpec(serverName);
   // Prepare a displayable form of its connection spec as a hint to the user.
   // This will never return the default value (second parameter) because we only just resolved the connection spec.
-  const connSpec = getResolvedConnectionSpec(serverName, undefined);
+  const connSpec = getResolvedConnectionSpec(serverName, undefined)!;
   const connDisplayString = `${connSpec.webServer.scheme}://${connSpec.webServer.host}:${connSpec.webServer.port}/${connSpec.webServer.pathPrefix}`;
   // Connect and fetch namespaces
   const api = new AtelierAPI(uri);
@@ -81,9 +83,9 @@ async function pickNamespaceOnServer(serverName: string): Promise<string> {
 export async function addServerNamespaceToWorkspace(resource?: vscode.Uri): Promise<void> {
   const TITLE = "Add server namespace to workspace";
   let serverName = "";
-  let namespace = "";
-  if (filesystemSchemas.includes(resource?.scheme)) {
-    serverName = resource.authority.split(":")[0];
+  let namespace: string | undefined = "";
+  if (filesystemSchemas.includes(resource?.scheme as string)) {
+    serverName = resource!.authority.split(":")[0];
     if (serverName) {
       const ANOTHER = "Choose another server";
       const choice = await vscode.window.showQuickPick([`Add a '${serverName}' namespace`, ANOTHER], {
@@ -111,7 +113,7 @@ export async function addServerNamespaceToWorkspace(resource?: vscode.Uri): Prom
     }
   }
   const wsFolders = vscode.workspace.workspaceFolders ?? [];
-  let scheme: string;
+  let scheme: string | undefined;
   if (wsFolders.length && wsFolders.some((wf) => notIsfs(wf.uri))) {
     // Don't allow the creation of an editable ISFS folder
     // if the workspace contains non-ISFS folders already
@@ -221,7 +223,7 @@ async function modifyWsFolderUri(uri: vscode.Uri): Promise<vscode.Uri | undefine
   }
 
   let newParams = "";
-  let newPath = uri.path;
+  let newPath: string | undefined = uri.path;
   if (filterType == "csp") {
     // Prompt for a specific web app
     let cspApps = cspAppsForUri(uri);
@@ -243,7 +245,7 @@ async function modifyWsFolderUri(uri: vscode.Uri): Promise<vscode.Uri | undefine
       }
     }
     newPath = await new Promise<string | undefined>((resolve) => {
-      let result: string;
+      let result: string | undefined;
       const allItem: vscode.QuickPickItem = { label: "All" };
       const quickPick = vscode.window.createQuickPick();
       quickPick.title = "Pick a specific web application to show, or show all";
@@ -352,7 +354,7 @@ async function modifyWsFolderUri(uri: vscode.Uri): Promise<vscode.Uri | undefine
 }
 
 export async function modifyWsFolder(wsFolderUri?: vscode.Uri): Promise<void> {
-  let wsFolder: vscode.WorkspaceFolder;
+  let wsFolder: vscode.WorkspaceFolder | null | undefined;
   if (!wsFolderUri) {
     // Select a workspace folder to modify
     wsFolder = await getWsFolder("Pick the workspace folder to modify", false, true);

src/commands/addServerNamespaceToWorkspace.ts

@@ -89,7 +89,7 @@ export async function importFile(
   if (!file) return;
   const api = new AtelierAPI(file.uri);
   if (!api.active) return Promise.reject();
-  if (file.name.split(".").pop().toLowerCase() === "cls" && !skipDeplCheck) {
+  if (file.name.split(".").pop()!.toLowerCase() === "cls" && !skipDeplCheck) {
     if (await isClassDeployed(file.name, api)) {
       vscode.window.showErrorMessage(`Cannot import ${file.name} because it is deployed on the server.`, "Dismiss");
       return Promise.reject();
@@ -207,10 +207,10 @@ function updateOthers(others: string[], baseUri: vscode.Uri) {
   }
   others.forEach((item) => {
     const uri = DocumentContentProvider.getUri(item, undefined, undefined, undefined, workspaceFolder?.uri);
-    if (filesystemSchemas.includes(uri.scheme)) {
-      fileSystemProvider.fireFileChanged(uri);
-    } else if (uri.scheme == OBJECTSCRIPT_FILE_SCHEMA) {
-      documentContentProvider.update(uri);
+    if (filesystemSchemas.includes(uri!.scheme)) {
+      fileSystemProvider.fireFileChanged(uri!);
+    } else if (uri!.scheme == OBJECTSCRIPT_FILE_SCHEMA) {
+      documentContentProvider.update(uri!);
     }
   });
 }
@@ -234,7 +234,7 @@ export async function loadChanges(
     Promise.allSettled(
       data.result.content.map(async (doc) => {
         if (doc.status.length) return;
-        const file = files.find((f) => f.name == doc.name);
+        const file = files.find((f) => f.name == doc.name)!;
         const mtime = Number(new Date(doc.ts + "Z"));
         workspaceState.update(`${file.uniqueId}:mtime`, mtime > 0 ? mtime : undefined);
         if (notIsfs(file.uri)) {
@@ -312,8 +312,8 @@ function updateStorage(content: string[], storage: string[]): string[] {
 
 function storageToMap(storage: string[]): Map<string, string> {
   const map: Map<string, string> = new Map();
-  let k: string;
-  let v = [];
+  let k: string | undefined;
+  let v: string[] = [];
   for (const line of storage) {
     if (line.startsWith("Storage ")) {
       k = line.slice("Storage ".length, line.length);
@@ -412,7 +412,7 @@ export async function importAndCompile(document?: vscode.TextDocument, askFlags
   }
 }
 
-export async function compileOnly(document?: vscode.TextDocument, askFlags = false): Promise<any> {
+export async function compileOnly(document?: vscode.TextDocument | null, askFlags = false): Promise<any> {
   document =
     document ||
     (vscode.window.activeTextEditor && vscode.window.activeTextEditor.document
@@ -468,7 +468,7 @@ export async function namespaceCompile(): Promise<any> {
         .then(() => {
           // Always fetch server changes, even when compile failed or got cancelled
           const file = currentFile();
-          return loadChanges([file]);
+          return loadChanges([file!]);
         })
   );
 }
@@ -526,7 +526,7 @@ export async function compileExplorerItems(nodes: NodeBase[]): Promise<any> {
   const conf = vscode.workspace.getConfiguration("objectscript", wsFolder);
   const api = new AtelierAPI(wsFolder.uri);
   if (namespace) api.setNamespace(namespace);
-  const docs = [];
+  const docs: string[] = [];
   for (const node of nodes) {
     if (node instanceof PackageNode) {
       switch (node.category) {
@@ -659,7 +659,7 @@ export async function importArbitraryFiles(): Promise<any> {
     });
     if (!uris?.length) return;
     // Filter out non-importable files
-    uris = uris.filter((uri) => supportedExts.includes(uri.path.split(".").pop().toLowerCase()));
+    uris = uris.filter((uri) => supportedExts.includes(uri.path.split(".").pop()!.toLowerCase()));
     if (uris.length == 0) {
       vscode.window.showErrorMessage("No selected files are importable.", "Dismiss");
       return;
@@ -689,6 +689,7 @@ export async function importArbitraryFiles(): Promise<any> {
           }
         })
         .filter(notNull)
+        .map((f) => f!)
     );
     if (filesToList.length == 0) {
       vscode.window.showErrorMessage("Failed to read the text of every selected file.", "Dismiss");
@@ -754,9 +755,9 @@ export async function importArbitraryFiles(): Promise<any> {
           }
         });
         if (readOnly.length) {
-          docsToImport = docsToImport.filter((qpi) => {
+          docsToImport = docsToImport!.filter((qpi) => {
             const nameSplit = qpi.label.split(".");
-            return !readOnly.includes(`${nameSplit.slice(0, -1).join(".")}.${nameSplit.pop().toUpperCase()}`);
+            return !readOnly.includes(`${nameSplit.slice(0, -1).join(".")}.${nameSplit.pop()!.toUpperCase()}`);
           });
         }
       });