feat(dotenv): ability to have local and environment-specific dotenv f…

…iles (#162)

examples/1-simple-model/.env

@@ -1,3 +1,4 @@
+NODE_ENV=development
 WARTHOG_APP_HOST=localhost
 WARTHOG_APP_PORT=4100
 WARTHOG_DB_DATABASE=warthog-example-1

examples/2-complex-example/.env

@@ -1,3 +1,4 @@
+NODE_ENV=development
 WARTHOG_APP_HOST=localhost
 WARTHOG_APP_PORT=4100
 WARTHOG_DB_DATABASE=warthog-example-2

examples/2-complex-example/tools/seed.ts

@@ -4,14 +4,16 @@ import { getBindingError, logger } from '../../../src';
 
 import { getServer } from '../src/server';
 
-if (process.env.NODE_ENV !== 'development') {
-  throw 'Seeding only available in development environment';
-}
-
 const NUM_USERS = 10;
 
 async function seedDatabase() {
   const server = getServer({ openPlayground: false });
+
+  // NOTE: this has to be after we instantiate the server, because the server will actually load the environment variables from .env and set process.env.NODE_ENV
+  if (process.env.NODE_ENV !== 'development') {
+    throw 'Seeding only available in development environment';
+  }
+
   await server.start();
 
   let binding;

examples/3-one-to-many-relationship/.env

@@ -1,3 +1,4 @@
+NODE_ENV=development
 WARTHOG_APP_HOST=localhost
 WARTHOG_APP_PORT=4100
 WARTHOG_DB_DATABASE=warthog-example-3

examples/4-many-to-many-relationship/.env

@@ -1,3 +1,4 @@
+NODE_ENV=development
 WARTHOG_APP_HOST=localhost
 WARTHOG_APP_PORT=4100
 WARTHOG_DB_DATABASE=warthog-example-4

examples/5-migrations/.env

@@ -1,3 +1,4 @@
+NODE_ENV=development
 WARTHOG_APP_HOST=localhost
 WARTHOG_APP_PORT=4100
 WARTHOG_DB_CONNECTION=postgres

examples/6-base-service/.env

@@ -1,3 +1,4 @@
+NODE_ENV=development
 WARTHOG_APP_HOST=localhost
 WARTHOG_APP_PORT=4100
 WARTHOG_DB_DATABASE=warthog-example-6

examples/6-base-service/tools/seed.ts

@@ -4,14 +4,16 @@ import { getBindingError, logger } from '../../../src';
 
 import { getServer } from '../src/server';
 
-if (process.env.NODE_ENV !== 'development') {
-  throw 'Seeding only available in development environment';
-}
-
 const NUM_USERS = 100;
 
 async function seedDatabase() {
   const server = getServer({ introspection: true, openPlayground: false });
+
+  // NOTE: this has to be after we instantiate the server, because the server will actually load the environment variables from .env and set process.env.NODE_ENV
+  if (process.env.NODE_ENV !== 'development') {
+    throw 'Seeding only available in development environment';
+  }
+
   await server.start();
 
   let binding;

examples/7-feature-flags/.env

@@ -1,3 +1,4 @@
+NODE_ENV=development
 WARTHOG_APP_HOST=localhost
 WARTHOG_APP_PORT=4100
 WARTHOG_DB_DATABASE=warthog-example-feature-flag

examples/7-feature-flags/tools/seed.ts

@@ -5,12 +5,14 @@ import { Logger } from '../src/logger';
 import { Environment, FeatureFlag, FeatureFlagUser, Project, Segment } from '../src/models';
 import { getServer } from '../src/server';
 
-if (process.env.NODE_ENV !== 'development') {
-  throw 'Seeding only available in development environment';
-}
-
 async function seedDatabase() {
   const server = getServer({ openPlayground: false });
+
+  // NOTE: this has to be after we instantiate the server, because the server will actually load the environment variables from .env and set process.env.NODE_ENV
+  if (process.env.NODE_ENV !== 'development') {
+    throw 'Seeding only available in development environment';
+  }
+
   await server.start();
 
   let binding: Binding;

examples/8-performance/.env

@@ -1,3 +1,4 @@
+NODE_ENV=development
 WARTHOG_APP_HOST=localhost
 WARTHOG_APP_PORT=4100
 WARTHOG_DB_DATABASE=warthog-example-8

examples/8-performance/tools/seed.ts

@@ -5,15 +5,17 @@ import { Logger } from '../src/logger';
 import { User } from '../src/models';
 import { getServer } from '../src/server';
 
-if (process.env.NODE_ENV !== 'development') {
-  throw 'Seeding only available in development environment';
-}
-
 async function seedDatabase() {
   // Turn off logging to seed database
   process.env.WARTHOG_DB_LOGGING = 'none';
 
   const server = getServer({ introspection: true, openPlayground: false });
+
+  // NOTE: this has to be after we instantiate the server, because the server will actually load the environment variables from .env and set process.env.NODE_ENV
+  if (process.env.NODE_ENV !== 'development') {
+    throw 'Seeding only available in development environment';
+  }
+
   await server.start();
 
   let binding: Binding;

examples/9-production/.env.local

@@ -0,0 +1,2 @@
+WARTHOG_DB_PASSWORD=SUPER_SECRET_PASSWORD
+WARTHOG_FOO_BAR=BAZ

examples/9-production/tools/seed.ts

@@ -5,15 +5,17 @@ import { Logger } from '../src/logger';
 import { User } from '../src/models';
 import { getServer } from '../src/server';
 
-if (process.env.NODE_ENV !== 'development') {
-  throw 'Seeding only available in development environment';
-}
-
 async function seedDatabase() {
   // Turn off logging to seed database
   process.env.WARTHOG_DB_LOGGING = 'none';
 
   const server = getServer({ introspection: true, openPlayground: false });
+
+  // NOTE: this has to be after we instantiate the server, because the server will actually load the environment variables from .env and set process.env.NODE_ENV
+  if (process.env.NODE_ENV !== 'development' && process.env.WARTHOG_DB_OVERRIDE !== 'true') {
+    throw 'Seeding only available in development environment';
+  }
+
   await server.start();
 
   let binding: Binding;

src/cli/extensions/db-extension.ts

@@ -17,12 +17,9 @@ module.exports = (toolbox: GluegunToolbox) => {
 
   toolbox.db = {
     create: async function create(database: string) {
-      if (process.env.NODE_ENV !== 'development' && process.env.WARTHOG_DB_OVERRIDE !== 'true') {
-        return error(
-          'Cannot create database without setting WARTHOG_DB_OVERRIDE environment variable to `true`'
-        );
-      }
       const config = load();
+      validateNodeEnv(config['NODE_ENV'], toolbox, 'create');
+
       const createDb = util.promisify(pgtools.createdb) as Function;
 
       try {
@@ -36,12 +33,9 @@ module.exports = (toolbox: GluegunToolbox) => {
       info(`Database '${database}' created!`);
     },
     drop: async function drop() {
-      if (process.env.NODE_ENV !== 'development' && process.env.WARTHOG_DB_OVERRIDE !== 'true') {
-        return error(
-          'Cannot drop database without setting WARTHOG_DB_OVERRIDE environment variable to `true`'
-        );
-      }
       const config = load();
+      validateNodeEnv(config['NODE_ENV'], toolbox, 'drop, action: string');
+
       const database = config.get('DB_DATABASE');
       const dropDb = util.promisify(pgtools.dropdb) as Function;
 
@@ -132,3 +126,16 @@ async function getPgConfig(config: any) {
     port: config.get('DB_PORT')
   };
 }
+
+function validateNodeEnv(env: string, toolbox: Toolbox, action: string) {
+  if (!env) {
+    toolbox.print.error('NODE_ENV must be set');
+    process.exit(1);
+  }
+  if (env !== 'development' && process.env.WARTHOG_DB_OVERRIDE !== 'true') {
+    toolbox.print.error(
+      `Cannot ${action} database without setting WARTHOG_DB_OVERRIDE environment variable to 'true'`
+    );
+    process.exit(1);
+  }
+}

src/core/config.ts

@@ -49,33 +49,13 @@ export class Config {
   PROJECT_ROOT: string;
   container: Container;
   logger?: Logger;
+  NODE_ENV?: string;
 
   // The full config object
   config: any;
 
   constructor(private options: ConfigOptions = {}) {
     this.PROJECT_ROOT = process.cwd();
-    const dotenvPath = options.dotenvPath || process.cwd();
-
-    // Load .env.local file for super secrets
-    // With dotenv, the first time an entry ends up in process.env, it stays, so local items should take precedence
-    let file = path.join(dotenvPath, '.env.local');
-    // console.log('file', file);
-    if (fs.existsSync(file)) {
-      // console.log('1', this.warthogEnvVariables());
-      dotenv.config({ path: file });
-      // console.log('2', this.warthogEnvVariables());
-    }
-
-    // Load .env file
-    file = path.join(dotenvPath, '.env');
-    // console.log('file', file);
-    if (fs.existsSync(file)) {
-      // console.log('3', this.warthogEnvVariables());
-      dotenv.config({ path: file });
-      // console.log('4', this.warthogEnvVariables());
-    }
-
     this.container = options.container || Container;
     this.logger = options.logger;
 
@@ -111,11 +91,45 @@ export class Config {
       WARTHOG_DB_SYNCHRONIZE: 'true'
     };
 
+    const dotenvPath = options.dotenvPath || this.PROJECT_ROOT;
+    this.NODE_ENV = this.determineNodeEnv(dotenvPath);
+    this.loadDotenvFiles(dotenvPath);
+
     return this;
   }
 
+  // Allow NODE_ENV to be set in the .env file.  Check for this first here and then fall back on
+  // the environment variable.  The reason we do this is because using dotenvi will allow us to switch
+  // between environments.  If we require an actual environment variable to be set then we'll have to set
+  // and unset the value in the current terminal buffer.
+  determineNodeEnv(dotenvPath: string) {
+    let nodeEnv = process.env.NODE_ENV;
+
+    const filepath = path.join(dotenvPath, '.env');
+    if (fs.existsSync(filepath)) {
+      const config = dotenv.parse(fs.readFileSync(filepath));
+      if (config.NODE_ENV) {
+        nodeEnv = config.NODE_ENV;
+      }
+    }
+
+    return (this.NODE_ENV = process.env.NODE_ENV = nodeEnv);
+  }
+
+  loadDotenvFiles(dotenvPath: string) {
+    // .local files are for secrets, load those first
+    const files = [`.env.local.${this.NODE_ENV}`, '.env.local', '.env'];
+
+    files.forEach((filename: string) => {
+      const filepath = path.join(dotenvPath, filename);
+      if (fs.existsSync(filepath)) {
+        dotenv.config({ path: filepath });
+      }
+    });
+  }
+
   loadSync(): Config {
-    const devOptions = process.env.NODE_ENV === 'development' ? this.devDefaults : {};
+    const devOptions = this.NODE_ENV === 'development' ? this.devDefaults : {};
     const configFile = this.loadStaticConfigSync();
 
     // Config is loaded as a waterfall.  Items at the top of the object are overwritten by those below, so the order is:

src/core/server.ts

@@ -51,7 +51,6 @@ export class Server<C extends BaseContext> {
   config: Config;
   apolloConfig?: ApolloServerExpressConfig;
   authChecker?: AuthChecker<C>;
-  autoGenerateFiles: boolean;
   connection!: Connection;
   container: Container;
   graphQLServer!: ApolloServer;
@@ -64,10 +63,6 @@ export class Server<C extends BaseContext> {
     private appOptions: ServerOptions<C>,
     private dbOptions: Partial<ConnectionOptions> = {}
   ) {
-    if (!process.env.NODE_ENV) {
-      throw new Error("NODE_ENV must be set - use 'development' locally");
-    }
-
     if (typeof this.appOptions.host !== 'undefined') {
       process.env.WARTHOG_APP_HOST = this.appOptions.host;
       // When we move to v2.0 we'll officially deprecate these config values in favor of ENV vars
@@ -110,7 +105,9 @@ export class Server<C extends BaseContext> {
     // module to think they were set by the user
     this.config = new Config({ container: this.container, logger: this.logger }).loadSync();
 
-    this.autoGenerateFiles = this.config.get('AUTO_GENERATE_FILES') === 'true';
+    if (!process.env.NODE_ENV) {
+      throw new Error("NODE_ENV must be set - use 'development' locally");
+    }
   }
 
   getLogger(): Logger {
@@ -197,7 +194,7 @@ export class Server<C extends BaseContext> {
   async start() {
     debug('start:start');
     await this.establishDBConnection();
-    if (this.autoGenerateFiles) {
+    if (this.config.get('AUTO_GENERATE_FILES') === 'true') {
       await this.generateFiles();
     }
     await this.buildGraphQLSchema();

src/core/tests/dotenv-files/.env

@@ -0,0 +1,14 @@
+WARTHOG_ENV=111
+WARTHOG_A=ENV
+WARTHOG_B=ENV
+WARTHOG_C=ENV
+WARTHOG_D=ENV
+
+# required variables
+WARTHOG_APP_HOST=localhost
+WARTHOG_APP_PORT=4100
+WARTHOG_DB_DATABASE=warthog-example-1
+WARTHOG_DB_USERNAME=postgres
+WARTHOG_DB_PASSWORD=
+WARTHOG_DB_SYNCHRONIZE=true
+WARTHOG_DB_HOST=localhost

src/core/tests/dotenv-files/.env.local

@@ -0,0 +1,4 @@
+WARTHOG_ENV_LOCAL=222
+WARTHOG_B=ENV_LOCAL
+WARTHOG_C=ENV_LOCAL
+WARTHOG_D=ENV_LOCAL

src/core/tests/dotenv-files/.env.local.development

@@ -0,0 +1,3 @@
+WARTHOG_ENV_LOCAL_DEVELOPMENT=333
+WARTHOG_C=ENV_LOCAL_DEVELOPMENT
+WARTHOG_D=ENV_LOCAL_DEVELOPMENT

src/core/tests/dotenv-files/.env.local.production

@@ -0,0 +1,6 @@
+WARTHOG_ENV_LOCAL_PRODUCTION=444
+
+WARTHOG_D=ENV_LOCAL_PRODUCTION
+
+# Make sure we use the actual environment variable
+WARTHOG_PROPER_ENV_VARIABLE=ERROR

src/core/tests/dotenv-files/dotenv.test.ts

@@ -0,0 +1,21 @@
+import { Config } from '../../config';
+
+describe('Dotenv files', () => {
+  it('Pulls config in correct order', async () => {
+    process.env = {
+      NODE_ENV: 'development',
+      WARTHOG_PROPER_ENV_VARIABLE: '12345'
+    };
+
+    new Config({ dotenvPath: __dirname }).loadSync();
+
+    expect(process.env.WARTHOG_PROPER_ENV_VARIABLE).toEqual('12345');
+    expect(process.env.WARTHOG_ENV_LOCAL_DEVELOPMENT).toEqual('333');
+    expect(process.env.WARTHOG_C).toEqual('ENV_LOCAL_DEVELOPMENT');
+    expect(process.env.WARTHOG_D).toEqual('ENV_LOCAL_DEVELOPMENT');
+    expect(process.env.WARTHOG_ENV_LOCAL).toEqual('222');
+    expect(process.env.WARTHOG_B).toEqual('ENV_LOCAL');
+    expect(process.env.WARTHOG_ENV).toEqual('111');
+    expect(process.env.WARTHOG_A).toEqual('ENV');
+  });
+});