Write connections to ExtensionContext not Settings

Fixes #22

Author: Tim Etchells

dev/package.json

@@ -40,11 +40,6 @@
             "type": "object",
             "title": "Microclimate Tools",
             "properties": {
-                "microclimate.connections": {
-                    "type": "array",
-                    "default": [],
-                    "description": "%settingDesc_connections%"
-                },
                 "microclimate.openLogsOnChange.app": {
                     "type": "boolean",
                     "default": false,

dev/package.nls.json

@@ -98,7 +98,6 @@
     "cmdID_validate": "ext.mc.validate",
     "cmdTitle_validate": "Validate",
 
-    "settingDesc_connections": "URLs of Microclimate instances to connect to. Not intended to be manually edited.",
     "settingDesc_showLogOnChange_app": "When a Microclimate project's open application logs change, bring that log to the front",
     "settingDesc_showLogOnChange_build": "When a Microclimate project's open build logs change, bring that log to the front",
 

dev/src/extension.ts

@@ -27,6 +27,9 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
 
     // Initialize our globals
     global.__extRoot = context.extensionPath;
+    // Declared as 'any' type, but will always be assigned globalState which is a vscode.Memento
+    global.extGlobalState = context.globalState;
+
     Log.setLogFilePath(context);
     Log.i("Finished activating logger");
 

dev/src/global.d.ts

@@ -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
@@ -21,6 +21,11 @@ declare namespace NodeJS {
         // so files don't each have to write their own logic to locate it using relative paths.
         // This is the folder which contains /src and /res, for example.
         __extRoot: string,
+
+        // For some reason, importing anything at the top of this file causes all the properties declared here to not work anymore.
+        // So, we use 'any' for extGlobalState - but it's a vscode.Memento.
+        // extGlobalState: vscode.Memento
+        extGlobalState: any
     }
 }
 

dev/src/microclimate/connection/ConnectionManager.ts

@@ -143,10 +143,8 @@ export default class ConnectionManager {
     }
 
     public static loadConnections(): MCUtil.IConnectionInfo[] {
-        const loaded = vscode.workspace.getConfiguration(Settings.CONFIG_SECTION)
-                .get(Settings.CONNECTIONS_KEY, []);
-
-        // Logger.log("LOADED CONNECTIONS", loaded);
+        const globalState = global.extGlobalState as vscode.Memento;
+        const loaded = globalState.get<MCUtil.IConnectionInfo[]>(Settings.CONNECTIONS_KEY) || [];
         return loaded;
     }
 
@@ -158,8 +156,9 @@ export default class ConnectionManager {
 
         Log.i("Saving connections", connectionInfos);
         try {
-            return vscode.workspace.getConfiguration(Settings.CONFIG_SECTION)
-                    .update(Settings.CONNECTIONS_KEY, connectionInfos, vscode.ConfigurationTarget.Global);
+            const globalState = global.extGlobalState as vscode.Memento;
+            // connectionInfos must not contain cyclic references (ie, JSON.stringify succeeds)
+            await globalState.update(Settings.CONNECTIONS_KEY, connectionInfos);
         }
         catch (err) {
             const msg = Translator.t(StringNamespaces.DEFAULT, "errorSavingConnections", { err: err.toString() });

dev/src/microclimate/project/Requester.ts

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2019 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