Merge pull request #95 from w3tecch/feature/uniform_env_vars

Feature/uniform env vars

Author: Gery Hirschfeld

.env.example

@@ -23,14 +23,27 @@ AUTH_ROUTE=http://localhost:3333/tokeninfo
 #
 # DATABASE
 #
-DB_TYPE=mysql
-DB_HOST=localhost
-DB_PORT=3306
-DB_USERNAME=root
-DB_PASSWORD=
-DB_DATABASE=my_database
-DB_SYNCHRONIZE=false
-DB_LOGGING=false
+TYPEORM_CONNECTION=mysql
+TYPEORM_HOST=localhost
+TYPEORM_PORT=3306
+TYPEORM_USERNAME=root
+TYPEORM_PASSWORD=
+TYPEORM_DATABASE=my_database
+TYPEORM_SYNCHRONIZE=false
+TYPEORM_LOGGING=false
+
+#
+# Additional settings (optional as defaults are in env.ts)
+#
+# TYPEORM_MIGRATIONS=
+# TYPEORM_MIGRATIONS_DIR=
+# TYPEORM_ENTITIES=
+# TYPEORM_SUBSCRIBERS=
+# CONTROLLERS=
+# MIDDLEWARES=
+# INTERCEPTORS=
+# QUERIES=
+# MUTATIONS=
 
 #
 # GraphQL

.env.test

@@ -23,9 +23,9 @@ AUTH_ROUTE=http://localhost:3333/tokeninfo
 #
 # DATABASE
 #
-DB_TYPE=sqlite
-DB_DATABASE=./mydb.sql
-DB_LOGGING=false
+TYPEORM_CONNECTION=sqlite
+TYPEORM_DATABASE=./mydb.sql
+TYPEORM_LOGGING=false
 
 #
 # GraphQL

src/env.ts

@@ -2,7 +2,7 @@ import * as dotenv from 'dotenv';
 import * as path from 'path';
 
 import * as pkg from '../package.json';
