최근 @nest/swagger 라이브러리를 사용 하며 @Apiquery()로 받는 인자에 대해서는 schema를 작성해 주지 않는 문제가 있어 해결 했던 과정에 대해 써보자 한다.

// main.ts
  const config = new DocumentBuilder()
    .setTitle('Cats example')
    .setDescription('The cats API description')
    .setVersion('1.0')
    .addTag('cats')
    .build();
  const document = SwaggerModule.createDocument(app, config);
  SwaggerModule.setup('api', app, document);

nest.js 공식 문서에 나와있는 swagger적용 방식이다.

export declare class SwaggerModule {
    private static readonly metadataLoader;
    static createDocument(app: INestApplication, config: Omit<OpenAPIObject, 'paths'>, options?: SwaggerDocumentOptions): OpenAPIObject;
    static loadPluginMetadata(metadataFn: () => Promise<Record<string, any>>): Promise<void>;
    private static serveStatic;
    private static serveDocuments;
    static setup(path: string, app: INestApplication, documentOrFactory: OpenAPIObject | (() => OpenAPIObject), options?: SwaggerCustomOptions): void;
}
// swagger을 동작시켜 주는 SwaggerModule.setup을 보면 options라는 인자를 받는것이 보인다.

// setup함수의 인자인 path로 지정한 경로에 '-json'을 붙여서 접속 하면 swagger의 json파일을 볼 수 있다. ex) localhost:3000/path-json

이 json 파일을 가지고 https://editor.swagger.io 사이트에서 swagger-ui를 내가 원하는 대로 꾸밀수 있다. 사이트에 접속하여 components부분을 작성해 주고 json파일을 뽑아 낸다.

  const json: OpenAPIObject = JSON.parse(fs.readFileSync("./openapi.json", {encoding: 'utf8'}));

  SwaggerModule.setup('doc', app, json);

이 후 파일을 읽어 주고 json 형식으로 파싱을 해준 후 setup함수에 인자로 주면 내가 작성한 json파일 형식대로 swagger-ui가 나오는 것을 확인 할 수 있다.

2023-12-15

간단히 @ApiExtraModels(Class)
데코레이터를 달아주면 swagger-doc에 잘 추가 된다...

현재 진행중인 프로젝트에서 기존에는 가게이름을 검색할 때 필터로 지역은 하나만 선택 가능하게 enum 타입으로 인자를 받아왔지만 팀원의 의견을 통해 여러 지역에서 검색이 가능하게 기능을 수정 해야 되서 enum타입이 아닌 string로 인자를 받아 split후 in절로 검색을 하기로 했다.

// 기존 코드
const result = await this.storeRepository.createQueryBuilder('store')
        .leftJoinAndSelect('store.store_type', 'store_type')
        .where('store.name like :name', {name: `%${dto.storename ?? ''}%`})
        .andWhere('store.city_name like :city_name', {city_name: `%${dto.region ?? ''}%`})
        .getMany()

//수정후 코드
const result = await this.storeRepository.createQueryBuilder('store')
        .leftJoinAndSelect('store.store_type', 'store_type')
        .where('store.name like :name', {name: `%${dto.storename ?? ''}%`})
        .andWhere('store.city_name IN (:city_name)', {city_name: regionNames})
        .getMany()

수정을 하고 테스트를 하는데 자꾸 빈배열이 return 값으로 넘어왔다. 왜 그런가 확인을 하니 IN절은 like절과 다르게 완전히 같은 값이어야 가져오기 때문이었다. 그래서 DB를 확인해 보니 내가 인자로 받아오는 값은 '수성구' 였는데 DB에 저장된 값은 '대구 수성구' 여서 못가져 오는 것이었다... 그래서 DB를 수정하기보다 값을 조회 할 때 인자의 값을 바꾸어 주는 로직을 추가 하였다.

const storeRegion = dto.region;
        const regionNames = storeRegion.split(',');
        regionNames.forEach((name, idx) => {
            regionNames[idx] = '대구 ' + name
        })

이 후 확인하니 정상적으로 값을 가져오는 것을 확인하였다.

테스트 코드 작성 중 발생한 오류에 대해 적어보고자 한다.

