Handle socket namespacing

For compatibility with Microclimate 19.3

Author: Tim Etchells

dev/src/command/NewConnectionCmd.ts

@@ -183,9 +183,15 @@ export async function onSuccessfulConnection(mcUri: vscode.Uri, host: string, mc
     const rawWorkspace: string = mcEnvData.workspace_location;
     const rawPlatform: string = mcEnvData.os_platform;
 
+    // user_string and socket_namespace are the same on ICP, except latter starts with /
+    // on local, user_string is null, and socket_namespace is "/default".
+    // const rawUser: string = mcEnvData.user_string || "";
+    const rawSocketNS: string = mcEnvData.socket_namespace || "";
+
     Log.d("rawVersion from Microclimate is", rawVersion);
     Log.d("rawWorkspace from Microclimate is", rawWorkspace);
     Log.d("rawPlatform from Microclimate is", rawPlatform);
+    Log.d("rawSocketNS from Microclimate is", rawSocketNS);
     if (rawVersion == null || rawWorkspace == null) {
         Log.e("Microclimate environment did not provide either version or workspace. Data provided is:", mcEnvData);
         throw new Error(Translator.t(STRING_NS, "versionNotProvided", { requiredVersion: MCEnvironment.REQUIRED_VERSION_STR }));
@@ -202,8 +208,11 @@ export async function onSuccessfulConnection(mcUri: vscode.Uri, host: string, mc
 
     const versionNum = MCEnvironment.getVersionNumber(mcEnvData);
 
+    // normalize namespace so it doesn't start with '/'
+    const socketNS = rawSocketNS.startsWith("/") ? rawSocketNS.substring(1, rawSocketNS.length) : rawSocketNS;
+
     try {
-        return await ConnectionManager.instance.addConnection(mcUri, host, versionNum, workspace);
+        return await ConnectionManager.instance.addConnection(mcUri, host, versionNum, socketNS, workspace);
     }
     catch (err) {
         Log.i("New connection rejected by ConnectionManager ", err.message || err);

dev/src/microclimate/connection/Connection.ts

@@ -54,10 +54,11 @@ export default class Connection implements ITreeItemAdaptable, vscode.QuickPickI
         public readonly mcUri: vscode.Uri,
         public readonly host: string,
         public readonly version: number,
+        public readonly socketNS: string,
         workspacePath_: string
     ) {
         this.projectsApiUri = Endpoints.getEndpoint(this, Endpoints.PROJECTS);
-        this.socket = new MCSocket(mcUri.toString(), this);
+        this.socket = new MCSocket(this, socketNS);
         this.logManager = new MCLogManager(this);
         this.workspacePath = vscode.Uri.file(workspacePath_);
         this.versionStr = MCEnvironment.getVersionAsString(version);

dev/src/microclimate/connection/ConnectionManager.ts

@@ -47,7 +47,7 @@ export default class ConnectionManager {
         return this._connections;
     }
 
-    public async addConnection(uri: vscode.Uri, host: string, mcVersion: number, workspace: string): Promise<Connection> {
+    public async addConnection(uri: vscode.Uri, host: string, mcVersion: number, socketNS: string, workspace: string): Promise<Connection> {
         if (this.connectionExists(uri)) {
             const alreadyExists = Translator.t(StringNamespaces.DEFAULT, "connectionAlreadyExists", { uri });
             // Log.i(alreadyExists);
@@ -56,7 +56,7 @@ export default class ConnectionManager {
 
         // all validation that this connection is good must be done by this point
 
-        const newConnection: Connection = new Connection(uri, host, mcVersion, workspace);
+        const newConnection: Connection = new Connection(uri, host, mcVersion, socketNS, workspace);
         Log.i("New Connection @ " + uri);
         this._connections.push(newConnection);
         ConnectionManager.saveConnections();

dev/src/microclimate/connection/MCSocket.ts

@@ -24,14 +24,33 @@ import SocketEvents from "./SocketEvents";
  */
 export default class MCSocket {
 
+    private readonly uri: string;
     private readonly socket: SocketIOClient.Socket;
 
+    /**
+     * Create a SocketIO connection to the server at the given URI.
+     * Can throw an error.
+     *
+     * @param namespace - Socket namespace. Must not start with a slash. Can be the empty string.
+     */
     constructor(
-        public readonly uri: string,
-        private readonly connection: Connection
+        private readonly connection: Connection,
+        namespace: string,
     ) {
-        Log.i("Creating MCSocket for URI", uri);
-        this.socket = io(uri);
+        this.uri = connection.mcUri.toString();
+        if (namespace) {
+            if (!this.uri.endsWith("/")) {
+                this.uri += "/";
+            }
+            this.uri += namespace;
+        }
+        Log.i("Creating MCSocket for URI", this.uri);
+
+        const options: SocketIOClient.ConnectOpts = {
+            // rejectUnauthorized:
+        };
+
+        this.socket = io(this.uri, options);
 
         this.socket.connect();