refactor: application start up (#986)

src/app.ts → src/Frost.ts

@@ -2,7 +2,8 @@ import { getVerifiableClaimSigner } from '@po.et/poet-js'
 import { MongoClient } from 'mongodb'
 import * as Pino from 'pino'
 
-import { API } from './api/API'
+import { RestServer } from './api/RestServer'
+import { Router } from './api/Router'
 import { Configuration } from './configuration'
 import { AccountController } from './controllers/AccountController'
 import { ArchiveController } from './controllers/ArchiveController'
@@ -15,11 +16,7 @@ import { loggingConfigurationToPinoConfiguration } from './utils/Logging/Logging
 import { SendEmail } from './utils/SendEmail'
 import { Vault } from './utils/Vault/Vault'
 
-import './extensions/Error'
-
-require('dotenv').config({ path: '.env' })
-
-export async function app(localVars: any = {}) {
+export async function Frost(localVars: any = {}) {
   const configuration: Configuration = loadConfigurationWithDefaults(localVars)
   const logger = Pino(loggingConfigurationToPinoConfiguration(configuration))
 
@@ -41,14 +38,29 @@ export async function app(localVars: any = {}) {
       logger.error(e, 'Error with Vault')
     }
 
-  const configurationFrostAPI = configurationToFrostAPI(configuration)
-
   const mongoClient = await MongoClient.connect(configuration.mongodbUrl)
   const dbConnection = await mongoClient.db()
   const accountCollection = dbConnection.collection('accounts')
   const accountDao = AccountDao(accountCollection)
 
-  const sendEmail = SendEmail(configurationFrostAPI.sendEmail)
+  const sendEmail = SendEmail({
+    nodemailer: {
+      mandrill: {
+        apiKey: configuration.transactionalMandrill,
+      },
+      maildev: {
+        host: configuration.maildevPortTcpAddr,
+        port: configuration.maildevPortTcpPort,
+        ignoreTLS: configuration.maildevIgnoreTLS,
+      },
+      sendEmailDisabled: configuration.sendEmailDisabled,
+      emailTransportMailDev: configuration.emailTransportMailDev,
+    },
+    emailFrom: configuration.emailFrom,
+    emailReply: configuration.emailReply,
+    frostChangePassword: configuration.frostChangePassword,
+    frostVerifiedAccount: configuration.frostVerifiedAccount,
+  })
 
   const mainnetNode = PoetNode(configuration.poetUrl)
   const testnetNode = PoetNode(configuration.testPoetUrl)
@@ -90,57 +102,48 @@ export async function app(localVars: any = {}) {
     },
   })
 
-  const frostAPI = await API(accountController, archiveController, workController)(configurationFrostAPI).start()
+  const router = Router({
+    configuration: {
+      passwordComplexity: {
+        min: configuration.passwordComplexMin,
+        max: configuration.passwordComplexMax,
+        lowerCase: configuration.passwordComplexLowerCase,
+        upperCase: configuration.passwordComplexUpperCase,
+        numeric: configuration.passwordComplexNumeric,
+        symbol: configuration.passwordComplexSymbol,
+      },
+      maxApiTokens: configuration.maxApiTokens,
+    },
+    dependencies: {
+      accountController,
+      archiveController,
+      workController,
+    },
+  })
+
+  const restServer = await RestServer({
+    configuration: {
+      host: configuration.frostHost,
+      port: configuration.frostPort,
+      maxApiRequestLimitForm: configuration.maxApiRequestLimitForm,
+      maxApiRequestLimitJson: configuration.maxApiRequestLimitJson,
+      loggingConfiguration: {
+        loggingLevel: configuration.loggingLevel,
+        loggingPretty: configuration.loggingPretty,
+      },
+    },
+    dependencies: {
+      router,
+    },
+  })
 
   await accountDao.createIndices()
 
   return {
     stop: async () => {
-      await frostAPI.stop()
+      await restServer.stop()
       await mongoClient.close()
       return true
     },
   }
 }