위에서 보이다 싶이 Cannot find module 이라는 에러가 발생했다. 검색 결과 Nest에서 jest를 사용 시 경로 문제가 발생 하는 경우가 있고 package.json 파일을 수정해 주면 에러가 고쳐진다고 해서 수정해 주었다.

// package.json
// 변경 전
  "jest": {
    "moduleFileExtensions": [
      "js",
      "json",
      "ts"
    ],
    "rootDir":"src",
    "testRegex": ".*\\.spec\\.ts$",
    "transform": {
      "^.+\\.(t|j)s$": "ts-jest"
    },
    "collectCoverageFrom": [
      "**/*.(t|j)s"
    ],
    "coverageDirectory": "../coverage",
    "testEnvironment": "node",
    "moduleDirectories": ["node_modules", "src"]
  }
// 변경 후
  "jest": {
    "moduleDirectories": [
      "node_modules",
      "src"
    ],
    "moduleFileExtensions": [
      "js",
      "json",
      "ts"
    ],
    "roots": [
      "src"
    ],
    "testRegex": ".spec.ts$",
    "transform": {
      "^.+\\.(t|j)s$": "ts-jest"
    },
    "coverageDirectory": "../coverage",
    "testEnvironment": "node",
    "moduleNameMapper": {
      "src/(.*)": "<rootDir>/src/$1"
    }
  }

참조

JoinColumn의 옵션을 통해 외래키 등록시 컬럼의 이름을 지정할 수 있다.

현재 프로젝트 진행 중 typeorm select문을 실행하는데 파라메터 값이 이상하게 들어가는 문제가 있어 그걸 해결하고자 한다.

const like = await this.storeLikeRepository.createQueryBuilder('store_like')
        .select()
        .where('store_like.store = :id', {id: 22080004})
        .andWhere('store_like.user = :id', {id: 2})
        .getOne();

query: SELECT `store_like`.`id` AS `store_like_id`, `store_like`.`user_id` AS `store_like_user_id`, `store_like`.`store_id` AS `store_like_store_id` FROM `store_like` `store_like` WHERE `store_like`.`store_id` = ? AND `store_like`.`user_id` = ? -- PARAMETERS: [2,2]

분명 고정값으로 id를 입력했음에도 불구하고 parameters가 [2,2] 로 들어가고 있다.

현재 유저의 아이디값이 두번 들어가는 문제가 생기고 있다.

const like = await this.storeLikeRepository.createQueryBuilder('store_like')
        .select()
        .where('store_like.store = :store_id', {store_id})
        .andWhere('store_like.user = :user_id', {user_id})
        .getOne();

where 안에 변수 명을 바꾸어 주었더니 정상적으로 값이 들어간다. 나중에 시간이 될 때 typeorm의 실행 순서 관련 문서를 찾아봐야 겠다.

TypeOrmModule에 legacySpatialSupport: false 속성을 추가하여 해결

현재 진행 중인 프로젝트에서 TypeORM 과 내가 생성한 DB를 사용하다 보니 만들어진 DB의 컬럼의 속성을 변경 해야 하는 경우가 있었다. 나중에도 사용 할 것 같으니 그 내용을 정리한다.

컬럼명 변경

alter table 테이블명 change 기존컬럼명 변경컬럼명 컬럼타입;

컬럼명 디폴트값 변경

alter table 테이블명 alter column 변경할컬럼명 set default 디폴트값;

컬럼 추가

ALTER TABLE 테이블이름 ADD 컬럼이름 데이터타입 NULL or NOT NULL;

컬럼 삭제

ALTER TABLE 테이블이름 DROP COLUMN 컬럼명;

참고

링크텍스트 링크텍스트

현재 코드

await Promise.all(idArr.map(async id => {
            if(typeof id !== 'number') throw new BadRequestException('공지사항의 아이디를 정확히 보내주세요.');

            const result = await this.faqRepository
            .createQueryBuilder()
            .update(Faq)
            .set({deletedAt: new Date()})
            .where('id = :id', {id})
            .execute();

            if( result.affected === 0 ) {
                throw new BadRequestException('존재하지 않는 게시글 입니다.');
            }
        }))

공식 문서

// create a new query runner
const queryRunner = dataSource.createQueryRunner()

