Update Project

Author: henriqueleite42

.eslintignore

@@ -61,7 +61,7 @@ tsconfig*
 schema.gql
 
 # Serverless
-serverless.ts
+/serverless.ts
 serverless.d.ts
 serverless.js
 serverless.js.map

.gitignore

@@ -64,3 +64,6 @@ schema.gql
 serverless.d.ts
 serverless.js
 serverless.js.map
+
+# NPM
+package-lock.json

.vscode/settings.json

@@ -40,6 +40,21 @@
 	"javascript.updateImportsOnFileMove.enabled": "always",
 	"javascript.suggest.autoImports": true,
 
+	// ======================= Formatters ===========================
+
+	"[javascript]": {
+		"editor.defaultFormatter": null
+	},
+	"[typescript]": {
+		"editor.defaultFormatter": null
+	},
+	"[javascriptreact]": {
+		"editor.defaultFormatter": null
+	},
+	"[typescriptreact]": {
+		"editor.defaultFormatter": null
+	},
+
 	// =========== Plugins & Extensions General Config ===============
 
 	// GitLens
@@ -92,20 +107,21 @@
 
 	// Spell Checker
 	"cSpell.words": [
-		"techmmunity",
-		"nestjs",
-		"vercel",
-		"sonarjs",
-		"tsbuildinfo",
-		"prebuild",
-		"nodemodules",
-		"dotenv",
 		"conta",
+		"dotenv",
 		"fastify",
 		"injectables",
 		"jwks",
-		"webfactory",
+		"MONGODB",
+		"nestjs",
+		"nodemodules",
+		"prebuild",
+		"sonarjs",
+		"techmmunity",
+		"tsbuildinfo",
 		"typeorm",
-		"MONGODB"
+		"vendia",
+		"vercel",
+		"webfactory"
 	]
 }

package.json

