✨ [DEV-29] DB 비활성화 옵션 추가

Author: BlizzardBlue

.env.example

@@ -24,6 +24,7 @@ AWS_REGION=ap-northeast-2
 #
 # PostgreSQL DATABASE
 #
+#TYPEORM_ENABLED=true
 #TYPEORM_CONNECTION=postgres
 #TYPEORM_HOST=localhost
 #TYPEORM_PORT=5432
@@ -37,6 +38,7 @@ AWS_REGION=ap-northeast-2
 #
 # MySQL DATABASE
 #
+TYPEORM_ENABLED=true
 TYPEORM_CONNECTION=mysql
 TYPEORM_HOST=localhost
 TYPEORM_PORT=3306

.env.test

@@ -24,6 +24,7 @@ AWS_REGION=ap-northeast-2
 #
 # DATABASE
 #
+TYPEORM_ENABLED=true
 TYPEORM_CONNECTION=sqlite
 TYPEORM_DATABASE=./mydb.sql
 TYPEORM_LOGGING=error

src/env.ts

@@ -51,6 +51,7 @@ export const env = {
     output: getOsEnv('LOG_OUTPUT'),
   },
   db: {
+    enabled: toBool(getOsEnv('TYPEORM_ENABLED')),
     type: getOsEnv('TYPEORM_CONNECTION'),
     host: getOsEnvOptional('TYPEORM_HOST'),
     port: toNumber(getOsEnvOptional('TYPEORM_PORT')),

src/loaders/expressLoader.ts

@@ -5,16 +5,11 @@ import { createExpressServer } from 'routing-controllers';
 import { authorizationChecker } from '../auth/authorizationChecker';
 import { currentUserChecker } from '../auth/currentUserChecker';
 import { env } from '../env';
+import { RoutingControllersOptions } from 'routing-controllers/RoutingControllersOptions';
 
 export const expressLoader: MicroframeworkLoader = (settings: MicroframeworkSettings | undefined) => {
   if (settings) {
-    const connection = settings.getData('connection');
-
-    /**
-     * We create a new express server instance.
-     * We could have also use useExpressServer here to attach controllers to an existing express instance.
-     */
-    const expressApp: Application = createExpressServer({
+    const expressOptions: RoutingControllersOptions = {
       cors: true,
       classTransformer: true,
       routePrefix: env.app.routePrefix,
@@ -27,12 +22,37 @@ export const expressLoader: MicroframeworkLoader = (settings: MicroframeworkSett
       middlewares: env.app.dirs.middlewares,
       interceptors: env.app.dirs.interceptors,
 
+      /**
+       * class-validator를 활용한 Request Payload 타입 검증
+       */
+      validation: true,
+
+      // TODO: DB를 사용 안하게 하더라도 Authorization 기능은 쓸 수 있게 개선
+      // /**
+      //  * Authorization features
+      //  */
+      // authorizationChecker: authorizationChecker(),
+      // currentUserChecker: currentUserChecker(),
+    };
+
+    // DB 사용할 경우
+    if (env.db.enabled) {
+      /**
+       * TypeOrm connection
+       */
+      const connection = settings.getData('connection');
       /**
        * Authorization features
        */
-      authorizationChecker: authorizationChecker(connection),
-      currentUserChecker: currentUserChecker(connection),
-    });
+      expressOptions.authorizationChecker = authorizationChecker(connection);
+      expressOptions.currentUserChecker = currentUserChecker(connection);
+    }
+
+    /**
+     * We create a new express server instance.
+     * We could have also use useExpressServer here to attach controllers to an existing express instance.
+     */
+    const expressApp: Application = createExpressServer(expressOptions);
 
     // Run application to listen on given port
     if (!env.isTest) {

src/loaders/typeormLoader.ts

@@ -4,26 +4,27 @@ import { createConnection, getConnectionOptions } from 'typeorm';
 import { env } from '../env';
 
 export const typeormLoader: MicroframeworkLoader = async (settings: MicroframeworkSettings | undefined) => {
+  if (env.db.enabled) {
+    const loadedConnectionOptions = await getConnectionOptions();
 
-  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,
+      username: env.db.username,
+      password: env.db.password,
+      database: env.db.database,
+      synchronize: env.db.synchronize,
+      logging: env.db.logging,
+      entities: env.app.dirs.entities,
+      migrations: env.app.dirs.migrations,
+    });
 
-  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,
-    username: env.db.username,
-    password: env.db.password,
-    database: env.db.database,
-    synchronize: env.db.synchronize,
-    logging: env.db.logging,
-    entities: env.app.dirs.entities,
-    migrations: env.app.dirs.migrations,
-  });
+    const connection = await createConnection(connectionOptions);
 
-  const connection = await createConnection(connectionOptions);
-
-  if (settings) {
-    settings.setData('connection', connection);
-    settings.onShutdown(() => connection.close());
+    if (settings) {
+      settings.setData('connection', connection);
+      settings.onShutdown(() => connection.close());
+    }
   }
 };