// establish real database connection using our new query runner
await queryRunner.connect()

// now we can execute any queries on a query runner, for example:
await queryRunner.query("SELECT * FROM users")

// we can also access entity manager that works with connection created by a query runner:
const users = await queryRunner.manager.find(User)

// lets now open a new transaction:
await queryRunner.startTransaction()

try {
    // execute some operations on this transaction:
    await queryRunner.manager.save(user1)
    await queryRunner.manager.save(user2)
    await queryRunner.manager.save(photos)

    // commit transaction now:
    await queryRunner.commitTransaction()
} catch (err) {
    // since we have errors let's rollback changes we made
    await queryRunner.rollbackTransaction()
} finally {
    // you need to release query runner which is manually created:
    await queryRunner.release()
}

수정 후 코드

async deleteFaq(idArr: BigInt[]) {
        const queryRunner = this.connection.createQueryRunner();
        await queryRunner.connect(); // 2
        await queryRunner.startTransaction(); // 3
        try {
            await Promise.all(idArr.map(async id => {        
                const result = await queryRunner.manager.delete(Faq, {id});

                if( result.affected === 0 ) {
                    throw new BadRequestException('존재하지 않는 게시글 입니다.');
                };
            }))
          // 삭제 도중 잘못된 id가 들어올 경우 transaction 롤백
        } catch (error) {
            await queryRunner.rollbackTransaction();
            await queryRunner.release();
            throw new BadRequestException('존재하지 않는 게시글 입니다.');
        }
  // 모든 아이디가 정상 적일 경우 transaction commit
        await queryRunner.commitTransaction();
        await queryRunner.release();
}

Nest.js 공식 홈페이지 : https://docs.nestjs.kr/techniques/file-upload Multer 깃허브 : https://github.com/expressjs/multer#multeropts

설치

npm i -D @types/multer
npm i multer

단일 파일 업로드

@Post('upload')
@UseInterceptors(FileInterceptor('file'))
uploadFile(@UploadedFile() file: Express.Multer.File) {
  console.log(file);
}

@FileInterceptor(fileName, option)

• fileName: 프론트에서 보낼 때 필드 이름
• option: MulterOptions

다중 파일 업로드

@Post('upload')
@UseInterceptors(FilesInterceptor('files'))
uploadFile(@UploadedFiles() files: Array<Express.Multer.File>) {
  console.log(files);
}

@Post('upload')
@UseInterceptors(FileFieldsInterceptor([
  { name: 'avatar', maxCount: 1 },
  { name: 'background', maxCount: 1 },
]))
uploadFile(@UploadedFiles() files: { avatar?: Express.Multer.File[], background?: Express.Multer.File[] }) {
  console.log(files);
}

@Post('upload')
@UseInterceptors(AnyFilesInterceptor())
uploadFile(@UploadedFiles() files: Array<Express.Multer.File>) {
  console.log(files);
}

Multer 옵션

    dest?: string;
    /** The storage engine to use for uploaded files. */
    storage?: any;
    /**
     * An object specifying the size limits of the following optional properties. This object is passed to busboy
     * directly, and the details of properties can be found on https://github.com/mscdex/busboy#busboy-methods
     */
    limits?: {...};
    /** Keep the full path of files instead of just the base name (Default: false) */
    preservePath?: boolean;
    fileFilter?(req: any, file: {...}, callback: (error: Error | null, acceptFile: boolean) => void): void;

dest

dest 같은경우는 받은 파일을 어디에다 저장 할 지 정하는 옵션이다.

storage

srotage는 dest보다 더 세밀하게 파일 저장 옵션을 정 할 수 있다.

limits

파일을 받아 올 때 제한을 걸 수 있다.

@UploadFile() 데코레이터에 pipe 등록하기

import { PipeTransform, Injectable, ArgumentMetadata } from '@nestjs/common';

@Injectable()
export class FileSizeValidationPipe implements PipeTransform {
  transform(value: any, metadata: ArgumentMetadata) {
    // "value" is an object containing the file's attributes and metadata
    const oneKb = 1000;
    return value.size < oneKb;
  }
}

