Issue #46: Add socket namespace to the URL

Author: eharris369

dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/connection/MicroclimateConnection.java

@@ -56,8 +56,9 @@ public class MicroclimateConnection {
 	private IPath localWorkspacePath;
 	private String versionStr;
 	private String connectionErrorMsg = null;
+	private String socketNamespace = null;
 
-	public final MicroclimateSocket mcSocket;
+	private MicroclimateSocket mcSocket;
 
 	private volatile boolean isConnected = true;
 
@@ -76,14 +77,7 @@ public MicroclimateConnection (URI uri) throws IOException, URISyntaxException,
 		if (MicroclimateConnectionManager.getActiveConnection(uri.toString()) != null) {
 			onInitFail(NLS.bind(Messages.MicroclimateConnection_ErrConnection_AlreadyExists, baseUrl));
 		}
-
-		// Must set host, port fields before doing this
-		mcSocket = new MicroclimateSocket(this);
-		if(!mcSocket.blockUntilFirstConnection()) {
-			close();
-			throw new MicroclimateConnectionException(mcSocket.socketUri);
-		}
-
+		
 		JSONObject env = getEnvData(this.baseUrl);
 
 		this.versionStr = getMCVersion(env);
@@ -104,11 +98,27 @@ public MicroclimateConnection (URI uri) throws IOException, URISyntaxException,
 			// This should never happen since we have already determined it is a supported version of microclimate.
 			onInitFail(Messages.MicroclimateConnection_ErrConnection_WorkspaceErr);
 		}
+		
+		this.socketNamespace = getSocketNamespace(env);
+		
+		mcSocket = new MicroclimateSocket(this);
+		if(!mcSocket.blockUntilFirstConnection()) {
+			close();
+			throw new MicroclimateConnectionException(mcSocket.socketUri);
+		}
 
 		refreshApps(null);
 
 		MCLogger.log("Created " + this); //$NON-NLS-1$
 	}
+	
+	public String getSocketNamespace() {
+		return socketNamespace;
+	}
+	
+	public MicroclimateSocket getMCSocket() {
+		return mcSocket;
+	}
 
 	private void onInitFail(String msg) throws ConnectException {
 		MCLogger.log("Initializing MicroclimateConnection failed: " + msg); //$NON-NLS-1$
@@ -121,11 +131,8 @@ private void onInitFail(String msg) throws ConnectException {
 	 */
 	public void close() {
 		MCLogger.log("Closing " + this); //$NON-NLS-1$
-		if (mcSocket != null && mcSocket.socket != null) {
-			if (mcSocket.socket.connected()) {
-				mcSocket.socket.disconnect();
-			}
-			mcSocket.socket.close();
+		if (mcSocket != null) {
+			mcSocket.close();
 		}
 		for (MicroclimateApplication app : appMap.values()) {
 			app.dispose();
@@ -250,6 +257,19 @@ private static Path getWorkspacePath(JSONObject env) throws JSONException {
 		}
 		return new Path(workspaceLoc);
 	}
+	
+	private static String getSocketNamespace(JSONObject env) throws JSONException {
+		if (env.has(MCConstants.KEY_ENV_MC_SOCKET_NAMESPACE)) {
+			Object nsObj = env.get(MCConstants.KEY_ENV_MC_SOCKET_NAMESPACE);
+			if (nsObj instanceof String) {
+				String namespace = (String)nsObj;
+				if (!namespace.isEmpty()) {
+					return namespace;
+				}
+			}
+		}
+		return null;
+	}
 
 	/**
 	 * Refresh this connection's apps using the Microclimate project list endpoint.
@@ -547,6 +567,21 @@ public synchronized void clearConnectionError() {
 				return;
 			}
 			this.localWorkspacePath = path;
+			
+			String socketNS = getSocketNamespace(envData);
+			if ((socketNS != null && !socketNS.equals(this.socketNamespace)) || (this.socketNamespace != null && !this.socketNamespace.equals(socketNS))) {
+				// The socket namespace has changed so need to recreate the socket
+				this.socketNamespace = socketNS;
+				mcSocket.close();
+				mcSocket = new MicroclimateSocket(this);
+				if(!mcSocket.blockUntilFirstConnection()) {
+					// Still not connected
+					MCLogger.logError("Failed to create a new socket with updated URI: " + mcSocket.socketUri);
+					// Clear the message so that it just shows the basic disconnected message
+					this.connectionErrorMsg = null;
+					return;
+				}
+			}
 		} catch (Exception e) {
 			MCLogger.logError("An exception occurred while trying to update the connection information", e);
 			this.connectionErrorMsg = Messages.MicroclimateConnection_ErrConnection_UpdateCacheException;

dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/connection/MicroclimateSocket.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2018 IBM Corporation and others.
+ * Copyright (c) 2018, 2019 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
@@ -72,10 +72,14 @@ public class MicroclimateSocket {
 	public MicroclimateSocket(MicroclimateConnection mcConnection) throws URISyntaxException {
 		this.mcConnection = mcConnection;
 
-		socketUri = mcConnection.baseUrl;
+		URI uri = mcConnection.baseUrl;
+		if (mcConnection.getSocketNamespace() != null) {
+			uri = uri.resolve(mcConnection.getSocketNamespace());
+		}
+		socketUri = uri;
 
 		socket = IO.socket(socketUri);
-
+		
 		socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() {
 			@Override
 			public void call(Object... arg0) {
@@ -232,6 +236,15 @@ public void call(Object... arg0) {
 		MCLogger.log("Created MicroclimateSocket connected to " + socketUri); //$NON-NLS-1$
 	}
 
+	public void close() {
+		if (socket != null) {
+			if (socket.connected()) {
+				socket.disconnect();
+			}
+			socket.close();
+		}
+	}
+	
 	private void onProjectCreation(JSONObject event) throws JSONException {
 		String projectID = event.getString(MCConstants.KEY_PROJECT_ID);
 		mcConnection.refreshApps(projectID);

dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/console/SocketConsole.java

@@ -1,3 +1,14 @@
+/*******************************************************************************
+ * Copyright (c) 2018, 2019 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v20.html
+ *
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+
 package com.ibm.microclimate.core.internal.console;
 
 import java.io.IOException;
@@ -29,7 +40,7 @@ public SocketConsole(String name, MicroclimateApplication app) {
 
 		this.projectID = app.projectID;
 		this.outputStream = newOutputStream();
-		this.socket = app.mcConnection.mcSocket;
+		this.socket = app.mcConnection.getMCSocket();
 		socket.registerSocketConsole(this);
 
 		try {

dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/constants/MCConstants.java

@@ -67,6 +67,7 @@ private MCConstants() {}
 
 			KEY_ENV_WORKSPACE_LOC = "workspace_location",
 			KEY_ENV_MC_VERSION = "microclimate_version",
+			KEY_ENV_MC_SOCKET_NAMESPACE = "socket_namespace",
 
 			KEY_LANGUAGE = "language",
 			KEY_FRAMEWORK = "framework",