fix: normalize templates

Author: Wanderson Ferreira

shared-templates/shared-template-node-serverless/src/shared/Logger.ts

@@ -2,10 +2,7 @@ import { createLogger, format, transports } from 'winston';
 const { printf, colorize } = format;
 const colorizer = colorize();
 
-const timestampFormatter = () =>
-  new Date().toLocaleString('pt-BR', {
-    timeZone: 'America/Sao_Paulo',
-  });
+const timestampFormatter = () => new Date().toISOString();
 
 const consoleFormatter = printf(({ stack, level, message, label, timestamp }: { [key: string]: string }) => {
   const levelLabelColorized = colorizer.colorize(level, `${level}:${label}`);

tasks/test-e2e.sh

@@ -19,22 +19,32 @@ npm set registry "$localRegistryAddress"
 npm publish --tag e2e
 
 # Finally run a e2e test
-npx create-node-ms nsl -pn serverless-lambda-npm --noCommit --useNpm
-cd serverless-lambda-npm && npm run build
+sh -c "echo '🏃🏾‍♂️ serverless-lambda --useNpm'"
+npx create-node-ms serverless-lambda -pn serverless-lambda-npm --noCommit --useNpm
+cd serverless-lambda-npm && npm run test && npm run lint && npm run build
+sh -c "echo '✅ serverless-lambda --useNpm e2e done'"
 
-sh -c "echo '✅ node-serverless-lambda-npm e2e done'"
 cd ..
 
+sh -c "echo '🏃🏾‍♂️ serverless-express'"
 npx create-node-ms nse -pn serverless-express --noCommit
-cd serverless-express && yarn build
+cd serverless-express && yarn test && yarn lint && yarn build
+sh -c "echo '✅ serverless-express e2e done'"
 
-sh -c "echo '✅ node-serverless-express e2e done'"
 cd ..
 
-npx create-node-ms nsl -pn serverless-lambda --noCommit
-cd serverless-lambda && yarn build
+sh -c "echo '🏃🏾‍♂️ serverless-lambda'"
+npx create-node-ms serverless-lambda -pn serverless-lambda --noCommit
+cd serverless-lambda && yarn test && yarn lint && yarn build
+sh -c "echo '✅ serverless-lambda e2e done'"
+
+cd ..
+
+sh -c "echo '🏃🏾‍♂️ express'"
+npx create-node-ms express -pn express-server --noCommit
+cd express-server && yarn test && yarn lint && yarn build
+sh -c "echo '✅ express e2e done'"
 
-sh -c "echo '✅ node-serverless-lambda e2e done'"
 cd ..
 
 # Done!

templates/template-express/src/index.ts

@@ -1,4 +1,12 @@
 import 'reflect-metadata';
+import { AddressInfo } from 'net';
+import { logger } from '@shared/Logger';
 import server from '@server/index';
 
-server.listen(8080);
+const SERVICE_PORT = 3000;
+
+const serve = server.listen(SERVICE_PORT, () => {
+  const { address, port } = serve.address() as AddressInfo;
+
+  logger.info(`Server started on ${address}:${port}`);
+});

templates/template-express/src/mocks/ReturnHelper.ts

@@ -0,0 +1,19 @@
+import { AxiosError, AxiosResponse } from 'axios';
+import HttpResponse from '@shared/responses/HttpResponse';
+
+export default class ReturnHelper {
+  static CaseResponse<T>(status: number, data: T, success = true): Promise<HttpResponse<T>> {
+    return Promise.resolve({ body: data, statusCode: status, success });
+  }
+  static HttpSuccess<T>(status: number, data?: T, headers = null): Promise<AxiosResponse<T>> {
+    return Promise.resolve({ data, status, headers, config: null, statusText: null });
+  }
+
+  static HttpError<T>(status: number, data?: T): Promise<AxiosError<T>> {
+    return Promise.reject({ response: { data, status, headers: null, config: null, statusText: null } });
+  }
+
+  static Clone<T>(obj: T): T {
+    return JSON.parse(JSON.stringify(obj)) as T;
+  }
+}

templates/template-express/src/mocks/TestContainer.ts

@@ -0,0 +1,37 @@
+import 'reflect-metadata';
+import { Container } from 'inversify';
+import { Newable } from '@shared/types';
+import { RequestRouter, UseCase } from '@shared/contracts';
+import AxiosHttpHandle from '@infra/http/AxiosHttpHandler';
+
+export default class TestContainer<T = UseCase | RequestRouter> {
+  private _ref: Newable<T>;
+  private _container: Container;
+
+  constructor(obj: Newable<T>) {
+    const container = new Container({});
+    container.bind(AxiosHttpHandle).toSelf();
+    container.bind(obj).toSelf();
+    this._ref = obj;
+    this._container = container;
+  }
+
+  get() {
+    return this._container.get<T>(this._ref);
+  }
+
+  add<TT = UseCase | RequestRouter>(obj: Newable<TT>) {
+    this._container.bind(obj).toSelf();
+    return this;
+  }
+
+  addDynamicValue<TT>(obj: Newable<TT>) {
+    this._container.bind(obj).toDynamicValue(() => new obj());
+    return this;
+  }
+
+  addDynamicValueWithAlias<TT>(alias: string, obj: Newable<TT>) {
+    this._container.bind<TT>(alias).toDynamicValue(() => new obj());
+    return this;
+  }
+}

templates/template-express/src/modules/RandomNumber/GenerateRandomNumber/GenerateRandomNumberCase.spec.ts

@@ -0,0 +1,24 @@
+import 'reflect-metadata';
+import { expect } from 'chai';
+import GenerateRandomNumberCase from '@modules/RandomNumber/GenerateRandomNumber/GenerateRandomNumberCase';
+import TestContainer from '@mocks/TestContainer';
+import container from '@infra/container/inversify.config';
+
+describe('GenerateRandomNumberCase', () => {
+  beforeEach(() => {
+    // create a snapshot so each unit test can modify
+    // it without breaking other unit tests
+    container.snapshot();
+  });
+
+  afterEach(() => {
+    // Restore to last snapshot so each unit test
+    // takes a clean copy of the application container
+    container.restore();
+  });
+
+  it('Should get a random number between 1 and 10', async () => {
+    const result = await new TestContainer(GenerateRandomNumberCase).get().execute({});
+    expect(result.body.number).to.be.within(1, 10);
+  });
+});

templates/template-express/src/modules/RandomNumber/GenerateRandomNumber/GenerateRandomNumberCase.ts

@@ -0,0 +1,14 @@
+import { HttpRequestParams, UseCase } from '@shared/contracts';
+import { OK } from 'http-status';
+import { provide } from 'inversify-binding-decorators';
+import ExceptionHandler from '@shared/decorators/ExceptionHandler';
+import HttpResponse from '@shared/responses/HttpResponse';
+
+@provide(GenerateRandomNumberCase)
+export default class GenerateRandomNumberCase implements UseCase {
+  @ExceptionHandler
+  async execute({ headers }: HttpRequestParams<any>) {
+    const number = Math.floor(Math.random() * (10 - 1 + 1)) + 1;
+    return HttpResponse.success({ status: OK, body: { number } });
+  }
+}

templates/template-express/src/modules/RandomNumber/GenerateRandomNumber/GenerateRandomNumberRouter.ts

@@ -0,0 +1,13 @@
+import { HttpRequestParams, RequestRouter } from '@shared/contracts';
+import { inject } from 'inversify';
+import { provide } from 'inversify-binding-decorators';
+import GenerateRandomNumberCase from '@modules/RandomNumber/GenerateRandomNumber/GenerateRandomNumberCase';
+
+@provide(GenerateRandomNumberRouter)
+export default class GenerateRandomNumberRouter implements RequestRouter {
+  @inject(GenerateRandomNumberCase) private case: GenerateRandomNumberCase;
+
+  async route({ headers }: HttpRequestParams<any>) {
+    return await this.case.execute({ headers });
+  }
+}

templates/template-express/src/modules/RandomNumber/RandomNumberRoutes.ts

@@ -0,0 +1,6 @@
+import GenerateRandomNumberRouter from '@modules/RandomNumber/GenerateRandomNumber/GenerateRandomNumberRouter';
+import RoutesBuilder from '@utils/RoutesBuilder';
+
+const RandomNumberRoutes = new RoutesBuilder().get('/', GenerateRandomNumberRouter).build();
+
+export default RandomNumberRoutes;

templates/template-express/src/modules/Routes.ts

@@ -0,0 +1,8 @@
+import { Router } from 'express';
+import RandomNumberRoutes from '@modules/RandomNumber/RandomNumberRoutes';
+
+const V1Routes = Router();
+
+V1Routes.use('/random-number', RandomNumberRoutes);
+
+export default V1Routes;