feat: add sas 9 remote (via IOM bridge) support

CHANGELOG.md

@@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - Added the ability to upload and download sas content using the context menu ([#547](https://github.com/sassoftware/vscode-sas-extension/issues/547))
 - Added the ability to download results as an html file ([#546](https://github.com/sassoftware/vscode-sas-extension/issues/546))
+- Added sas 9.4 remote connection support via ITC and the IOM Bridge protocol ([#592](https://github.com/sassoftware/vscode-sas-extension/pull/592))
 
 ## [v1.5.0] - 2023-10-27
 

README.md

@@ -13,12 +13,14 @@ Welcome to the SAS Extension for Visual Studio Code! This extension provides sup
     - [Code Folding and Code Outline](#code-folding-and-code-outline)
     - [Configuring the SAS Extension](#configuring-the-sas-extension)
     - [Profiles](/connect-and-run.md/#profiles)
-      - [Profile Anatomy (Viya)](/connect-and-run.md/#profile-anatomy-sas-viya)
+      - [Profile Details (Viya)](/connect-and-run.md/#profile-sas-viya)
       - [Add New SAS Viya Profile](/connect-and-run.md#add-new-sas-viya-profile)
-      - [Profile Anatomy (SAS 9.4 Remote)](/connect-and-run.md/#profile-anatomy-sas-94-remote)
-      - [Add New SAS 9.4 Remote Profile](/connect-and-run.md#add-new-sas-94-remote-profile)
-      - [Profile Anatomy (SAS 9.4 Local)](/connect-and-run.md/#profile-anatomy-sas-94-local)
+      - [Profile Details (SAS 9.4 Remote SSH)](/connect-and-run.md/#profile-sas-94-remote---ssh)
+      - [Add New SAS 9.4 Remote SSH Profile](/connect-and-run.md#add-new-sas-94-remote---ssh-profile)
+      - [Profile Details (SAS 9.4 Local)](/connect-and-run.md/#profile-sas-94-local)
       - [Add New SAS 9.4 Local Profile](/connect-and-run.md/#add-new-sas-94-local-profile)
+      - [Profile Details (SAS 9.4 Remote IOM)](/connect-and-run.md/#profile-sas-94-remote---iom)
+      - [Add New SAS 9.4 Remote IOM Profile](/connect-and-run.md/#add-new-sas-94-remote---iom-profile)
       - [Delete SAS Profile](/connect-and-run.md#delete-connection-profile)
       - [Switch Current SAS Profile](/connect-and-run.md#switch-current-connection-profile)
       - [Update SAS Profile](/connect-and-run.md#update-connection-profile)

client/src/components/AuthProvider.ts

@@ -8,7 +8,6 @@ import {
   Disposable,
   Event,
   EventEmitter,
-  SecretStorage,
   commands,
   workspace,
 } from "vscode";
@@ -17,6 +16,7 @@ import { profileConfig } from "../commands/profile";
 import { ConnectionType } from "../components/profile";
 import { getTokens, refreshToken } from "../connection/rest/auth";
 import { getCurrentUser } from "../connection/rest/identities";
+import { getSecretStorage } from "./ExtensionContext";
 
 const SECRET_KEY = "SASAuth";
 
@@ -27,6 +27,7 @@ interface SASAuthSession extends AuthenticationSession {
 export class SASAuthProvider implements AuthenticationProvider, Disposable {
   static id = "SAS";
 
+  private readonly secretStorage;
   private _disposables: Disposable[];
   private _lastSession: SASAuthSession | undefined;
   private _onDidChangeSessions =
@@ -35,7 +36,7 @@ export class SASAuthProvider implements AuthenticationProvider, Disposable {
     return this._onDidChangeSessions.event;
   }
 
-  constructor(private readonly secretStorage: SecretStorage) {
+  constructor() {
     this._disposables = [
       this._onDidChangeSessions,
       workspace.onDidChangeConfiguration((event: ConfigurationChangeEvent) => {
@@ -52,6 +53,7 @@ export class SASAuthProvider implements AuthenticationProvider, Disposable {
         }
       }),
     ];
+    this.secretStorage = getSecretStorage<SASAuthSession>(SECRET_KEY);
   }
 
   dispose(): void {
@@ -80,7 +82,7 @@ export class SASAuthProvider implements AuthenticationProvider, Disposable {
   }
 
   private async _getSessions(): Promise<readonly AuthenticationSession[]> {
-    const sessions = await this.getStoredSessions();
+    const sessions = await this.secretStorage.getNamespaceData();
     if (!sessions) {
       return [];
     }
@@ -152,18 +154,11 @@ export class SASAuthProvider implements AuthenticationProvider, Disposable {
   }
 
   private async writeSession(session: SASAuthSession): Promise<void> {
-    const storedSessions = await this.getStoredSessions();
-
-    const sessions = {
-      ...(storedSessions || {}),
-      [session.id]: session,
-    };
-
-    await this.secretStorage.store(SECRET_KEY, JSON.stringify(sessions));
+    this.secretStorage.store(session.id, session);
   }
 
   async removeSession(sessionId: string, silent?: boolean): Promise<void> {
-    const sessions = await this.getStoredSessions();
+    const sessions = await this.secretStorage.getNamespaceData();
     if (!sessions) {
       return;
     }
@@ -178,14 +173,14 @@ export class SASAuthProvider implements AuthenticationProvider, Disposable {
     if (!silent) {
       // Triggered by user sign out from the Accounts menu
       // VS Code will sign out all sessions by this account
-      Object.values(sessions).forEach((s) => {
+      Object.values(sessions).forEach((s: SASAuthSession) => {
         if (s.account.id === session.account.id) {
           delete sessions[s.id];
         }
       });
     }
 
-    await this.secretStorage.store(SECRET_KEY, JSON.stringify(sessions));
+    await this.secretStorage.setNamespaceData(sessions);
 
     this._lastSession = undefined;
     this._onDidChangeSessions.fire({
@@ -198,15 +193,4 @@ export class SASAuthProvider implements AuthenticationProvider, Disposable {
       commands.executeCommand("setContext", "SAS.authorized", false);
     }
   }
-
-  private async getStoredSessions(): Promise<
-    Record<string, SASAuthSession> | undefined
-  > {
-    const storedSessionData = await this.secretStorage.get(SECRET_KEY);
-    if (!storedSessionData) {
-      return;
-    }
-
-    return JSON.parse(storedSessionData);
-  }
 }

client/src/components/ExtensionContext.ts

@@ -1,6 +1,6 @@
 // Copyright © 2023, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { ExtensionContext } from "vscode";
+import { ExtensionContext, Uri } from "vscode";
 
 let context: ExtensionContext;
 
@@ -26,3 +26,41 @@ export async function getContextValue(
 ): Promise<string | undefined> {
   return context.workspaceState.get(key);
 }
+
+export function getGlobalStorageUri(): Uri {
+  return context.globalStorageUri;
+}
+
+export function getSecretStorage<T = string>(namespace: string) {
+  const getNamespaceData = async (): Promise<Record<string, T> | undefined> => {
+    const storedSessionData = await context.secrets.get(namespace);
+    if (!storedSessionData) {
+      return;
+    }
+
+    return JSON.parse(storedSessionData);
+  };
+  const setNamespaceData = async (data: Record<string, T>) => {
+    await context.secrets.store(namespace, JSON.stringify(data));
+  };
+
+  const get = async (key: string): Promise<T | undefined> => {
+    const data = await getNamespaceData();
+    if (!data) {
+      return;
+    }
+
+    return data[key];
+  };
+
+  const store = async (key: string, value: T) => {
+    const data = await getNamespaceData();
+    const newData = {
+      ...(data || {}),
+      [key]: value,
+    };
+    await context.secrets.store(namespace, JSON.stringify(newData));
+  };
+
+  return { setNamespaceData, getNamespaceData, get, store };
+}

client/src/components/profile.ts

@@ -17,14 +17,16 @@ export const EXTENSION_PROFILES_CONFIG_KEY = "profiles";
 export const EXTENSION_ACTIVE_PROFILE_CONFIG_KEY = "activeProfile";
 
 enum ConnectionOptions {
+  SAS9COM = "SAS 9.4 (local)",
+  SAS9IOM = "SAS 9.4 (remote - IOM)",
+  SAS9SSH = "SAS 9.4 (remote - SSH)",
   SASViya = "SAS Viya",
-  SAS94Remote = "SAS 9.4 (remote)",
-  SAS9COM = "SAS 9.4 (local - COM)",
 }
 
 const CONNECTION_PICK_OPTS: string[] = [
   ConnectionOptions.SASViya,
-  ConnectionOptions.SAS94Remote,
+  ConnectionOptions.SAS9SSH,
+  ConnectionOptions.SAS9IOM,
   ConnectionOptions.SAS9COM,
 ];
 
@@ -33,6 +35,7 @@ const CONNECTION_PICK_OPTS: string[] = [
  */
 export const DEFAULT_COMPUTE_CONTEXT = "SAS Job Execution compute context";
 export const DEFAULT_SSH_PORT = "22";
+export const DEFAULT_IOM_PORT = "8591";
 
 /**
  * Dictionary is a type that maps a generic object with a string key.
@@ -53,9 +56,10 @@ export enum AuthType {
  * Enum that represents the connection type for a profile.
  */
 export enum ConnectionType {
+  COM = "com",
+  IOM = "iom",
   Rest = "rest",
   SSH = "ssh",
-  COM = "com",
 }
 
 /**
@@ -91,7 +95,14 @@ export interface COMProfile extends BaseProfile {
   host: string;
 }
 
-export type Profile = ViyaProfile | SSHProfile | COMProfile;
+export interface IOMProfile extends BaseProfile {
+  connectionType: ConnectionType.IOM;
+  host: string;
+  username: string;
+  port: number;
+}
+
+export type Profile = ViyaProfile | SSHProfile | COMProfile | IOMProfile;
 
 export enum AutoExecType {
   File = "file",
@@ -573,6 +584,32 @@ export class ProfileConfig {
     } else if (profileClone.connectionType === ConnectionType.COM) {
       profileClone.sasOptions = [];
       profileClone.host = "localhost"; //once remote support rolls out this should be set via prompting
+      await this.upsertProfile(name, profileClone);
+    } else if (profileClone.connectionType === ConnectionType.IOM) {
+      profileClone.sasOptions = [];
+      profileClone.host = await createInputTextBox(
+        ProfilePromptType.Host,
+        profileClone.host,
+      );
+      if (!profileClone.host) {
+        return;
+      }
+
+      profileClone.port = parseInt(
+        await createInputTextBox(ProfilePromptType.Port, DEFAULT_IOM_PORT),
+      );
+      if (isNaN(profileClone.port)) {
+        return;
+      }
+
+      profileClone.username = await createInputTextBox(
+        ProfilePromptType.Username,
+        profileClone.username,
+      );
+      if (profileClone.username === undefined) {
+        return;
+      }
+
       await this.upsertProfile(name, profileClone);
     }
   }
@@ -588,6 +625,7 @@ export class ProfileConfig {
     switch (activeProfile.connectionType) {
       case ConnectionType.SSH:
       case ConnectionType.COM:
+      case ConnectionType.IOM:
         return activeProfile.host;
       case ConnectionType.Rest:
         return activeProfile.endpoint;
@@ -737,9 +775,9 @@ const input: ProfilePromptInput = {
     description: l10n.t("Select a Connection Type."),
   },
   [ProfilePromptType.Host]: {
-    title: l10n.t("SAS 9 SSH Server"),
+    title: l10n.t("SAS 9 Server"),
     placeholder: l10n.t("Enter the server name"),
-    description: l10n.t("Enter the name of the SAS 9 SSH server."),
+    description: l10n.t("Enter the name of the SAS 9 server."),
   },
   [ProfilePromptType.SASPath]: {
     title: l10n.t("Server Path"),
@@ -772,10 +810,12 @@ function mapQuickPickToEnum(connectionTypePickInput: string): ConnectionType {
   switch (connectionTypePickInput) {
     case ConnectionOptions.SASViya:
       return ConnectionType.Rest;
-    case ConnectionOptions.SAS94Remote:
+    case ConnectionOptions.SAS9SSH:
       return ConnectionType.SSH;
     case ConnectionOptions.SAS9COM:
       return ConnectionType.COM;
+    case ConnectionOptions.SAS9IOM:
+      return ConnectionType.IOM;
     default:
       return undefined;
   }