From 261ef43443907899da7fe89796d7eb2d4b0322e1 Mon Sep 17 00:00:00 2001
From: "Sakamoto, Kazunori" <exKAZUu@users.noreply.github.com>
Date: Sat, 30 Sep 2023 11:27:27 +0900
Subject: [PATCH] feat!: rewrite env features (#183)

---
 packages/shared-lib-node/src/env.ts           |  6 +++---
 .../shared-lib-node/test-fixtures/app1/.env   |  1 +
 .../{app => app1}/.env.development            |  0
 .../{app => app1}/.env.production             |  0
 .../test-fixtures/{app => app1}/.env.test     |  0
 .../shared-lib-node/test-fixtures/app2/.env   |  1 +
 .../{another-app => app2}/.env.development    |  0
 .../{another-app => app2}/.env.production     |  0
 .../{another-app => app2}/.env.test           |  0
 packages/shared-lib-node/tests/env.test.ts    | 16 ++++++++--------
 packages/wb/src/commands/setup.ts             |  4 ++--
 packages/wb/src/commands/start.ts             | 19 +++++++++++++------
 packages/wb/src/index.ts                      |  4 ++--
 .../scripts/execution/baseExecutionScripts.ts |  8 +++++---
 .../scripts/execution/httpServerScripts.ts    |  6 ++++--
 .../wb/src/scripts/execution/remixScripts.ts  |  8 +++-----
 16 files changed, 42 insertions(+), 31 deletions(-)
 create mode 100644 packages/shared-lib-node/test-fixtures/app1/.env
 rename packages/shared-lib-node/test-fixtures/{app => app1}/.env.development (100%)
 rename packages/shared-lib-node/test-fixtures/{app => app1}/.env.production (100%)
 rename packages/shared-lib-node/test-fixtures/{app => app1}/.env.test (100%)
 create mode 100644 packages/shared-lib-node/test-fixtures/app2/.env
 rename packages/shared-lib-node/test-fixtures/{another-app => app2}/.env.development (100%)
 rename packages/shared-lib-node/test-fixtures/{another-app => app2}/.env.production (100%)
 rename packages/shared-lib-node/test-fixtures/{another-app => app2}/.env.test (100%)

diff --git a/packages/shared-lib-node/src/env.ts b/packages/shared-lib-node/src/env.ts
index 406be7d2..072dac0c 100644
--- a/packages/shared-lib-node/src/env.ts
+++ b/packages/shared-lib-node/src/env.ts
@@ -26,7 +26,7 @@ export const yargsOptionsBuilderForEnv = {
     type: 'boolean',
   },
   'auto-cascade-env': {
-    description: 'Same with --cascade-env=<WB_ENV || APP_ENV || NODE_ENV || "development">.',
+    description: 'Same with --cascade-env=<WB_ENV || NODE_ENV || "development">.',
     type: 'boolean',
     default: true,
   },
@@ -47,7 +47,7 @@ export function loadEnvironmentVariables(argv: Options, cwd: string, orgCwd?: st
     (argv.cascadeNodeEnv
       ? process.env.NODE_ENV || 'development'
       : argv.autoCascadeEnv
-      ? process.env.WB_ENV || process.env.APP_ENV || process.env.NODE_ENV || 'development'
+      ? process.env.WB_ENV || process.env.NODE_ENV || 'development'
       : undefined);
   if (typeof cascade === 'string') {
     if (envPaths.length === 0) envPaths.push(path.join(cwd, '.env'));
@@ -74,7 +74,7 @@ export function loadEnvironmentVariables(argv: Options, cwd: string, orgCwd?: st
       }
     }
     if (count > 0) {
-      console.info(`Updated ${count} environment variables:`, envPath);
+      console.info(`Loaded ${count} environment variables:`, envPath);
     }
   }
 
diff --git a/packages/shared-lib-node/test-fixtures/app1/.env b/packages/shared-lib-node/test-fixtures/app1/.env
new file mode 100644
index 00000000..b9759296
--- /dev/null
+++ b/packages/shared-lib-node/test-fixtures/app1/.env
@@ -0,0 +1 @@
+NAME=app1
diff --git a/packages/shared-lib-node/test-fixtures/app/.env.development b/packages/shared-lib-node/test-fixtures/app1/.env.development
similarity index 100%
rename from packages/shared-lib-node/test-fixtures/app/.env.development
rename to packages/shared-lib-node/test-fixtures/app1/.env.development
diff --git a/packages/shared-lib-node/test-fixtures/app/.env.production b/packages/shared-lib-node/test-fixtures/app1/.env.production
similarity index 100%
rename from packages/shared-lib-node/test-fixtures/app/.env.production
rename to packages/shared-lib-node/test-fixtures/app1/.env.production
diff --git a/packages/shared-lib-node/test-fixtures/app/.env.test b/packages/shared-lib-node/test-fixtures/app1/.env.test
similarity index 100%
rename from packages/shared-lib-node/test-fixtures/app/.env.test
rename to packages/shared-lib-node/test-fixtures/app1/.env.test
diff --git a/packages/shared-lib-node/test-fixtures/app2/.env b/packages/shared-lib-node/test-fixtures/app2/.env
new file mode 100644
index 00000000..59707862
--- /dev/null
+++ b/packages/shared-lib-node/test-fixtures/app2/.env
@@ -0,0 +1 @@
+NAME=app2
diff --git a/packages/shared-lib-node/test-fixtures/another-app/.env.development b/packages/shared-lib-node/test-fixtures/app2/.env.development
similarity index 100%
rename from packages/shared-lib-node/test-fixtures/another-app/.env.development
rename to packages/shared-lib-node/test-fixtures/app2/.env.development
diff --git a/packages/shared-lib-node/test-fixtures/another-app/.env.production b/packages/shared-lib-node/test-fixtures/app2/.env.production
similarity index 100%
rename from packages/shared-lib-node/test-fixtures/another-app/.env.production
rename to packages/shared-lib-node/test-fixtures/app2/.env.production
diff --git a/packages/shared-lib-node/test-fixtures/another-app/.env.test b/packages/shared-lib-node/test-fixtures/app2/.env.test
similarity index 100%
rename from packages/shared-lib-node/test-fixtures/another-app/.env.test
rename to packages/shared-lib-node/test-fixtures/app2/.env.test
diff --git a/packages/shared-lib-node/tests/env.test.ts b/packages/shared-lib-node/tests/env.test.ts
index 138751ae..d0c98f7d 100644
--- a/packages/shared-lib-node/tests/env.test.ts
+++ b/packages/shared-lib-node/tests/env.test.ts
@@ -9,39 +9,39 @@ describe('loadEnvironmentVariables()', () => {
   });
 
   it('should load no env vars with empty options', () => {
-    const envVars = loadEnvironmentVariables({}, 'test-fixtures/app');
+    const envVars = loadEnvironmentVariables({}, 'test-fixtures/app1');
     expect(envVars).toEqual({});
   });
 
   it('should load env vars with --auto-cascade-env', () => {
-    const envVars = loadEnvironmentVariables({ autoCascadeEnv: true }, 'test-fixtures/app');
+    const envVars = loadEnvironmentVariables({ autoCascadeEnv: true }, 'test-fixtures/app1');
     expect(envVars).toEqual({ NAME: 'app1', ENV: 'development1' });
   });
 
   it('should load env vars with --cascade-env=production', () => {
-    const envVars = loadEnvironmentVariables({ cascadeEnv: 'production', env: ['.env'] }, 'test-fixtures/app');
+    const envVars = loadEnvironmentVariables({ cascadeEnv: 'production', env: ['.env'] }, 'test-fixtures/app1');
     expect(envVars).toEqual({ NAME: 'app1', ENV: 'production1' });
   });
 
   it('should load env vars with --cascade-node-env and NODE_ENV=""', () => {
     process.env.NODE_ENV = '';
-    const envVars = loadEnvironmentVariables({ cascadeNodeEnv: true, env: ['.env'] }, 'test-fixtures/app');
+    const envVars = loadEnvironmentVariables({ cascadeNodeEnv: true, env: ['.env'] }, 'test-fixtures/app1');
     expect(envVars).toEqual({ NAME: 'app1', ENV: 'development1' });
   });
 
   it('should load env vars with --cascade-node-env and NODE_ENV=test', () => {
     process.env.NODE_ENV = 'test';
-    const envVars = loadEnvironmentVariables({ cascadeNodeEnv: true, env: ['.env'] }, 'test-fixtures/app');
+    const envVars = loadEnvironmentVariables({ cascadeNodeEnv: true, env: ['.env'] }, 'test-fixtures/app1');
     expect(envVars).toEqual({ NAME: 'app1', ENV: 'test1' });
   });
 
-  it('should load env vars with --env=test-fixtures/another-app/.env --auto-cascade-env, WB_ENV=test and NODE_ENV=production', () => {
+  it('should load env vars with --env=test-fixtures/app2/.env --auto-cascade-env, WB_ENV=test and NODE_ENV=production', () => {
     process.env.WB_ENV = 'test';
     process.env.NODE_ENV = 'production';
     const envVars = loadEnvironmentVariables(
       { autoCascadeEnv: true, env: ['.env'] },
-      'test-fixtures/app',
-      'test-fixtures/another-app'
+      'test-fixtures/app1',
+      'test-fixtures/app2'
     );
     expect(envVars).toEqual({ NAME: 'app2', ENV: 'test2' });
   });
diff --git a/packages/wb/src/commands/setup.ts b/packages/wb/src/commands/setup.ts
index 85d47944..474ebe0f 100644
--- a/packages/wb/src/commands/setup.ts
+++ b/packages/wb/src/commands/setup.ts
@@ -53,9 +53,9 @@ export async function setup(argv: Partial<ArgumentsCamelCase<InferredOptionTypes
   const newDevDeps: string[] = [];
   if (deps['blitz'] || deps['next']) {
     newDeps.push('pm2');
-    newDevDeps.push('concurrently', 'dotenv-cli', 'open-cli', 'vitest', 'wait-on');
+    newDevDeps.push('concurrently', 'open-cli', 'vitest', 'wait-on');
   } else if (devDeps['@remix-run/dev']) {
-    newDeps.push('dotenv-cli', 'pm2');
+    newDeps.push('pm2');
     newDevDeps.push('concurrently', 'open-cli', 'vitest', 'wait-on');
   } else if (deps['express'] || deps['fastify']) {
     newDeps.push('pm2');
diff --git a/packages/wb/src/commands/start.ts b/packages/wb/src/commands/start.ts
index c330a2d7..5bb953cd 100644
--- a/packages/wb/src/commands/start.ts
+++ b/packages/wb/src/commands/start.ts
@@ -1,3 +1,4 @@
+import { loadEnvironmentVariables } from '@willbooster/shared-lib-node/src';
 import type { CommandModule, InferredOptionTypes } from 'yargs';
 
 import { project } from '../project.js';
@@ -13,7 +14,7 @@ import { runWithSpawn } from '../scripts/run.js';
 const builder = {
   ...scriptOptionsBuilder,
   mode: {
-    description: 'Start mode: dev[elopment] (default) | prod[uction] | docker',
+    description: 'Start mode: dev[elopment] (default) | stg | staging | docker',
     type: 'string',
     alias: 'm',
   },
@@ -47,16 +48,22 @@ export const startCommand: CommandModule<unknown, InferredOptionTypes<typeof bui
     switch (argv.mode || 'dev') {
       case 'dev':
       case 'development': {
-        await runWithSpawn(scripts.start(argv), argv);
+        process.env.WB_ENV ||= 'development';
+        loadEnvironmentVariables(argv, project.dirPath);
+        await runWithSpawn(`WB_ENV=${process.env.WB_ENV} ${scripts.start(argv)}`, argv);
         break;
       }
-      case 'prod':
-      case 'production': {
-        await runWithSpawn(scripts.startProduction(argv, 8080), argv);
+      case 'stg':
+      case 'staging': {
+        process.env.WB_ENV ||= 'staging';
+        loadEnvironmentVariables(argv, project.dirPath);
+        await runWithSpawn(`WB_ENV=${process.env.WB_ENV} ${scripts.startProduction(argv, 8080)}`, argv);
         break;
       }
       case 'docker': {
-        await runWithSpawn(scripts.startDocker(argv), argv);
+        process.env.WB_ENV ||= 'staging';
+        loadEnvironmentVariables(argv, project.dirPath);
+        await runWithSpawn(`WB_ENV=${process.env.WB_ENV} ${scripts.startDocker(argv)}`, argv);
         break;
       }
       default: {
diff --git a/packages/wb/src/index.ts b/packages/wb/src/index.ts
index 6bee65e8..281be48a 100644
--- a/packages/wb/src/index.ts
+++ b/packages/wb/src/index.ts
@@ -29,9 +29,9 @@ await yargs(hideBin(process.argv))
     removeNpmAndYarnEnvironmentVariables(process.env);
 
     const command = argv._[0].toString();
-    if (['tc', 'typecheck'].includes(command)) return;
+    if (['start', 'tc', 'typecheck'].includes(command)) return;
     if (command === 'test') {
-      process.env.WB_ENV = process.env.WB_ENV || 'test';
+      process.env.WB_ENV ||= 'test';
     }
     loadEnvironmentVariables(argv, project.dirPath);
   })
diff --git a/packages/wb/src/scripts/execution/baseExecutionScripts.ts b/packages/wb/src/scripts/execution/baseExecutionScripts.ts
index 8dc33c23..cea5f785 100644
--- a/packages/wb/src/scripts/execution/baseExecutionScripts.ts
+++ b/packages/wb/src/scripts/execution/baseExecutionScripts.ts
@@ -37,14 +37,16 @@ export abstract class BaseExecutionScripts {
     // Basically, `playwright` (not `yarn playwright`) should work,
     // but it doesn't work on a project depending on `artillery-engine-playwright`.
     // So we use `yarn playwright` instead of `playwright` here.
-    return `APP_ENV=test WB_ENV=test PORT=8080 YARN dotenv -c production -- concurrently --kill-others --raw --success first
+    const env = process.env.WB_ENV;
+    return `WB_ENV=${env} NEXT_PUBLIC_WB_ENV=${env} APP_ENV=${env} PORT=8080 YARN concurrently --kill-others --raw --success first
       "rm -Rf ${prismaDirectory}/mount && ${startCommand} && exit 1"
       "concurrently --kill-others-on-fail --raw 'wait-on -t 600000 -i 2000 http://127.0.0.1:8080' 'yarn playwright install --with-deps'
         && yarn playwright ${playwrightArgs}"`;
   }
 
   testE2EDev(argv: ScriptArgv, { playwrightArgs, startCommand }: TestE2EDevOptions): string {
-    return `APP_ENV=test WB_ENV=test NEXT_PUBLIC_WB_ENV=test PORT=8080 YARN dotenv -c development -- concurrently --kill-others --raw --success first
+    const env = process.env.WB_ENV;
+    return `WB_ENV=${env} NEXT_PUBLIC_WB_ENV=${env} APP_ENV=${env} PORT=8080 YARN concurrently --kill-others --raw --success first
       "${startCommand} && exit 1"
       "concurrently --kill-others-on-fail --raw 'wait-on -t 600000 -i 2000 http://127.0.0.1:8080' 'yarn playwright install --with-deps'
         && yarn playwright ${playwrightArgs}"`;
@@ -54,7 +56,7 @@ export abstract class BaseExecutionScripts {
 
   testUnit(_: ScriptArgv): string {
     // Since this command is referred to from other commands, we have to use "vitest run".
-    return `YARN vitest run tests/unit --color --passWithNoTests`;
+    return `WB_ENV=${process.env.WB_ENV} YARN vitest run tests/unit --color --passWithNoTests`;
   }
 
   protected waitApp(argv: ScriptArgv, port = this.defaultPort): string {
diff --git a/packages/wb/src/scripts/execution/httpServerScripts.ts b/packages/wb/src/scripts/execution/httpServerScripts.ts
index 9baf9e31..a5817cae 100644
--- a/packages/wb/src/scripts/execution/httpServerScripts.ts
+++ b/packages/wb/src/scripts/execution/httpServerScripts.ts
@@ -40,13 +40,15 @@ class HttpServerScripts extends BaseExecutionScripts {
       )})`,
     }: TestE2EOptions
   ): string {
-    return `NODE_ENV=production WB_ENV=test PORT=8080 YARN concurrently --kill-others --raw --success first
+    return `NODE_ENV=production WB_ENV=${process.env.WB_ENV} PORT=8080 YARN concurrently --kill-others --raw --success first
       "${startCommand} && exit 1"
       "wait-on -t 600000 -i 2000 http://127.0.0.1:8080 && vitest run tests/e2e --color --passWithNoTests"`;
   }
 
   override testE2EDev(argv: ScriptArgv, { startCommand }: TestE2EDevOptions): string {
-    return `NODE_ENV=production WB_ENV=test PORT=8080 YARN concurrently --kill-others --raw --success first
+    return `NODE_ENV=production WB_ENV=${
+      process.env.WB_ENV
+    } PORT=8080 YARN concurrently --kill-others --raw --success first
       "${startCommand || this.start(argv)} && exit 1"
       "wait-on -t 600000 -i 2000 http://127.0.0.1:8080 && vitest run tests/e2e --color --passWithNoTests"`;
   }
diff --git a/packages/wb/src/scripts/execution/remixScripts.ts b/packages/wb/src/scripts/execution/remixScripts.ts
index 165fa99d..18a9e9c7 100644
--- a/packages/wb/src/scripts/execution/remixScripts.ts
+++ b/packages/wb/src/scripts/execution/remixScripts.ts
@@ -16,12 +16,12 @@ class RemixScripts extends BaseExecutionScripts {
 
   override start(argv: ScriptArgv): string {
     return `YARN concurrently --raw --kill-others-on-fail
-      "dotenv -c development -- remix dev ${argv.normalizedArgsText ?? ''}"
+      "remix dev ${argv.normalizedArgsText ?? ''}"
       "${this.waitAndOpenApp(argv)}"`;
   }
 
   override startProduction(argv: ScriptArgv, port: number): string {
-    return `NODE_ENV=production YARN dotenv -c production -- concurrently --raw --kill-others-on-fail
+    return `NODE_ENV=production YARN concurrently --raw --kill-others-on-fail
       "${prismaScripts.reset()} && ${project.getBuildCommand(
         argv
       )} && PORT=${port} pm2-runtime start ecosystem.config.cjs ${argv.normalizedArgsText ?? ''}"
@@ -48,9 +48,7 @@ class RemixScripts extends BaseExecutionScripts {
   }
 
   override testStart(argv: ScriptArgv): string {
-    return `YARN concurrently --kill-others --raw --success first "dotenv -c development -- remix dev" "${this.waitApp(
-      argv
-    )}"`;
+    return `YARN concurrently --kill-others --raw --success first "remix dev" "${this.waitApp(argv)}"`;
   }
 }