@Post('file')
uploadFileAndPassValidation(
  @Body() body: SampleDto,
  // 1kb 보다 용량이 작은 파일만 등록이 가능하다.
  @UploadedFile(FileSizeValidationPipe)
  )
  file: Express.Multer.File,
) {
  return ;
}

@UploadFile() 데코레이터에 내장 pipe 등록하기

Nest에는 파일 업로드를 편하게 해주는 내장 pipe를 제공한다. 내장 파이프를 등록해 보자.

@UploadedFile(
  new ParseFilePipe({
    validators: [
      new MaxFileSizeValidator({ maxSize: 1000 }),
      new FileTypeValidator({ fileType: 'image/jpeg' }),
    ],
  }),
)
file: Express.Multer.File,

위와 같이 내장 pipe를 활용하여서 파일의 유효성 검사도 할 수 있으며, ParseFilePipeBuilder를 사용하여 유효성 검사를 할 수도 있다.

export declare class ParseFilePipeBuilder {
    private validators;
    addMaxSizeValidator(options: MaxFileSizeValidatorOptions): this;
    addFileTypeValidator(options: FileTypeValidatorOptions): this;
    addValidator(validator: FileValidator): this;
    build(additionalOptions?: Omit<ParseFileOptions, 'validators'>): ParseFilePipe;
}

현재 진행중인 프로젝트를 배포하기 위해 aws ubuntuOS에 pm2로 nest앱을 실행 시키니

Error: listen EACCES: permission denied 0.0.0.0:80 란 에러가 발생했다.

2. 해결

에러코드는 80포트에 대한 권한이 없다는 말이다. 검색결과 리눅스에서 1024번 이하의 포트를 사용하려면 root 권한이 필요 하다고 한다.

루트 권한을 주는법

$ sudo su
$ sudo pm2 start dist/main.js

3. 참조

일문학도의 개발자 도전기

aws 서버에서 코드를 올릴 때 FTP 소프트웨어로 직접 코드를 옮겨도 되지만 코드 관리를 위해 github에 코드를 올려 놓았으므로 github를 통해 코드를 옮겨 받아보자.

2. 필요 프로그램 설치

- sudo apt-get update 
- sudo apt-get -y upgrade
- sudo apt-get install build-essential
- sudo apt-get install curl
- curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash --
- sudo apt-get install -y nodejs
- sudo apt-get install git
- sudo apt-get install vim

3. git 설정

- touch .gitconfig
- git config --global user.name github닉네임 
- git config --global user.email github이메일

// 변경사항 확인
- git config --global --list
- git clone <프로젝트>

현재 git 보안 정책으로 인해 자신의 깃 비밀번호로는 private repository를 clone불가능 이 주소를 보고 참조 하여 clone 한다.

4. nest서버 실행

- cd <프로젝트>
- npm i
- sudo npm i -g @nestjs/cli
- sudo npm i -g pm2
- vi .env (환경변수 붙여 넣기)
- sudo npm run start:prod

$ npm i --save @nestjs/passport passport-jwt
$ npm i --save-dev @types/passport-jwt

2. 적용

1. strategy 만들기

import { PassportStrategy } from "@nestjs/passport";
import { Request } from "express";
import { Strategy } from "passport-jwt";

export class JwtStrategy extends PassportStrategy(Strategy) {
    constructor() {
        super({
            jwtFromRequest: (req: Request) => {
                return req.cookies['access_token'];
            },
            secretOrKey: process.env.JWT_SECRET,
        })

    }

    async validate(payload) {    
        console.log(payload);  
        return payload;
    }
}

2. guard 만들기

import { Injectable } from '@nestjs/common';
import { AuthGuard } from '@nestjs/passport';

@Injectable()
export class JwtAuthGuard extends AuthGuard('jwt') {}

3. guard 등록하기

가드는 다른 프로바이더들과 다르게 모듈에 등록하지 않고 contoller에서 @UseGuards() 데코레이터를 사용하여 등록을 한다.

 @Get('test')
    @UseGuards(JwtAuthGuard)
    async test(@Req() req) {
        console.log(req.user);

    }

등록이 완료 되면 strategy에 따라 jwt에 담긴 내용을 req.user에 담아 준다.

$ npm install --save @nestjs/jwt passport-jwt
$ npm install --save-dev @types/passport-jwt

2. 적용

