Merge pull request #29 from NodeFactoryIo/mpetrunic/env

Use fastify-env for env validation and casting

Author: mpetrunic

Diff for: docker-compose.e2e.yml

@@ -5,7 +5,7 @@ services:
     build:
       context: .
       target: dev
-    command: sh -c "yarn run test:e2e"
+    command: sh -c "sleep 5 && yarn run test:e2e"
     image: nodefactory/nodejs-ts-starter:${IMAGE_TAG:-latest}
     container_name: "${BACKEND_CONTAINER_NAME:-nodejs-backend}"
     depends_on:

Diff for: src/App.ts

@@ -20,18 +20,28 @@ export class App {
 
   public readonly instance: FastifyInstance;
 
-  constructor() {
-    this.instance = fastify({
+  protected constructor(instance: FastifyInstance) {
+    this.instance = instance;
+  }
+
+  /**
+   * Initializes fastify, env variables and register routes.
+   * Rest of plugins, db and port bind are initialized on start method.
+   */
+  public static async init(): Promise<App> {
+    const instance = fastify({
       logger: fastifyLogger,
       return503OnClosing: true
     });
-    this.registerPlugins();
+    const app = new App(instance);
+    await app.registerPlugins();
+    return app;
   }
 
   public async start(): Promise<void> {
     try {
-      await this.initDb();
 
+      await this.initDb();
       await this.instance.ready();
       logger.info(this.instance.printRoutes());
       return new Promise((resolve, reject) => {
@@ -72,13 +82,14 @@ export class App {
     await this.instance.db.runMigrations({transaction: "all"});
   }
 
-  private registerPlugins(): void {
+  private async registerPlugins(): Promise<void> {
     this.instance.register(fastifyEnv, envPluginConfig);
+    await this.instance.after();
     this.instance.register(fastifyCompress, {global: true, encodings: ["gzip", "deflate"]});
-    this.instance.register(fastifyCors, {origin: process.env.CORS_ORIGIN || true});
+    this.instance.register(fastifyCors, {origin: this.instance.config.CORS_ORIGIN});
     this.instance.register(fastifyFormBody);
     this.instance.register(fastifyHelmet);
-    this.instance.register(fastifyRateLimit, {max: parseInt(process.env.MAX_REQ_PER_MIN || "100"), timeWindow: '1 minute'});
+    this.instance.register(fastifyRateLimit, {max: this.instance.config.MAX_REQ_PER_MIN, timeWindow: '1 minute'});
     this.instance.register(fastifySensible);
     this.instance.register(fastifySwagger, SWAGGER_CONFIG);
     this.instance.register(fastifyHealthCheck, {
@@ -91,10 +102,12 @@ export class App {
         }
       }
     });
-    this.instance.register(fastifyMetrics, {
-      blacklist: '/metrics',
-      enableDefaultMetrics: true
-    });
+    if(this.instance.config.NODE_ENV !== "test") {
+      this.instance.register(fastifyMetrics, {
+        blacklist: '/metrics',
+        enableDefaultMetrics: true
+      });
+    }
     this.instance.register(routesPlugin);
   }
 }

Diff for: src/config/index.ts

@@ -5,6 +5,10 @@ export const config: fasitfyEnvOpt = {
   schema: {
     type: "object",
     properties: {
+      NODE_ENV: {
+        type: 'string',
+        default: 'prod'
+      },
       SERVER_ADDRESS: {
         type: 'string',
         default: '0.0.0.0'
@@ -13,6 +17,14 @@ export const config: fasitfyEnvOpt = {
         type: 'number',
         default: 3000
       },
+      CORS_ORIGIN: {
+        type: 'string',
+        default: "*"
+      },
+      MAX_REQ_PER_MIN: {
+        type: 'number',
+        default: 100
+      },
     }
   },
   env: true
@@ -21,8 +33,11 @@ export const config: fasitfyEnvOpt = {
 declare module 'fastify' {
   interface FastifyInstance {
     config: { 
+      NODE_ENV: string | "test" | "prod";
       SERVER_ADDRESS: string;
       SERVER_PORT: number;
+      CORS_ORIGIN: string;
+      MAX_REQ_PER_MIN: number;
     };
   }
 }

Diff for: src/index.ts

@@ -1,12 +1,14 @@
 import {App} from "./App";
 import nodeCleanup from "node-cleanup";
 
-const app = new App();
+App.init().then((app) => {
+  nodeCleanup(function (exitCode, signal) {
+    app.stop(signal as string);
+    nodeCleanup.uninstall();
+    return false;
+  });
+  
+  app.start();
+})
 
-nodeCleanup(function (exitCode, signal) {
-  app.stop(signal as string);
-  nodeCleanup.uninstall();
-  return false;
-});
 
-app.start();

Diff for: test/e2e/app-setup.ts

@@ -1,10 +1,14 @@
 import {App} from "../../src/App";
-export const app = new App();
+
+let instance: App;
+
+export const app = (): App => instance;
 
 before(async () => {
-  await app.start();
+  instance = await App.init();
+  await instance.start();
 });
 
 after(async () => {
-  await app.stop("TEST");
+  await instance.stop("TEST");
 });

Diff for: test/e2e/sample.spec.ts

@@ -13,7 +13,7 @@ describe("Sample e2e test", function () {
   });
 
   it("Should successfully query database", async function () {
-    const res = await app.instance.inject({
+    const res = await app().instance.inject({
       method: "GET",
       path: "/samples",
     });

Diff for: test/unit/controllers/sample.spec.ts

@@ -13,9 +13,9 @@ describe("sample controller", function () {
   let app: App;
   let sampleRepositoryStub: SinonStubbedInstance<SampleRepository>;
 
-  beforeEach(function () {
+  beforeEach(async function () {
     logger.silent = true;
-    app = new App();
+    app = await App.init();
     sampleRepositoryStub = sinon.createStubInstance(SampleRepository);
     app.instance.decorate("db", {
       getCustomRepository: () =>  sampleRepositoryStub
@@ -24,7 +24,6 @@ describe("sample controller", function () {
 
   afterEach(async function () {
     logger.silent = false;
-    app.instance.metrics.client.register.clear();
   });
 
   it("get samples", async function () {