Support shared variables across all envs #128 #133

Huachao · Nov 1, 2017 · 11f38e9 · 11f38e9
1 parent be8dda6
commit 11f38e9
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 16 deletions.
diff --git a/package.json b/package.json
@@ -33,7 +33,8 @@
   ],
   "keywords": [
     "REST",
-    "Http"
+    "Http",
+    "multi-root ready"
   ],
   "activationEvents": [
     "onCommand:rest-client.request",
@@ -330,7 +331,7 @@
         },
         "rest-client.environmentVariables": {
           "type": "object",
-          "default": {},
+          "default": {"$shared": {}},
           "scope": "resource",
           "description": "Sets the environments and custom variables belongs to it (e.g., {\"production\": {\"host\": \"api.example.com\"}, \"sandbox\":{\"host\":\"sandbox.api.example.com\"}})",
           "additionalProperties": {

diff --git a/src/controllers/environmentController.ts b/src/controllers/environmentController.ts
@@ -8,8 +8,10 @@ import * as Constants from '../constants';
 import { trace } from "../decorator";
 
 export class EnvironmentController {
-    public static noEnvironmentPickItem: EnvironmentPickItem = new EnvironmentPickItem(
-        'No Environment', Constants.NoEnvironmentSelectedName, 'DO NOT Use Any Environment');
+    private static readonly noEnvironmentPickItem: EnvironmentPickItem = new EnvironmentPickItem(
+        'No Environment', Constants.NoEnvironmentSelectedName, 'You Can Still Use Variables Defined In $shared Environment');
+
+    private static readonly sharedEnvironmentName: string = '$shared';
 
     private _environmentStatusBarItem: StatusBarItem;
     private _restClientSettings: RestClientSettings;
@@ -29,6 +31,9 @@ export class EnvironmentController {
         let itemPickList: EnvironmentPickItem[] = [];
         itemPickList.push(EnvironmentController.noEnvironmentPickItem);
         for (let name in this._restClientSettings.environmentVariables) {
+            if (name === EnvironmentController.sharedEnvironmentName) {
+                continue;
+            }
             let item = new EnvironmentPickItem(name, name);
             if (item.name === currentEnvironment.name) {
                 item.description = '$(check)';
@@ -61,13 +66,18 @@ export class EnvironmentController {
         }
 
         let settings = new RestClientSettings();
-        for (let environmentName in settings.environmentVariables) {
-            if (environmentName === environment.name) {
-                return settings.environmentVariables[environmentName];
-            }
-        }
+        let environments = settings.environmentVariables;
+        let variables = {};
+        Object.assign(
+            variables,
+            environments[EnvironmentController.sharedEnvironmentName] || {},
+            environments[environment.name] || {});
 
-        return new Map<string, string>();
+        const map = new Map<string, string>();
+        Object.keys(variables).forEach(key => {
+            map.set(key, variables[key]);
+        });
+        return map;
     }
 
     public dispose() {

diff --git a/src/customVariableHoverProvider.ts b/src/customVariableHoverProvider.ts
@@ -24,9 +24,9 @@ export class CustomVariableHoverProvider implements HoverProvider {
         }
 
         let environmentCustomVariables = await EnvironmentController.getCustomVariables();
-        for (let variableName in environmentCustomVariables) {
+        for (let [variableName, variableValue] of environmentCustomVariables) {
             if (variableName === selectedVariableName) {
-                let contents: MarkedString[] = [environmentCustomVariables[variableName], { language: 'http', value: `Environment Variable ${variableName}` }];
+                let contents: MarkedString[] = [variableValue, { language: 'http', value: `Environment Variable ${variableName}` }];
                 return new Hover(contents, wordRange);
             }
         }

diff --git a/src/httpElementFactory.ts b/src/httpElementFactory.ts
@@ -107,8 +107,8 @@ export class HttpElementFactory {
 
         // add environment custom variables
         let customVariables = await EnvironmentController.getCustomVariables();
-        for (let variableName in customVariables) {
-            originalElements.push(new HttpElement(variableName, ElementType.EnvironmentCustomVariable, null, `Value: ${customVariables[variableName]}`, new SnippetString(`{{${variableName}}}`)));
+        for (let [variableName, variableValue] of customVariables) {
+            originalElements.push(new HttpElement(variableName, ElementType.EnvironmentCustomVariable, null, `Value: ${variableValue}`, new SnippetString(`{{${variableName}}}`)));
         }
 
         // add file custom variables

diff --git a/src/variableProcessor.ts b/src/variableProcessor.ts
@@ -33,10 +33,10 @@ export class VariableProcessor {
         }
 
         let environmentVariables = await EnvironmentController.getCustomVariables();
-        for (let variableName in environmentVariables) {
+        for (let [variableName, variableValue] of environmentVariables) {
             let regex = new RegExp(`\\{\\{\\s*${variableName}\\s*\\}\\}`, 'g');
             if (regex.test(request)) {
-                request = request.replace(regex, environmentVariables[variableName]);
+                request = request.replace(regex, variableValue);
             }
         }