1. jwt module 등록

import { Module } from '@nestjs/common';
import { JwtModule } from '@nestjs/jwt';
import { AuthService } from './auth.service';

@Module({
  imports: [
    JwtModule.register({
      secret: process.env.JWT_SECRET,
      signOptions: { expiresIn: '1y' },
    }),
  ],
  providers: [AuthService],
  exports: [AuthService]
})
export class AuthModule {}

2. auth.service.ts

import { Injectable, UnauthorizedException } from '@nestjs/common';
import { JwtService } from '@nestjs/jwt';
import * as bcrypt from 'bcrypt';
import { User } from 'src/users/users.entity';
import { UsersRepository } from 'src/users/users.repository';
import { LoginDto } from './dto/login.dto';

@Injectable()
export class AuthService {
    constructor(
        private jwtService: JwtService,
        private readonly usersRepository: UsersRepository
    ){}

    async jwtLogIn(dto: LoginDto) {
        const {email, password} = dto;

        const user: User = await this.usersRepository.findUserByEmail(email);
        console.log(user);

        if(!user) {
            throw new UnauthorizedException('이메일과 비밀번호를 확인해주세요.');
        }

        const isPasswordValidated: boolean = await bcrypt.compare(password, user.password);
        console.log(isPasswordValidated);

        if(!isPasswordValidated) {
            throw new UnauthorizedException('이메일과 비밀번호를 확인해주세요.');
        }
        const payload = {
            email: email, sub: user.id, user_type: user.user_type
        }
        return {access_token: this.jwtService.sign(payload)}
    }
}

3. 순환종속성 해결

현재 user.module가 auth.module를 import하고 auth.module이 user.module을 import하고 있어서 순환종속성에 걸려 "Nest cannot create the module instance"에러를 내고 있다. Nest.js공식문서에 따르면 forwardRef()를 사용하라고 나와있다.

// auth.module
@Module({
  imports: [
    JwtModule.register({
      secret: process.env.JWT_SECRET,
      signOptions: { expiresIn: '1y' },
    }),
    forwardRef(() => UsersModule)
  ],
  providers: [AuthService],
  exports: [AuthService]
})
export class AuthModule {}

//users.module
@Module({
  imports: [TypeOrmModule.forFeature([User]), EmailModule, forwardRef(() => AuthModule)],
  providers: [UsersService, UsersRepository],
  controllers: [UsersController],
  exports: [UsersRepository]
})

현재 진행중인 프로젝트에서 이메일 인증 기능을 구현 중이다. 이메일 인증 키가 영구적으로 저장되면 DB용량 문제등 여러 부분에서 좋지 않을것이라는 생각이 들어서 특정 시간 동안만 저장을 하고 자동으로 삭제 되게 하기 위해서 캐시를 사용 해보고자 한다.

처음에는 Redis를 사용하고자 했지만, 서버의 스펙과 그렇게 많은 캐시 정보가 필요하지 않을듯 싶어 Nest 자체의 캐시 메니저를 사용해서 구현해 보고자 한다.

2. 적용

1. 설치

$ npm install cache-manager

2. 등록

import { CacheModule, Module } from '@nestjs/common';
import { AppController } from './app.controller';

@Module({
  imports: [CacheModule.register({
      isGlobal: true, // 전역으로 사용가능
    ttl: 5, // 디폴트 만료시간
      max: 10, // 최대 등록가능 개수
  })],
  controllers: [AppController],
})
export class AppModule {}

3. 의존성 주입

constructor(@Inject(CACHE_MANAGER) private cacheManager: Cache) {}

다른 프로바이더, 컨트롤러에서 의존성을 주입받아 사용가능

4. 사용방법

// 값 가져오기
const value = await this.cacheManager.get('key');

// 값 등록하기 - 기본 만료시간은 5초
await this.cacheManager.set('key', 'value');

// 만료시간 설정하여 등록하기
await this.cacheManager.set('key', 'value', 1000);

// 만료시간 비활성화 하여 등록하기
await this.cacheManager.set('key', 'value', 0);

// 키 값으로 등록된 값 제거하기
await this.cacheManager.del('key');

// 모든 캐시 제거하기
await this.cacheManager.reset();

3. cacheIntercepter

