[기능] API (#8)

* [기능] auth test 및 기능 추가 (#1)

* feat: init auth

* feat: add test config for db

* feat: add class validator and transformer

* feat: add fail test for interviewer

* feat: allow global context on mikro orm

* feat: make service testable

* [기능] login 엔드 포인트 추가 및 e2e 테스트 설정 (#5)

* feat: add auth controller test

* feat: add e2e test for auth

* feat: handle test envrionment for db

* feat: make auth api work with edge case test

* [기능] reviewer api 추가 (#7)

* feat: init reviewers

* feat: use inmemory db for test on mikro orm

* refac: fix typo and use tests

* feat: add reviewers test for controller

* feat: add e2e test

* fix: rename auth to reviewer

* [기능] interview post (#9)

* feat: init interviewer

* refac: use external folder for fixture

* feat: add fail error for interview post

* feat: add create api for interview

* [기능] interview post controller (#10)

* feat: add interview post controller

* feat: add e2e test for interview post

* [기능] interview get (#11)

* feat: make test work with bigint

jestjs/jest#11617

* feat: add test for creation error

* feat: add test for interviewer id not valid

* feat: add test for find all

* feat: add test for empty resposne

* feat: add test for interview controller

* feat: add test for e2e on interview

* feat: flush manually

* feat: flush manually

* feat: add test for interview

* [기능] interview 단일 조회 (#12)

* feat: add interview

* feat: config debug option to false to test

보기 어려워서 지움

* feat: make entity work with detail

* refac: use helper function to create interview

* [기능] interview contents 추가 (#13)

* feat: init interview contents create

* feat: add interview contents api

* feat: add contents

* feat: add interview content get api

* feat: add post and find all contents

* feat: make conroller work

* feat: add test for contents

* feat: add e2e test debugger for vscode

* feat: add e2e test for create contents

* feat: add test for e2e

* feat: make end point work

Author: heozeop

.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Test e2e",
+      "request": "launch",
+      "type": "node",
+      "skipFiles": ["<node_internals>/**"],
+      "runtimeExecutable": "pnpm",
+      "runtimeArgs": ["test:e2e"]
+    }
+  ]
+}

package.json

@@ -20,15 +20,19 @@
     "test:e2e": "jest --config ./test/jest-e2e.json"
   },
   "dependencies": {
-    "@mikro-orm/cli": "^6.3.8",
-    "@mikro-orm/core": "^6.3.8",
-    "@mikro-orm/entity-generator": "^6.3.8",
-    "@mikro-orm/migrations": "^6.3.8",
+    "@mikro-orm/cli": "6.3.8",
+    "@mikro-orm/core": "6.3.8",
+    "@mikro-orm/entity-generator": "6.3.8",
+    "@mikro-orm/migrations": "6.3.8",
     "@mikro-orm/nestjs": "^6.0.2",
-    "@mikro-orm/postgresql": "^6.3.8",
+    "@mikro-orm/postgresql": "6.3.8",
+    "@mikro-orm/sqlite": "6.3.8",
     "@nestjs/common": "^10.0.0",
     "@nestjs/core": "^10.0.0",
+    "@nestjs/mapped-types": "*",
     "@nestjs/platform-express": "^10.0.0",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
     "pg": "^8.12.0",
     "reflect-metadata": "^0.2.0",
     "rxjs": "^7.8.1"
@@ -71,6 +75,7 @@
       "**/*.(t|j)s"
     ],
     "coverageDirectory": "../coverage",
-    "testEnvironment": "node"
+    "testEnvironment": "node",
+    "workerThreads": true
   }
 }

pnpm-lock.yaml

@@ -2,10 +2,24 @@ import { Module } from '@nestjs/common';
 import { AppController } from './app.controller';
 import { AppService } from './app.service';
 import { MikroOrmModule } from '@mikro-orm/nestjs';
-import mikroOrmConfig from './mikro-orm.config';
+import { AuthModule } from './auth/auth.module';
+import mikroOrmConfig, { testConfig } from './mikro-orm.config';
+import { ReviewersModule } from './reviewers/reviewers.module';
+import { InterviewModule } from './interview/interview.module';
+
+BigInt.prototype['toJSON'] = function () {
+  return this.toString();
+};
 
 @Module({
-  imports: [MikroOrmModule.forRoot(mikroOrmConfig)],
+  imports: [
+    MikroOrmModule.forRoot(
+      process.env.NODE_ENV === 'test' ? testConfig : mikroOrmConfig,
+    ),
+    AuthModule,
+    ReviewersModule,
+    InterviewModule,
+  ],
   controllers: [AppController],
   providers: [AppService],
 })

src/app.module.ts

@@ -0,0 +1,36 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { AuthController } from './auth.controller';
+import { AuthService } from './auth.service';
+import { MikroOrmModule } from '@mikro-orm/nestjs';
+import { Interviewer } from '../entities/interviewer';
+import { testConfig } from '../mikro-orm.config';
+import { InterviewerDTO } from './dto/Interviewer.dto';
+
+describe('AuthController', () => {
+  let controller: AuthController;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      imports: [
+        MikroOrmModule.forRoot(testConfig),
+        MikroOrmModule.forFeature([Interviewer]),
+      ],
+      controllers: [AuthController],
+      providers: [AuthService],
+    }).compile();
+
+    controller = module.get<AuthController>(AuthController);
+  });
+
+  it('should be defined', () => {
+    expect(controller).toBeDefined();
+  });
+
+  it('createInterviewer() should return Interviewer', async () => {
+    const name = 'testName';
+    const result = await controller.createInterviewer({ name });
+
+    expect(result).toBeInstanceOf(InterviewerDTO);
+    expect(result.name).toBe(name);
+  });
+});