-
-const configurationToFrostAPI = (configuration: Configuration) => ({
-  host: configuration.frostHost,
-  port: configuration.frostPort,
-  maxApiRequestLimitForm: configuration.maxApiRequestLimitForm,
-  maxApiRequestLimitJson: configuration.maxApiRequestLimitJson,
-  passwordComplex: {
-    min: configuration.passwordComplexMin,
-    max: configuration.passwordComplexMax,
-    lowerCase: configuration.passwordComplexLowerCase,
-    upperCase: configuration.passwordComplexUpperCase,
-    numeric: configuration.passwordComplexNumeric,
-    symbol: configuration.passwordComplexSymbol,
-  },
-  sendEmail: {
-    nodemailer: {
-      mandrill: {
-        apiKey: configuration.transactionalMandrill,
-      },
-      maildev: {
-        host: configuration.maildevPortTcpAddr,
-        port: configuration.maildevPortTcpPort,
-        ignoreTLS: configuration.maildevIgnoreTLS,
-      },
-      sendEmailDisabled: configuration.sendEmailDisabled,
-      emailTransportMailDev: configuration.emailTransportMailDev,
-    },
-    emailFrom: configuration.emailFrom,
-    emailReply: configuration.emailReply,
-    frostChangePassword: configuration.frostChangePassword,
-    frostVerifiedAccount: configuration.frostVerifiedAccount,
-  },
-  poetUrl: configuration.poetUrl,
-  testPoetUrl: configuration.testPoetUrl,
-  maxApiTokens: configuration.maxApiTokens,
-  verifiedAccount: configuration.verifiedAccount,
-  pwnedCheckerRoot: configuration.pwnedCheckerRoot,
-  loggingConfiguration: {
-    loggingLevel: configuration.loggingLevel,
-    loggingPretty: configuration.loggingPretty,
-  },
-})

src/api/PasswordComplexConfiguration.ts → src/api/PasswordComplexityConfiguration.ts

@@ -1,4 +1,4 @@
-export interface PasswordComplexConfiguration {
+export interface PasswordComplexityConfiguration {
   readonly min: number
   readonly max: number
   readonly lowerCase: number

src/api/RestServer.ts

@@ -0,0 +1,92 @@
+import * as Koa from 'koa'
+import * as bodyParser from 'koa-bodyparser'
+import * as helmet from 'koa-helmet'
+import * as KoaRouter from 'koa-router'
+import * as cors from 'koa2-cors'
+
+import { securityHeaders } from '../securityHeaders'
+import { createModuleLogger, LoggingConfiguration } from '../utils/Logging/Logging'
+
+import { errorHandling } from '../middlewares/errorHandling'
+import { logger } from '../middlewares/logger'
+
+interface Configuration {
+  readonly host: string
+  readonly port: number
+  readonly maxApiRequestLimitForm: string
+  readonly maxApiRequestLimitJson: string
+  readonly loggingConfiguration: LoggingConfiguration
+}
+
+interface Dependencies {
+  readonly router: KoaRouter
+}
+
+interface Arguments {
+  readonly configuration: Configuration
+  readonly dependencies: Dependencies
+}
+
+interface APIMethods {
+  readonly stop: () => Promise<void>
+}
+
+export const RestServer = async ({
+  configuration: {
+    port,
+    host,
+    maxApiRequestLimitForm,
+    maxApiRequestLimitJson,
+    loggingConfiguration,
+  },
+  dependencies: {
+    router,
+  },
+}: Arguments): Promise<APIMethods> => {
+  const logger = createModuleLogger(loggingConfiguration)(__dirname)
+
+  const koa = ConfiguredKoa({
+    maxApiRequestLimitForm,
+    maxApiRequestLimitJson,
+    loggingConfiguration,
+  })
+
+  koa
+    .use(router.routes())
+    .use(router.allowedMethods())
+
+  logger.info('Starting HTTP Server...')
+  const server = await koa.listen(port, host)
+  logger.info('Started HTTP Server.')
+
+  const stop = async () => {
+    logger.info('Stopping HTTP Server...')
+    await server.close()
+    logger.info('Stopped HTTP Server.')
+  }
+
+  return {
+    stop,
+  }
+}
+
+const ConfiguredKoa = ({
+  maxApiRequestLimitForm,
+  maxApiRequestLimitJson,
+  loggingConfiguration,
+}: Partial<Configuration>) =>
+  new Koa()
+    .use(errorHandling())
+    .use(logger(createModuleLogger(loggingConfiguration)))
+    .use(helmet(securityHeaders))
+    .use(
+      cors({
+        origin: (ctx: any, next: any) => '*',
+      }),
+    )
+    .use(
+      bodyParser({
+        formLimit: maxApiRequestLimitForm,
+        jsonLimit: maxApiRequestLimitJson,
+      }),
+    )