인터셉터를 사용하여 특정 라우트로 들어오는 요청에대한 예외 처리가 가능하다.

import { CacheModule, Module, CacheInterceptor } from '@nestjs/common';
import { AppController } from './app.controller';
import { APP_INTERCEPTOR } from '@nestjs/core';

@Module({
  imports: [CacheModule.register()],
  controllers: [AppController],
  providers: [
    {
      provide: APP_INTERCEPTOR,
      useClass: CacheInterceptor,
    },
  ],
})
export class AppModule {}

CacheInterceptor 구현 코드를 보았을 때 trackBy 함수가 실행 컨택스트를 받아서 엔드포인트 값을 키로 가지는 cache를 등록 해준다. 즉, CacheInterceptor를 상속받는 클래스를 생성하고 trackBy 함수를 수정한다면 내가 원하는 내용만 저장 하는 cacheIntercepter를 만들 수 있다.

4. 참고

[NestJS] REST API에 캐시 Nestjs REST 애플리케이션의 캐시 처리와 캐시 무효화 NestJS Custom Caching Decorator 만들기 nestjs/github

현재 진행중인 프로젝트에서 이메일 인증, 비밀번호 찾기등의 서비스를 위해 메일 서비스가 필요해서 작성하게 되었다.

2. nestjs-modules/mailer

메일 서비스를 위해 많이 사용되는nestjs-modules/mailer를 사용하여 구현 하겠다. docs

1. 설치

npm install --save @nestjs-modules/mailer nodemailer
npm install --save-dev @types/nodemailer

// 보내는 형식을 위한 템플릿 엔진
npm install --save handlebars
#or
npm install --save pug
#or
npm install --save ejs

2. Mailer 모듈 등록

//app.module.ts
import { Module } from '@nestjs/common';
import { MailerModule } from '@nestjs-modules/mailer';
import { PugAdapter } from '@nestjs-modules/mailer/dist/adapters/pug.adapter';

@Module({
  imports: [
    MailerModule.forRootAsync({
      useFactory: () => ({
        transport: `smtps://${process.env.EMAIL_AUTH_EMAIL}:${process.env.EMAIL_AUTH_PASSWORD}@${process.env.EMAIL_HOST}`,
        defaults: {
          from: `"${process.env.EMAIL_FROM_USER_NAME}" <${process.env.EMAIL_AUTH_EMAIL}>`,
        },
      }),
    }),
    EmailModule,
  ],
})
export class AppModule {}

// email.module.ts
import { Module } from '@nestjs/common';
import { EmailService } from './email.service';

@Module({
  providers: [EmailService],
  exports: [EmailService]
})
export class EmailModule {}

// email.service.ts
import { Injectable } from '@nestjs/common';
import { MailerService } from '@nestjs-modules/mailer';
import { Logger } from 'winston';

@Injectable()
export class EmailService {
    constructor(private readonly mailerService: MailerService) {}
    private logger = new Logger();
    sendAuthCode(email: string): void {
        console.log(email);

        this.mailerService
            .sendMail({
                to: email, // list of receivers
                subject: '인증 이메일 입니다.', // Subject line
                text: '안녕하세요', // plaintext body
                html: '<b>welcome</b>', // HTML body content
            })
            .then(() => {
                console.log("성공");      
            })
            .catch((err) => {
                this.logger.error(err)
                console.log(err);
            });
    }
}

3. 구글 이메일 인증

실행 결과

Error: Invalid login: 535-5.7.8 Username and Password not accepted. Learn more at
535 5.7.8  https://support.google.com/mail/?p=BadCredentials a4-20020aa78644000000b005a8ba70315bsm635106pfo.6 - gsmtp

내용을 보자면 사용자 이름 그리고 비밀번호가 승인되지 않는다며 밑에 주소로 가서 이유를 찾으라고 되어있다. 대충 내용을 보니 내 앱이 보안 등급이 낮아서 일어나는 일인거 같다. 해결해 보자.

https://support.google.com/mail/?p=BadCredentials 주소로 접속 하여서 2단계 인증을 설정하고, 앱 비밀번호를 사용해 주면된다.

3. 결과

정상적으로 날아 오는 것을 확인가능하다.

4. 참고