src/auth/auth.controller.spec.ts

@@ -0,0 +1,13 @@
+import { Body, Controller, Post } from '@nestjs/common';
+import { AuthService } from './auth.service';
+import { CreateInterviewerDTO } from './dto/createInterviewer.dto';
+
+@Controller('login')
+export class AuthController {
+  constructor(private readonly authService: AuthService) {}
+
+  @Post()
+  createInterviewer(@Body() dto: CreateInterviewerDTO) {
+    return this.authService.createInterviewer(dto);
+  }
+}

src/auth/auth.controller.ts

@@ -0,0 +1,12 @@
+import { Module } from '@nestjs/common';
+import { AuthService } from './auth.service';
+import { AuthController } from './auth.controller';
+import { MikroOrmModule } from '@mikro-orm/nestjs';
+import { Interviewer } from '../entities/interviewer';
+
+@Module({
+  imports: [MikroOrmModule.forFeature([Interviewer])],
+  controllers: [AuthController],
+  providers: [AuthService],
+})
+export class AuthModule {}

src/auth/auth.module.ts

@@ -0,0 +1,38 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { AuthService } from './auth.service';
+import { getRepositoryToken, MikroOrmModule } from '@mikro-orm/nestjs';
+import { Interviewer } from '../entities/interviewer';
+import { CreateInterviewerDTO } from './dto/createInterviewer.dto';
+import { plainToInstance } from 'class-transformer';
+import { testConfig } from '../mikro-orm.config';
+import { InterviewerDTO } from './dto/Interviewer.dto';
+
+describe('AuthService', () => {
+  let service: AuthService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      imports: [
+        MikroOrmModule.forRoot(testConfig),
+        MikroOrmModule.forFeature([Interviewer]),
+      ],
+      providers: [AuthService],
+    }).compile();
+
+    service = module.get<AuthService>(AuthService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+
+  it('20자 미만, 0자 이상의 입력에 대해서 interviewer를 생성함', async () => {
+    const name = 'validName';
+    const createDTO = plainToInstance(CreateInterviewerDTO, { name });
+
+    const interviewer = await service.createInterviewer(createDTO);
+
+    expect(interviewer).toBeInstanceOf(InterviewerDTO);
+    expect(interviewer.name).toEqual(name);
+  });
+});

src/auth/auth.service.spec.ts

@@ -0,0 +1,24 @@
+import { Injectable } from '@nestjs/common';
+import { CreateInterviewerDTO } from './dto/createInterviewer.dto';
+import { Interviewer } from '../entities/interviewer';
+import { EntityRepository } from '@mikro-orm/core';
+import { InjectRepository } from '@mikro-orm/nestjs';
+import { InterviewerDTO } from './dto/Interviewer.dto';
+
+@Injectable()
+export class AuthService {
+  constructor(
+    @InjectRepository(Interviewer)
+    private readonly interviewerRepository: EntityRepository<Interviewer>,
+  ) {}
+
+  async createInterviewer(createDTO: CreateInterviewerDTO) {
+    const interviewer = await this.interviewerRepository.create(createDTO);
+
+    await this.interviewerRepository
+      .getEntityManager()
+      .persistAndFlush(interviewer);
+
+    return InterviewerDTO.fromEntity(interviewer);
+  }
+}

src/auth/auth.service.ts

