Replace HapiJs with NestJs as API framework

Change-Id: I54dc6c5f6377358e4f6614378fbb253b0c7841a9

create.js

@@ -30,7 +30,7 @@ if (!fs.existsSync(uiDir)) {
 
 // copy folder content
 try {
-	fs.cpSync(`${rootDir}/source/shared/`, contextDir, {
+	fs.cpSync(`${rootDir}/source/__/`, contextDir, {
 		force: true,
 		recursive: true,
 	});

source/__/package.json

@@ -4,7 +4,9 @@
 	"author": "Roman Jaroš",
 	"license": "ISC",
 	"scripts": {
-		"dev": "pnpm -r dev"
+		"dev": "pnpm -r dev",
+		"test": "pnpm -r test",
+		"test:e2e": "pnpm -r test:e2e"
 	},
 	"dependencies": {},
 	"devDependencies": {

source/api/.tsconfig.json

@@ -1,42 +1,9 @@
 {
-    "extends": "../../tsconfig.json",
+  "extends": "../../tsconfig.json",
-    "compilerOptions": {
+  "compilerOptions": {
-        "moduleResolution": "node",
+    "module": "commonjs",
-        "strict": false,
+    "target": "es2017",
-        "outDir": "dist",
+    "outDir": "./dist",
-        "rootDir": "./",
+    "baseUrl": "./"
-        "baseUrl": "./",
+  }
-        "resolveJsonModule": true,
-        "paths": {
-            "config/*": [
-                "./src/config/*"
-            ],
-            "database/*": [
-                "./src/database/*"
-            ],
-            "model/*": [
-                "./src/model/*"
-            ],
-            "controllers/*": [
-                "./src/controllers/*"
-            ],
-            "utils/*": [
-                "./src/utils/*"
-            ],
-            "types/*": [
-                "./src/types/*"
-            ],
-            "plugins/*": [
-                "./src/plugins/*"
-            ]
-        }
-    },
-    "include": [
-        "./**/*.ts",
-        "./**/*.tsx",
-        "./src/**/*.json"
-    ],
-    "exclude": [
-        "node_modules"
-    ]
 }

source/api/jest.config.js

@@ -0,0 +1,15 @@
+/** @type {import('jest').Config} */
+
+const config = {
+  moduleFileExtensions: ['js', 'json', 'ts'],
+  rootDir: 'src',
+  testRegex: '.*\\.spec\\.ts$',
+  transform: {
+    '^.+\\.(t|j)s$': 'ts-jest',
+  },
+  collectCoverageFrom: ['**/*.(t|j)s'],
+  coverageDirectory: '../coverage',
+  testEnvironment: 'node',
+};
+
+module.exports = config;

source/api/nest-cli.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true,
+    "plugins": [
+      {
+        "name": "@nestjs/swagger/plugin",
+        "options": {
+          "introspectComments": true
+        }
+      }
+    ]
+  }
+}

source/api/nodemon.json

@@ -1,5 +0,0 @@
-{
-    "ignore": [
-        "README"
-    ]
-}

source/api/package.json

@@ -1,38 +1,59 @@
 {
-    "name": "$(appName)-api",
+  "name": "$(appName)-api",
-    "version": "0.1.0",
+  "version": "0.1.0",
-    "description": "",
+  "description": "",
-    "author": "Roman Jaroš <hello@romanjaros.dev>",
+  "author": "Roman Jaroš <hello@romanjaros.dev>",
-    "license": "ISC",
+  "license": "ISC",
-    "scripts": {
+  "scripts": {
-        "dev": "nodemon --exec ts-node -r tsconfig-paths/register src/index.ts",
+    "nest": "nest",
-        "build": "rimraf dist && tsc -p tsconfig.json && tsc-alias -p tsconfig.json"
+    "build": "nest build",
-    },
+    "dev": "nest start --watch",
-    "devDependencies": {
+    "dev:debug": "nest start --debug --watch",
-        "@types/hapi": "18.0.10",
+    "start": "node dist/main",
-        "@types/hapi__nes": "11.0.7",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
-        "@types/ramda": "0.28.0",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
-        "@types/validator": "13.11.1",
+    "test": "jest",
-        "copyfiles": "2.4.1",
+    "test:watch": "jest --watch",
-        "nodemon": "3.0.1",
+    "test:cov": "jest --coverage",
-        "rimraf": "5.0.1",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-        "ts-node": "10.9.1",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
-        "tsc-alias": "1.8.7"
+  },
-    },
+  "dependencies": {
-    "dependencies": {
+    "@nestjs/axios": "^3.0.0",
-        "@hapi/boom": "10.0.1",
+    "@nestjs/common": "^10.2.5",
-        "@hapi/nes": "13.0.1",
+    "@nestjs/typeorm": "10.0.0",
-        "@hapi/hapi": "21.3.2",
+    "@nestjs/config": "^3.1.0",
-        "@hapi/inert": "7.1.0",
+    "@nestjs/core": "^10.2.5",
-        "@hapi/vision": "7.0.3",
+    "@nestjs/swagger": "7.1.11",
-        "@prokyon/utils": "1.0.31",
+    "@nestjs/platform-express": "^10.2.5",
-        "hapi-swagger": "17.1.0",
+    "axios": "^1.5.0",
-        "joi": "17.10.1",
+    "reflect-metadata": "^0.1.13",
-        "typeorm": "0.3.17",
+    "rxjs": "^7.8.1",
-        "sqlite3": "5.1.6"
+    "sqlite3": "^5.1.6"
-    },
+  },
-    "peerDependencies": {
+  "devDependencies": {
-        "ramda": "0.28.0",
+    "@nestjs/cli": "10.1.17",
-        "typescript": "5.2.2"
+    "@nestjs/mapped-types": "^2.0.2",
-    }
+    "@nestjs/schematics": "^10.0.2",
+    "@nestjs/testing": "^10.2.5",
+    "@types/express": "^4.17.17",
+    "@types/jest": "29.5.4",
+    "@types/node": "20.6.0",
+    "@types/supertest": "^2.0.12",
+    "@typescript-eslint/eslint-plugin": "^6.7.0",
+    "@typescript-eslint/parser": "^6.7.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "eslint": "^8.49.0",
+    "execa": "8.0.1",
+    "jest": "29.7.0",
+    "prettier": "^3.0.3",
+    "source-map-support": "^0.5.21",
+    "supertest": "^6.3.3",
+    "ts-jest": "29.1.1",
+    "ts-loader": "^9.4.4",
+    "ts-node": "^10.9.1",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.2.2"
+  }
 }

source/api/src/app.module.ts

@@ -0,0 +1,24 @@
+// @ts-nocheck
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+import { TypeOrmModule } from '@nestjs/typeorm';
+
+import { envs } from './config';
+import { HealthModule } from './common/health/health.module';
+
+@Module({
+	imports: [
+		ConfigModule.forRoot({
+			isGlobal: true,
+			load: [envs],
+		}),
+		TypeOrmModule.forRoot({
+			type: 'sqlite',
+			database: `db.sqlite`,
+			entities: [],
+			logging: ['query'],
+		}),
+		HealthModule,
+	],
+})
+export class AppModule {}

source/api/src/common/health/health.controller.spec.ts

@@ -0,0 +1,14 @@
+// @ts-nocheck
+import { HealthController } from './health.controller';
+
+describe('AppController (e2e)', () => {
+	let healthController: HealthController;
+
+	beforeEach(() => {
+		healthController = new HealthController();
+	});
+
+	it('should return OK response', async () => {
+		expect(await healthController.status()).toEqual('OK');
+	});
+});

source/api/src/common/health/health.controller.ts

@@ -0,0 +1,21 @@
+// @ts-nocheck
+import { Controller, Get, Response } from '@nestjs/common';
+import { ApiResponse } from '@nestjs/swagger';
+
+@Controller('health-check')
+export class HealthController {
+	/**
+	 * Health check endpoint
+	 */
+	@ApiResponse({
+		status: 200,
+		description: 'API is online',
+		schema: {
+			default: 'OK',
+		},
+	})
+	@Get()
+	status() {
+		return 'OK';
+	}
+}

source/api/src/common/health/health.module.ts

@@ -0,0 +1,8 @@
+// @ts-nocheck
+import { Module } from '@nestjs/common';
+import { HealthController } from './health.controller';
+
+@Module({
+	controllers: [HealthController],
+})
+export class HealthModule {}

source/api/src/config.ts

@@ -0,0 +1,3 @@
+export const envs = () => {
+	return {};
+};

source/api/src/config/server.json

@@ -1,4 +0,0 @@
-{
-	"host": "localhost",
-	"port": 3000
-}

source/api/src/controllers/hey.ts

@@ -1,18 +0,0 @@
-// @ts-nocheck
-import { Request, ResponseToolkit, ServerRoute } from '@hapi/hapi';
-
-const routers: ServerRoute[] = [
-	{
-		path: '/hey',
-		method: 'GET',
-		options: {
-			description: 'Are u alive?',
-			tags: ['api'],
-		},
-		handler: (request: Request, h: ResponseToolkit) => {
-			return h.response('I am here !').type('html/text').code(200);
-		},
-	},
-];
-
-export default routers;

source/api/src/database/db.ts

@@ -1,13 +0,0 @@
-// @ts-nocheck
-import { DataSource } from 'typeorm';
-
-export const dbConnect = async () => {
-	const AppDataSource = new DataSource({
-		type: 'sqlite',
-		database: `database.sqlite`,
-		entities: [],
-		synchronize: true,
-		logging: ['query'],
-	});
-	return await AppDataSource.initialize();
-};

source/api/src/index.ts

@@ -1,51 +0,0 @@
-// @ts-nocheck
-import hapi from '@hapi/hapi';
-import nes from '@hapi/nes';
-
-import { host, port } from 'config/server.json';
-import { dbConnect } from 'database/db';
-
-import swagger from 'plugins/swagger';
-
-const server: hapi.Server = new hapi.Server({
-	host: host,
-	port: port,
-	debug: {
-		log: ['error'],
-		request: ['error'],
-	},
-	routes: {
-		validate: {
-			failAction: (request, h, err) => {
-				throw err;
-			},
-		},
-	},
-});
-
-const start = async (): Promise<void> => {
-	await swagger(server);
-	await server.register(nes);
-
-	// v1 endpoints
-	await server.register(require('./plugins/controllers'), { routes: { prefix: '/api/v1' } });
-
-	// connect to database
-	await dbConnect()
-		.then(() => {
-			console.log('Data Source has been initialized!');
-		})
-		.catch((err) => {
-			console.error('Error during Data Source initialization', err);
-		});
-
-	await server.start();
-	console.info(`Server running: ${server.info.uri}`);
-};
-
-process.on('unhandledRejection', (err) => {
-	console.info(err);
-	process.exit(1);
-});
-
-start();

source/api/src/main.ts

@@ -0,0 +1,28 @@
+// @ts-nocheck
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
+
+async function bootstrap() {
+	const app = await NestFactory.create(AppModule);
+
+	// swagger
+	SwaggerModule.setup(
+		'api',
+		app,
+		SwaggerModule.createDocument(
+			app,
+			new DocumentBuilder()
+				.setTitle('$(AppName) API')
+				.setDescription('The $(AppName) API description.')
+				.setVersion('0.1.0')
+				.addServer('/api/v1')
+				.build(),
+		),
+	);
+
+	app.setGlobalPrefix('/api/v1');
+
+	await app.listen(8080);
+}
+bootstrap();

source/api/src/plugins/controllers.ts

@@ -1,11 +0,0 @@
-// @ts-nocheck
-import { Server } from '@hapi/hapi';
-
-import hey from 'controllers/hey';
-
-export const plugin = {
-	name: 'Controllers',
-	register: async (server: Server) => {
-		server.route(hey);
-	},
-};

source/api/src/plugins/swagger.ts

@@ -1,26 +0,0 @@
-// @ts-nocheck
-import { Server } from '@hapi/hapi';
-
-const version = require('../../package.json').version;
-
-export default async (server: Server) => {
-	return server.register([
-		require('@hapi/inert'),
-		require('@hapi/vision'),
-		{
-			plugin: require('hapi-swagger'),
-			options: {
-				info: {
-					title: 'Many API',
-					version,
-				},
-				swaggerUI: true,
-				documentationPage: true,
-				documentationPath: '/swagger',
-				pathPrefixSize: 3,
-				basePath: '/api/v1',
-				reuseDefinitions: false,
-			},
-		},
-	]);
-};

source/api/src/utils/params.ts

@@ -1,23 +0,0 @@
-// @ts-nocheck
-import { Request } from '@hapi/hapi';
-
-export type RequestParams = Record<string, string | null>;
-
-export const getParam =
-	(request: Request) =>
-	(name: string): string | null => {
-		const params: RequestParams = {
-			...(request.params as object),
-			...(request.payload as object),
-			...(request.query as object),
-		};
-		const filteredParams: RequestParams = {} as any;
-		Object.keys(params).map((key) => {
-			const value = params[key];
-			if (['undefined', 'null'].includes(value as string)) {
-				filteredParams[key] = null;
-			}
-			filteredParams[key] = value;
-		});
-		return filteredParams[name] ?? null;
-	};

source/api/test/app.e2e-spec.ts

@@ -0,0 +1,26 @@
+// @ts-nocheck
+import { Test, TestingModule } from '@nestjs/testing';
+import { INestApplication } from '@nestjs/common';
+import * as request from 'supertest';
+import { AppModule } from '../src/app.module';
+
+describe('AppController (e2e)', () => {
+	let app: INestApplication;
+
+	beforeEach(async () => {
+		const moduleRef: TestingModule = await Test.createTestingModule({
+			imports: [AppModule],
+		}).compile();
+
+		app = moduleRef.createNestApplication();
+		await app.init();
+	});
+
+	it('/health-check (GET)', () => {
+		return request.agent(app.getHttpServer()).get('/health-check').expect(200).expect('OK');
+	});
+
+	afterAll(async () => {
+		await app.close();
+	});
+});

source/api/test/jest.config-e2e.js

@@ -0,0 +1,14 @@
+/** @type {import('jest').Config} */
+
+const config = {
+	moduleFileExtensions: ['js', 'json', 'ts'],
+	rootDir: '.',
+	testEnvironment: 'node',
+	testRegex: '.e2e-spec.ts$',
+	transform: {
+		'^.+\\.(t|j)s$': 'ts-jest',
+	},
+	moduleNameMapper: { '^uuid$': 'uuid' },
+};
+
+module.exports = config;

source/api/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
+}