-import { getOsEnv, normalizePort, toBool, toNumber } from './lib/env';
+import { getOsEnv, getOsEnvArray, normalizePort, toBool, toNumber } from './lib/env';
 
 /**
  * Load .env file or for tests the .env.test file.
@@ -27,15 +27,39 @@ export const env = {
         port: normalizePort(process.env.PORT || getOsEnv('APP_PORT')),
         banner: toBool(getOsEnv('APP_BANNER')),
         dirs: {
-            migrations: [path.relative(path.join(process.cwd()), path.join(__dirname, 'database/migrations/**/*.ts'))],
-            migrationsDir: path.relative(path.join(process.cwd()), path.join(__dirname, 'database/migrations')),
-            entities: [path.relative(path.join(process.cwd()), path.join(__dirname, 'api/models/**/*{.js,.ts}'))],
-            subscribers: [path.join(__dirname, 'api/subscribers/**/*Subscriber{.js,.ts}')],
-            controllers: [path.join(__dirname, 'api/controllers/**/*Controller{.js,.ts}')],
-            middlewares: [path.join(__dirname, 'api/middlewares/**/*Middleware{.js,.ts}')],
-            interceptors: [path.join(__dirname, 'api/interceptors/**/*Interceptor{.js,.ts}')],
-            queries: [path.join(__dirname, 'api/queries/**/*Query{.js,.ts}')],
-            mutations: [path.join(__dirname, 'api/mutations/**/*Mutation{.js,.ts}')],
+            migrations: (
+                getOsEnvArray('TYPEORM_MIGRATIONS') ||
+                [path.relative(path.join(process.cwd()), path.join(__dirname, 'database/migrations/**/*.ts'))]
+            ) as string[],
+            migrationsDir: getOsEnv('TYPEORM_MIGRATIONS_DIR') || path.relative(path.join(process.cwd()), path.join(__dirname, 'database/migrations')),
+            entities: (
+                getOsEnvArray('TYPEORM_ENTITIES') ||
+                [path.relative(path.join(process.cwd()), path.join(__dirname, 'api/models/**/*{.js,.ts}'))]
+            ) as string[],
+            subscribers: (
+                getOsEnvArray('TYPEORM_SUBSCRIBERS') ||
+                [path.join(__dirname, 'api/subscribers/**/*Subscriber{.js,.ts}')]
+            ) as string[],
+            controllers: (
+                getOsEnvArray('CONTROLLERS') ||
+                [path.join(__dirname, 'api/controllers/**/*Controller{.js,.ts}')]
+            ) as string[],
+            middlewares: (
+                getOsEnvArray('MIDDLEWARES') ||
+                [path.join(__dirname, 'api/middlewares/**/*Middleware{.js,.ts}')]
+            ) as string[],
+            interceptors: (
+                getOsEnvArray('INTERCEPTORS') ||
+                [path.join(__dirname, 'api/interceptors/**/*Interceptor{.js,.ts}')]
+            ) as string[],
+            queries: (
+                getOsEnvArray('QUERIES') ||
+                [path.join(__dirname, 'api/queries/**/*Query{.js,.ts}')]
+            ) as string[],
+            mutations: (
+                getOsEnvArray('MUTATIONS') ||
+                [path.join(__dirname, 'api/mutations/**/*Mutation{.js,.ts}')]
+            ) as string[],
         },
     },
     log: {
@@ -47,14 +71,14 @@ export const env = {
         route: getOsEnv('AUTH_ROUTE'),
     },
     db: {
-        type: getOsEnv('DB_TYPE'),
-        host: getOsEnv('DB_HOST'),
-        port: toNumber(getOsEnv('DB_PORT')),
-        username: getOsEnv('DB_USERNAME'),
-        password: getOsEnv('DB_PASSWORD'),
-        database: getOsEnv('DB_DATABASE'),
-        synchronize: toBool(getOsEnv('DB_SYNCHRONIZE')),
-        logging: toBool(getOsEnv('DB_LOGGING')),
+        type: getOsEnv('TYPEORM_CONNECTION'),
+        host: getOsEnv('TYPEORM_HOST'),
+        port: toNumber(getOsEnv('TYPEORM_PORT')),
+        username: getOsEnv('TYPEORM_USERNAME'),
+        password: getOsEnv('TYPEORM_PASSWORD'),
+        database: getOsEnv('TYPEORM_DATABASE'),
+        synchronize: toBool(getOsEnv('TYPEORM_SYNCHRONIZE')),
+        logging: toBool(getOsEnv('TYPEORM_LOGGING')),
     },
     graphql: {
         enabled: toBool(getOsEnv('GRAPHQL_ENABLED')),

src/lib/env/utils.ts

@@ -2,6 +2,10 @@ export function getOsEnv(key: string): string {
     return process.env[key] as string;
 }
 
+export function getOsEnvArray(key: string, delimiter: string = ','): string[] | boolean {
+    return process.env[key] && process.env[key].split(delimiter) || false;
+}
+
 export function toNumber(value: string): number {
     return parseInt(value, 10);
 }

src/loaders/typeormLoader.ts

@@ -1,11 +1,13 @@
 import { MicroframeworkLoader, MicroframeworkSettings } from 'microframework-w3tec';
-import { createConnection } from 'typeorm';
+import { createConnection, getConnectionOptions } from 'typeorm';
 
 import { env } from '../env';
 
 export const typeormLoader: MicroframeworkLoader = async (settings: MicroframeworkSettings | undefined) => {
 
-    const connection = await createConnection({
+    const loadedConnectionOptions = await getConnectionOptions();
+
+    const connectionOptions = Object.assign(loadedConnectionOptions, {
         type: env.db.type as any, // See createConnection options for valid types
         host: env.db.host,
         port: env.db.port,
@@ -18,6 +20,8 @@ export const typeormLoader: MicroframeworkLoader = async (settings: Microframewo
         migrations: env.app.dirs.migrations,
     });
 
+    const connection = await createConnection(connectionOptions);
+
     if (settings) {
         settings.setData('connection', connection);
         settings.onShutdown(() => connection.close());