chore: fix environment variable parsing (#1505)

Author: codebytere

package.json

@@ -61,6 +61,7 @@
     "node-watch": "^0.7.3",
     "p-debounce": "^2.0.0",
     "package-json": "^7.0.0",
+    "parse-env-string": "^1.0.1",
     "react": "^16.14.0",
     "react-dom": "^16.14.0",
     "react-mosaic-component": "^4.1.1",

src/renderer/runner.ts

@@ -10,6 +10,8 @@ import {
   RunnableVersion,
 } from '../interfaces';
 
+const parseEnvString = require('parse-env-string');
+
 export enum ForgeCommands {
   PACKAGE = 'package',
   MAKE = 'make',
@@ -330,14 +332,26 @@ export class Runner {
     }
   }
 
-  private buildChildEnvVars(): { [x: string]: string | undefined } {
+  public buildChildEnvVars(): { [x: string]: string | undefined } {
     const { environmentVariables } = this.appState;
 
     const env: Record<string, string> = {};
 
-    for (const v of environmentVariables) {
-      const [key, value] = v.split('=');
-      env[key] = value;
+    for (const envVar of environmentVariables) {
+      const errMsg = `Could not parse environment variable: ${envVar}`;
+
+      try {
+        const parsed: Record<string, string> | null = parseEnvString(envVar);
+        if (!parsed || !Object.keys(parsed).length) {
+          this.appState.showErrorDialog(errMsg);
+          continue;
+        }
+
+        const [key, value] = Object.entries(parsed)[0];
+        env[key] = value;
+      } catch (e) {
+        this.appState.showErrorDialog(errMsg);
+      }
     }
 
     return env;

tests/renderer/runner-spec.tsx

@@ -41,6 +41,48 @@ describe('Runner component', () => {
     instance = new Runner(store as unknown as AppState);
   });
 
+  describe('buildChildEnvVars', () => {
+    it('fails when the environment variable is invalid', () => {
+      store.showErrorDialog = jest.fn().mockResolvedValueOnce(true);
+      store.environmentVariables = ['bwap bwap'];
+      const env = instance.buildChildEnvVars();
+      expect(env).toEqual({});
+
+      expect(store.showErrorDialog).toHaveBeenCalledWith(
+        expect.stringMatching(
+          `Could not parse environment variable: bwap bwap`,
+        ),
+      );
+    });
+
+    it('returns an empty object when there are no environment variables', () => {
+      store.environmentVariables = [];
+      const env = instance.buildChildEnvVars();
+      expect(env).toEqual({});
+    });
+
+    it('returns an object with the environment variables', () => {
+      store.environmentVariables = ['foo=bar', 'bar=baz'];
+      const env = instance.buildChildEnvVars();
+      expect(env).toEqual({ foo: 'bar', bar: 'baz' });
+    });
+
+    it('returns an object with complex environment variables', () => {
+      store.environmentVariables = [
+        'NODE_OPTIONS="--no-warnings --max-old-space-size=2048"',
+        'ELECTRON_TRASH=gvfs-trash',
+        'ELECTRON_OVERRIDE_DIST_PATH=/Users/user=nam=!e/projects/electron/out/Testing',
+      ];
+      const env = instance.buildChildEnvVars();
+      expect(env).toEqual({
+        NODE_OPTIONS: '--no-warnings --max-old-space-size=2048',
+        ELECTRON_TRASH: 'gvfs-trash',
+        ELECTRON_OVERRIDE_DIST_PATH:
+          '/Users/user=nam=!e/projects/electron/out/Testing',
+      });
+    });
+  });
+
   describe('run()', () => {
     it('runs', async () => {
       // wait for run() to get running

yarn.lock

@@ -9570,6 +9570,11 @@ parse-author@^2.0.0:
   dependencies:
     author-regex "^1.0.0"
 
+parse-env-string@^1.0.1:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/parse-env-string/-/parse-env-string-1.0.1.tgz#9e1d06a5e561237d3ca7d06f6178f86b54d5c610"
+  integrity sha512-nozPS2x3SzOI6K2TUeeK/KwxMcg22SpAYVY75JeOXHu0M33L+Zo38NkNBlvUqajGwBGKYEbVTI4WemZJFo/OAA==
+
 parse-json@^2.2.0:
   version "2.2.0"
   resolved "https://registry.npmjs.org/parse-json/-/parse-json-2.2.0.tgz"