https://blog.naver.com/PostView.naver?blogId=pjt3591oo&logNo=222467283376&redirect=Dlog&widgetTypeCall=true&directAccess=false

현재 프로젝트를 진행 중에 이상한 버그를 만났다. 바로 위에 사진과 같이 nest cli 명령어를 사용해서 resource를 생성 할려고 하는데 ok 로그는 뜨고 파일은 생성 안되는 버그이다. 물론 내가 직접 하나하나 폴더, 파일을 생성해도 되지만 이상한 상황을 만났는데 해결해 보고자 노력도 하지않고 그냥 넘기는 것은 별로 마음에 들지않아 일단 해결 할려고 노력해보고자 한다.

2. 해결

이 블로그에 따르면 npx를 사용 하면 된다고 해서 npx를 사용하여 실행하니 잘 실행된다.

파이프는 @Injecttable() 데코레이터와 PipeTransform 인터페이스를 구현하는 클레스이다. 파이프에는 보통 2가지의 목적으로 사용된다.

• 변환 : 입력 데이터를 원하는 형식으로 변환(예: 문자열에서 정수로)

• 유효성 검사 : 입력 데이터를 평가하고 유효하지 않은 경우 예외처리.

2. 내장 파이프

• ValidationPipe

• ParseIntPipe
• ParseFloatPipe
• ParseBoolPipe
• ParseArrayPipe
• ParseUUIDPipe
• ParseEnumPipe
• DefaultValuePipe
• ParseFilePipe

3. Class Validator

1. 설치

$ npm i --save class-validator class-transformer

2. 적용

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useGlobalPipes(new ValidationPipe());
  await app.listen(3000);
}
bootstrap();

Nest 프레임워크는 기본적으로 예외 레이어를 제공한다. 이를 통해 기본 예외처리기가 예외를 처리해 준다.

2. Nest 제공 표준 예외

1. HttpException

@Get()
async findAll() {
  throw new HttpException('Forbidden', HttpStatus.FORBIDDEN);
}

// 매개변수
constructor(response: string | Record<string, any>, status: number, options?: HttpExceptionOptions);

• response: 응답의 본문

• status: 에러의 상태를 나타내는 HTTP 상태코드

2. HttpException을 상속받는 표준 예외

3. 예외 필터 만들기

예외 필터는 ExceptionFilter 인터페이스를 구현하는 class로 만들 수 있다.

import { ExceptionFilter, Catch, ArgumentsHost, HttpException, Logger } from '@nestjs/common';
import { Request, Response } from 'express';

@Catch(HttpException)
export class HttpExceptionFilter implements ExceptionFilter {
  private logger = new Logger();

  catch(exception: HttpException, host: ArgumentsHost) {
    const ctx = host.switchToHttp();
    const res = ctx.getResponse<Response>();
    const req = ctx.getRequest<Request>();
    const status = exception.getStatus();
    const error = exception.getResponse() as
      | string
      | { error: string; statusCode: number; message: string | string[] };

    this.logger.error(`${req.ip} ${req.originalUrl} ${req.method} ${exception}`)
    res
      .status(status)
      .json({
        statusCode: status,
        timestamp: new Date().toISOString(),
        path: req.url,
        error
      });
  }
}

4. 예외 필터 적용

1. 특정 엔드포인트

@Post()
@UseFilters(HttpExceptionFilter)
async create(@Body() createCatDto: CreateCatDto) {
  throw new ForbiddenException();
}

2. 특정 컨트롤러

@Controller('cats')
@UseFilters(HttpExceptionFilter)
export class CatsController {}

3. 앱 전체 적용

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useGlobalFilters(HttpExceptionFilter);
  await app.listen(3000);
}
bootstrap();

5. 로그 미들웨어를 있는데 예외 필터에서 따로 로그를 확인하는이유.

Nest 프레임 워크에서 자체적으로 제공하는 예외 레이어로 인해 사용자의 잘못된 요청을 받거나 서버 문제가 생겼을 때 등 에러가 발생했을 때 에러를 캐치해서 서버가 정상 적으로 돌아가게 한다. 그 이후 미들웨어가 응답으로 날아가는 에러 문자와 에러 코드를 단순히 info형식으로 로그를 보여주고 후 처리 작업을 한다. 이러한 부분을 확실하게 error 로그와 후 처리를 하기위해 커스텀 예외 필터를 추가하여 처리한다.

