added typeorm and example entity

Author: clfhhc

nest-cli.json

@@ -1,4 +1,5 @@
 {
   "collection": "@nestjs/schematics",
-  "sourceRoot": "src/server"
+  "sourceRoot": "src/server",
+  "entryFile": "server/main"
 }

package.json

@@ -12,7 +12,7 @@
     "start": "nest start",
     "start:dev": "nest start --watch",
     "start:debug": "nest start --debug --watch",
-    "start:prod": "node dist/main",
+    "start:prod": "node dist/server/main",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
     "test": "jest",
     "test:watch": "jest --watch",
@@ -23,18 +23,22 @@
   "dependencies": {
     "@emotion/react": "^11.1.4",
     "@nestjs/common": "^7.5.1",
+    "@nestjs/config": "^0.6.1",
     "@nestjs/core": "^7.5.1",
     "@nestjs/platform-express": "^7.5.1",
     "@nestjs/platform-fastify": "^7.6.5",
+    "@nestjs/typeorm": "^7.1.5",
     "@reduxjs/toolkit": "^1.5.0",
+    "mysql": "^2.18.1",
     "next": "^10.0.5",
     "next-redux-wrapper": "^6.0.2",
     "react": "^17.0.1",
     "react-dom": "^17.0.1",
     "react-redux": "^7.2.2",
     "reflect-metadata": "^0.1.13",
     "rimraf": "^3.0.2",
-    "rxjs": "^6.6.3"
+    "rxjs": "^6.6.3",
+    "typeorm": "^0.2.30"
   },
   "devDependencies": {
     "@babel/core": "^7.12.10",
@@ -117,4 +121,4 @@
   "resolutions": {
     "webpack": "^5.4.0"
   }
-}
+}

src/server/app.module.ts

@@ -1,8 +1,32 @@
 import { Module } from '@nestjs/common';
-import { ViewMdodule } from './modules/view/view.module';
+import { ConfigModule, ConfigService } from '@nestjs/config';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { ViewMdodule } from '~server/modules/view/view.module';
+import { UsersModule } from '~server/modules/user/users.module';
 
 @Module({
-  imports: [ViewMdodule],
+  imports: [
+    TypeOrmModule.forRootAsync({
+      imports: [
+        ConfigModule.forRoot({
+          envFilePath: '.env.mysql.local',
+        }),
+      ],
+      useFactory: (configService: ConfigService) => ({
+        type: 'mysql',
+        host: configService.get('MYSQL_HOST') || 'localhost',
+        port: configService.get<number>('MYSQL_PORT') || 3306,
+        username: configService.get('MYSQL_USERNAME'),
+        password: configService.get('MYSQL_PASSWORD'),
+        database: configService.get('MYSQL_DATABASE'),
+        entities: [`${__dirname}/**/*.entity.{ts,js}`],
+        synchronize: true,
+      }),
+      inject: [ConfigService],
+    }),
+    UsersModule,
+    ViewMdodule,
+  ],
   controllers: [],
   providers: [],
 })

src/server/main.ts

@@ -8,7 +8,7 @@ import {
 async function bootstrap() {
   const app = await NestFactory.create<NestFastifyApplication>(
     AppModule,
-    new FastifyAdapter(),
+    new FastifyAdapter()
   );
   await app.listen(3000);
 }

src/server/modules/user/user.entity.ts

@@ -0,0 +1,16 @@
+import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm';
+
+@Entity()
+export class User {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @Column()
+  firstName: string;
+
+  @Column()
+  lastName: string;
+
+  @Column({ default: true })
+  isActive: boolean;
+}

src/server/modules/user/users.controller.ts

@@ -0,0 +1,28 @@
+import { Body, Controller, Delete, Get, Param, Post } from '@nestjs/common';
+import { User } from './user.entity';
+import { UsersService } from './users.service';
+
+@Controller('users')
+export class UsersController {
+  constructor(private readonly usersService: UsersService) {}
+
+  @Post()
+  create(@Body() body: Pick<User, 'firstName' | 'lastName'>) {
+    return this.usersService.create(body);
+  }
+
+  @Get()
+  findAll() {
+    return this.usersService.findAll();
+  }
+
+  @Get(':id')
+  findOne(@Param('id') id: string) {
+    return this.usersService.findOne(id);
+  }
+
+  @Delete(':id')
+  remove(@Param('id') id: string) {
+    return this.usersService.remove(id);
+  }
+}

src/server/modules/user/users.module.ts

@@ -0,0 +1,12 @@
+import { Module } from '@nestjs/common';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { UsersController } from './users.controller';
+import { UsersService } from './users.service';
+import { User } from './user.entity';
+
+@Module({
+  imports: [TypeOrmModule.forFeature([User])],
+  providers: [UsersService],
+  controllers: [UsersController],
+})
+export class UsersModule {}

src/server/modules/user/users.service.ts

@@ -0,0 +1,40 @@
+import { Injectable } from '@nestjs/common';
+import { EntityManager } from 'typeorm';
+import { InjectEntityManager } from '@nestjs/typeorm';
+import { User } from './user.entity';
+
+// TypeORM transaction pattern
+// https://docs.nestjs.com/techniques/database#transactions
+// can use other patterns as well
+@Injectable()
+export class UsersService {
+  constructor(
+    @InjectEntityManager()
+    private readonly entityManager: EntityManager
+  ) {}
+
+  findAll() {
+    return this.entityManager.find(User);
+  }
+
+  findOne(id: string) {
+    return this.entityManager.findOne(User, id);
+  }
+
+  async remove(id: string) {
+    await this.entityManager.delete(User, id);
+  }
+
+  create(userName: Pick<User, 'firstName' | 'lastName'>) {
+    const user = new User();
+    user.firstName = userName.firstName;
+    user.lastName = userName.lastName;
+    return this.entityManager.save(user);
+  }
+
+  async createMany(users: User[]) {
+    for (let i = 0; i < users.length; i += 1) {
+      await this.entityManager.save(users[i]);
+    }
+  }
+}

src/server/modules/view/view.controller.ts

@@ -3,7 +3,7 @@ import {} from '@nestjs/platform-fastify';
 import { ViewService } from './view.service';
 import { FastifyRequest, FastifyReply } from 'fastify';
 
-@Controller('/')
+@Controller()
 export class ViewController {
   constructor(private viewService: ViewService) {}
 

src/server/utils/typeORM/QueryRunnerFactory.ts

@@ -0,0 +1,28 @@
+import { Connection, QueryRunner } from 'typeorm';
+
+class QueryRunnerFactory {
+  private readonly queryRunner: QueryRunner;
+  constructor(connection: Connection) {
+    this.queryRunner = connection.createQueryRunner();
+    this.queryRunner.connect();
+  }
+
+  async getTransactionManager() {
+    await this.queryRunner.startTransaction();
+    return this.queryRunner.manager;
+  }
+
+  async commitTransaction() {
+    try {
+      await this.queryRunner.commitTransaction();
+    } catch (err) {
+      await this.queryRunner.rollbackTransaction();
+    }
+  }
+
+  async release() {
+    await this.queryRunner.release();
+  }
+}
+
+export default QueryRunnerFactory;