@@ -8,31 +8,34 @@
 	"dependencies": {
 		"@nestjs/common": "^8.0.0",
 		"@nestjs/core": "^8.0.0",
-		"@nestjs/platform-fastify": "^8.0.6",
-		"@nestjs/swagger": "^5.1.0",
-		"@nestjs/typeorm": "^8.0.2",
-		"aws-serverless-fastify": "^1.0.27",
+		"@nestjs/platform-express": "^8.1.1",
+		"@techmmunity/symbiosis": "^0.0.7",
+		"@techmmunity/symbiosis-dynamodb": "^0.0.2",
+		"@techmmunity/symbiosis-nestjs": "^0.0.1",
+		"@vendia/serverless-express": "^4.5.2",
+		"aws-lambda": "^1.0.6",
 		"dayjs": "^1.10.7",
-		"fastify": "^3.21.1",
-		"mongodb": "^4.1.2",
+		"express": "^4.17.1",
 		"reflect-metadata": "^0.1.13",
 		"rimraf": "^3.0.2",
 		"rxjs": "^7.2.0",
 		"serverless-plugin-optimize": "^4.2.1-rc.1",
-		"typeorm": "^0.2.37",
+		"uuid": "^8.3.2",
 		"yup": "^0.32.9"
 	},
 	"devDependencies": {
 		"@nestjs/cli": "^8.0.0",
 		"@nestjs/schematics": "^8.0.0",
 		"@nestjs/testing": "^8.0.0",
 		"@serverless/typescript": "^2.61.0",
-		"@techmmunity/eslint-config": "^5.0.1",
+		"@techmmunity/eslint-config": "^5.0.4",
 		"@types/aws-lambda": "^8.10.83",
+		"@types/express": "^4.17.13",
 		"@types/jest": "^27.0.1",
 		"@types/node": "^16.0.0",
 		"@types/supertest": "^2.0.11",
-		"eslint": "^7.30.0",
+		"@types/uuid": "^8.3.1",
+		"eslint": "^8.0.1",
 		"husky": "^7.0.2",
 		"jest": "^27.0.6",
 		"lint-staged": "^11.1.2",
@@ -54,12 +57,11 @@
 	},
 	"scripts": {
 		"prebuild": "yarn clear",
-		"postinstall": "husky install",
-		"build": "nest build",
+		"clear": "rimraf dist && rimraf tsconfig.build.tsbuildinfo && rimraf tsconfig.tsbuildinfo",
+		"prepare": "husky install",
+		"build": "serverless package",
 		"start": "nest start",
-		"start:dev": "ts-node-dev src/main.ts",
 		"start:prod": "node dist/index.js",
-		"clear": "rimraf dist && rimraf tsconfig.build.tsbuildinfo && rimraf tsconfig.tsbuildinfo",
 		"format": "eslint . --fix --quiet",
 		"lint": "eslint . --quiet",
 		"dev": "serverless offline",

serverless.ts

@@ -5,8 +5,9 @@ import { v1 } from "./src/v1";
 import type { AWS } from "@serverless/typescript";
 
 const serverlessConfiguration: AWS = {
-	service: "course-service",
+	service: "base-project-serverless",
 	frameworkVersion: "2",
+	useDotenv: true,
 	package: {
 		individually: true,
 	},
@@ -15,6 +16,7 @@ const serverlessConfiguration: AWS = {
 			webpackConfig: "./webpack.config.js",
 			includeModules: true,
 		},
+		optimize: ["swagger-ui-dist"]
 	},
 	plugins: ["serverless-webpack", "serverless-offline"],
 	provider: {

src/helpers/make-handler.ts

@@ -0,0 +1,42 @@
+import { NestFactory } from "@nestjs/core";
+import serverlessExpress from "@vendia/serverless-express";
+import type { Handler } from "aws-lambda";
+
+let cachedServer: Handler;
+
+const isWarmUp = (event: any) => event.source === "serverless-plugin-warmup";
+
+const bootstrap = async (module: any, version: string): Promise<Handler> => {
+	const nestApp = await NestFactory.create(module);
+
+	nestApp.enableCors();
+
+	await nestApp.init();
+
+	const expressApp = nestApp.getHttpAdapter().getInstance();
+
+	return serverlessExpress({ app: expressApp });
+};
+
+export const makeHandler =
+	(module: any, version: string): Handler =>
+	async (event, context, callback) => {
+		// https://github.com/vendia/serverless-express/issues/86
+		event.path = event.pathParameters.proxy;
+
+		if (isWarmUp(event)) {
+			/**
+			 * If it's an event to keep the lambda warm,
+			 * return here to stop the lambda execution
+			 * as soon as possible
+			 */
+			return;
+		}
+
+		if (!cachedServer) {
+			// eslint-disable-next-line require-atomic-updates
+			cachedServer = await bootstrap(module, version);
+		}
+
+		return cachedServer(event, context, callback);
+	};

src/helpers/set-swagger.ts

@@ -4,7 +4,8 @@ declare global {
 	namespace NodeJS {
 		interface ProcessEnv {
 			NODE_ENV: "dev" | "homolog" | "production" | "test";
-			MONGODB_URL: string;
+			DYNAMODB_ACCESS_KEY_ID: string;
+			DYNAMODB_SECRET_ACCESS_KEY: string;
 		}
 	}
 }

src/types/env.d.ts

@@ -1,39 +1,14 @@
-/* eslint-disable multiline-comment-style */
-/* eslint-disable capitalized-comments */
 import { Body, Controller, Post } from "@nestjs/common";
-import { ApiTags, ApiCreatedResponse } from "@nestjs/swagger";
 import { ExampleService } from "./example.service";
 import { V1CreateExampleInputSchema } from "./service/create/schemas/input.schema";
 import { API_VERSION } from "v1/config";
-// import { LazyModuleLoader } from "@nestjs/core";
-// import { App2Service } from "@app/module2/app2.service";
-// import { AppService } from "./app.service";
-// import { App2Module } from "@app/module2/app2.module";
 
-@ApiTags(`${API_VERSION} - Example`)
 @Controller(`${API_VERSION}/example`)
-export class AppController {
-	// private app2Service: App2Service;
-
-	public constructor(
-		private readonly exampleService: ExampleService, // private readonly lazyLoadModuler: LazyModuleLoader,
-	) {}
+export class ExampleController {
+	public constructor(private readonly exampleService: ExampleService) {}
 
 	@Post()
-	@ApiCreatedResponse({
-		type: V1CreateExampleInputSchema,
-	})
-	public create(@Body() data: any) {
+	public create(@Body() data: V1CreateExampleInputSchema) {
 		return this.exampleService.create(data);
 	}
-
-	// @Post("/lazy-module")
-	// public async getHello2(): Promise<string> {
-	// 	if (!this.app2Service) {
-	// 		const context = await this.lazyLoadModuler.load(() => App2Module);
-	// 		this.app2Service = context.get(App2Service);
-	// 	}
-
-	// 	return this.app2Service.getHello();
-	// }
 }

src/v1/api/example/example.controller.ts

@@ -1,18 +1,14 @@
 import {
-	BaseEntity,
 	Column,
 	Entity,
+	PrimaryColumn,
 	Repository,
-	ObjectIdColumn,
-	ObjectID,
-} from "typeorm";
+} from "@techmmunity/symbiosis";
 
-@Entity("example")
-export class ExampleEntity extends BaseEntity {
-	@ObjectIdColumn({
-		name: "_id",
-	})
-	public id: ObjectID;
+@Entity()
+export class ExampleEntity {
+	@PrimaryColumn()
+	public id: string;
 
 	@Column()
 	public thisIsAnParam: string;

src/v1/api/example/example.entity.ts

@@ -1,12 +1,14 @@
 import { Module } from "@nestjs/common";
-import { TypeOrmModule } from "@nestjs/typeorm";
+import { SymbiosisModule } from "@techmmunity/symbiosis-nestjs";
 
 import { ExampleService } from "./example.service";
 
+import { ExampleController } from "./example.controller";
 import { ExampleEntity } from "./example.entity";
 
 @Module({
-	imports: [TypeOrmModule.forFeature([ExampleEntity])],
+	imports: [SymbiosisModule.forFeature([ExampleEntity])],
 	providers: [ExampleService],
+	controllers: [ExampleController],
 })
 export class ExampleModule {}

src/v1/api/example/example.module.ts

@@ -1,6 +1,6 @@
 import { Injectable } from "@nestjs/common";
-import { InjectRepository } from "@nestjs/typeorm";
 
+import { InjectRepository } from "@techmmunity/symbiosis-nestjs";
 import { create } from "./service/create";
 import { V1CreateExampleInputSchema } from "./service/create/schemas/input.schema";
 

src/v1/api/example/example.service.ts

@@ -1,3 +1,4 @@
+import { v4 } from "uuid";
 import { V1CreateExampleInputSchema } from "./schemas/input.schema";
 
 import { validate } from "./validate";
@@ -14,5 +15,8 @@ export const create = async (
 ) => {
 	const data = await validate(params);
 
-	return exampleRepository.save(data);
+	return exampleRepository.save({
+		id: v4(),
+		...data,
+	});
 };

src/v1/api/example/service/create/index.ts

@@ -1,9 +1,3 @@
-import { ApiProperty } from "@nestjs/swagger";
-
 export class V1CreateExampleInputSchema {
-	@ApiProperty({
-		description: "Example param",
-		example: "example",
-	})
 	public thisIsAnParam: string;
 }

src/v1/api/example/service/create/schemas/input.schema.ts

@@ -1,15 +1,3 @@
-import { ApiProperty } from "@nestjs/swagger";
-
 export class V1CreateExampleOutputSchema {
-	@ApiProperty({
-		description: "Example id",
-		example: "id",
-	})
-	public id: string;
-
-	@ApiProperty({
-		description: "Example param",
-		example: "example",
-	})
 	public thisIsAnParam: string;
 }

src/v1/api/example/service/create/schemas/output.schema.ts

@@ -0,0 +1,31 @@
+import { SymbiosisModule } from "@techmmunity/symbiosis-nestjs";
+import {
+	DynamodbConnection,
+	DynamoDbConnectionOptions,
+} from "@techmmunity/symbiosis-dynamodb";
+
+import { DynamicModule } from "@nestjs/common";
+import { ExampleEntity } from "v1/api/example/example.entity";
+
+const { DYNAMODB_ACCESS_KEY_ID, DYNAMODB_SECRET_ACCESS_KEY } = process.env;
+
+export const DYNAMO_CONNECT: DynamicModule =
+	SymbiosisModule.forRoot<DynamoDbConnectionOptions>(DynamodbConnection, {
+		entities: [ExampleEntity],
+		namingStrategy: {
+			entity: "snake_case",
+			column: "camelCase",
+		},
+		suffix: {
+			entity: {
+				remove: "_entity",
+			},
+		},
+		databaseConfig: {
+			region: "us-east-1",
+			credentials: {
+				accessKeyId: DYNAMODB_ACCESS_KEY_ID,
+				secretAccessKey: DYNAMODB_SECRET_ACCESS_KEY,
+			},
+		},
+	});