지난이야기를 통해 우리가 만든 로거로 내장 로거를 대채 할 수 있음을 알았다. 하지만 대형 회사가 아닌 개인의 목적으로 개발을 하는데 필요한 기능을 추가한 커스텀 로거를 만드는 일은 매우 귀찮고 어려울 수 있다. 그러므로 Node.js에서 인기 있는 라이브러리인 winston을 활용해 보겠다.

2. winston

주간 다운로드 횟수가 25만 회가 될 정도로 인기있는 라이브러리 이다. 그러면 설치 후 적용까지 해보자.

1. 설치

npm install --save nest-winston winston

2. 적용

// winston.util.ts
// main.ts 코드가 지저분 해지는것을 막기 위한 파일
import { utilities, WinstonModule } from 'nest-winston';
// winston 자체 file 함수를 사용하려고 했지만 typescript에서 moment 작동 안하는 버그로 인해 대체로 사용
import * as winstonDaily from 'winston-daily-rotate-file';
import * as winston from 'winston';

const env = process.env.NODE_ENV;
const logDir = __dirname + '/../../logs'; // log 파일을 관리할 폴더

const fileOption = (level: string) => {
    return {
        level,
        datePattern: 'YYYY-MM-DD',
        dirname: logDir + `/${level}`,
        filename: `%DATE%.${level}.log`,
        maxFiles: 30, //30일치 로그파일 저장
        zippedArchive: true, // 로그가 쌓이면 압축하여 관리
    };
}

// rfc5424를 따르는 winston만의 log level
// error: 0, warn: 1, info: 2, http: 3, verbose: 4, debug: 5, silly: 6
export const winstonLogger = WinstonModule.createLogger({
  transports: [
    new winston.transports.Console({
      level: env === 'production' ? 'http' : 'silly',
      // production 환경이라면 http, 개발환경이라면 모든 단계를 로그
      format:
        env === 'production'
        // production 환경은 자원을 아끼기 위해 simple 포맷 사용
          ? winston.format.simple() 
          : winston.format.combine(
              winston.format.timestamp(),
              utilities.format.nestLike('powerfulDaegu', {
                prettyPrint: true, // nest에서 제공하는 옵션. 로그 가독성을 높여줌
              }),
            ),
    }),

    // info, warn, error 로그는 파일로 관리
    new winstonDaily(fileOption('info')),
    new winstonDaily(fileOption('warn')),
    new winstonDaily(fileOption('error')),
  ],
});

// main.ts
import { NestFactory } from '@nestjs/core';
import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
import { AppModule } from './app.module';
import { winstonLogger } from './common/utils/winston.util';

async function bootstrap() {
  const app = await NestFactory.create(AppModule, {
    // winston 추가
    logger: winstonLogger
  });
  await app.listen(3000);
}
bootstrap();

내장 로거를 winston 로거로 대체하여 부트스트래핑 과정에 winston적용.

3. middleware 등록

// logger.middleware.ts
import { Injectable, Logger, NestMiddleware } from '@nestjs/common';
import { Request, Response, NextFunction } from 'express';

@Injectable()
export class LoggerMiddleware implements NestMiddleware {
    private logger = new Logger();

    use(req: Request, res: Response, next: NextFunction) {
          // 응답할떄 로그를 찍음 
        res.on('finish', () => {
            this.logger.log(`${req.ip} ${req.originalUrl} ${req.method} ${res.statusCode}`);
        });

        next();
    }
}

//app.module.ts
import { MiddlewareConsumer, Module, NestModule } from '@nestjs/common';
import { LoggerMiddleware } from './common/middleware/logger.middleware';

@Module()
export class AppModule implements NestModule {
  // 미들웨어 등록
  configure(consumer: MiddlewareConsumer) {
    consumer
      .apply(LoggerMiddleware)
      .forRoutes('*');
  }
}

3. 참조

https://velog.io/@aryang/NestJS-winston%EC%9C%BC%EB%A1%9C-%EB%A1%9C%EA%B7%B8-%EA%B4%80%EB%A6%AC