@@ -0,0 +1,15 @@
+import { Exclude, Expose } from 'class-transformer';
+import { Interviewer } from 'src/entities/interviewer';
+
+@Exclude()
+export class InterviewerDTO {
+  @Expose()
+  name: string;
+
+  static fromEntity(entity: Interviewer): InterviewerDTO {
+    const interviewerDTO = new InterviewerDTO();
+    interviewerDTO.name = entity.name;
+
+    return interviewerDTO;
+  }
+}

src/auth/dto/Interviewer.dto.ts

@@ -0,0 +1,10 @@
+import { Exclude, Expose } from 'class-transformer';
+import { Length, IsString } from 'class-validator';
+
+@Exclude()
+export class CreateInterviewerDTO {
+  @Expose()
+  @IsString()
+  @Length(1, 20)
+  name: string;
+}

src/auth/dto/createInterviewer.dto.ts

@@ -1,6 +1,14 @@
-import { Entity, Property, ManyToOne, PrimaryKey } from '@mikro-orm/core';
+import {
+  Entity,
+  Property,
+  ManyToOne,
+  PrimaryKey,
+  OneToMany,
+  Collection,
+} from '@mikro-orm/core';
 import { Reviewer } from './reviewer';
 import { Interviewer } from './interviewer';
+import { InterviewContents } from './interviewContents';
 
 @Entity()
 export class Interview {
@@ -18,4 +26,11 @@ export class Interview {
 
   @Property({ length: 10 })
   status: string;
+
+  @OneToMany({
+    entity: () => InterviewContents,
+    mappedBy: 'interview',
+    orphanRemoval: true,
+  })
+  contents = new Collection<InterviewContents>(this);
 }

src/entities/interview.ts

@@ -1,5 +1,5 @@
 import { Entity, Property, ManyToOne, PrimaryKey } from '@mikro-orm/core';
-import { Interviewer } from './interviewer';
+import { Interview } from './interview';
 
 @Entity()
 export class InterviewContents {
@@ -12,6 +12,6 @@ export class InterviewContents {
   @Property({ length: 20 })
   speaker: string;
 
-  @ManyToOne()
-  interview: Interviewer;
+  @ManyToOne({ entity: () => Interview })
+  interview: Interview;
 }

src/entities/interviewContents.ts

@@ -1,4 +1,4 @@
-import { Entity, Property, ManyToOne, PrimaryKey } from '@mikro-orm/core';
+import { Entity, Property, PrimaryKey } from '@mikro-orm/core';
 
 @Entity()
 export class Interviewer {

src/entities/interviewer.ts

@@ -0,0 +1,19 @@
+export class CreateInterviewDTO {
+  interviewerId: bigint;
+  reviewerId: bigint;
+
+  static from({
+    interviewerId,
+    reviewerId,
+  }: {
+    interviewerId: bigint;
+    reviewerId: bigint;
+  }) {
+    const interviewDTO = new CreateInterviewDTO();
+
+    interviewDTO.interviewerId = interviewerId;
+    interviewDTO.reviewerId = reviewerId;
+
+    return interviewDTO;
+  }
+}

src/interview/dto/createInterview.dto.ts

@@ -0,0 +1,3 @@
+export class CreateInterviewContentDTO {
+  content: string;
+}

src/interview/dto/createInterviewContent.dto.ts

@@ -0,0 +1,16 @@
+import { InterviewContents } from '../../entities/interviewContents';
+
+export class InterviewContentDTO {
+  id: bigint;
+  speaker: string;
+  content: string;
+
+  static fromEntity(entity: InterviewContents) {
+    const interviewContentDTO = new InterviewContentDTO();
+    interviewContentDTO.id = entity.id;
+    interviewContentDTO.speaker = entity.speaker;
+    interviewContentDTO.content = entity.content;
+
+    return interviewContentDTO;
+  }
+}

src/interview/dto/interviewContent.dto.ts

@@ -0,0 +1,21 @@
+import { Interview } from '../../entities/interview';
+import { InterviewContentDTO } from './interviewContent.dto';
+
+export class InterviewDetailDTO {
+  id: bigint;
+  title: string;
+  status: string;
+  contents: InterviewContentDTO[];
+
+  static fromEntity(entity: Interview) {
+    const interviewDetailDTO = new InterviewDetailDTO();
+    interviewDetailDTO.id = entity.id;
+    interviewDetailDTO.title = entity.title;
+    interviewDetailDTO.status = entity.status;
+    interviewDetailDTO.contents = entity.contents.map(
+      InterviewContentDTO.fromEntity,
+    );
+
+    return interviewDetailDTO;
+  }
+}