[Nest] : Scheduler 를 사용한 SoftDeleteData 완전 삭제

 

Reference 1
Reference 2
Reference 3
Reference 4
Reference 5
Reference 6

 

구현하고자 하는 기능

nest.js/typeORM 의 softRemove 메서드를 사용하고, 해당 데이터의 deletedAt 컬럼이 현재 시간 기준 특정 기간이 지난 데이터라면 서버에서 자동으로 해당 데이터를 DB에서 영구삭제해주는 기능

 

필요 패키지

npm install --save @nestjs/schedule

네스트의 스케쥴러 패키지가 필요하다.

 

현재 소프트 리무브 시키는 로직

  // 이력서 - 삭제
  async removeResume(resumeId: number): Promise<object> {
    // 삭제할 이력서 확인
    const resume = await this.resumeRepository.findOne({
      where: { id: resumeId },
    });
    // 예외처리
    if (!resume) {
      throw new HttpException('Not found resume', HttpStatus.NOT_FOUND);
    }
    // SOFT_REMOVED 이력서
    const deletedResume = await this.resumeRepository.softRemove(resume);
    // 예외처리
    if (!deletedResume) {
      throw new HttpException('삭제에 실패하였습니다.', HttpStatus.BAD_REQUEST);
    }

    // 반환값
    return { message: `${deletedResume.title} 이력서가 삭제되었습니다.` };
  }

예외처리를 제외한다면, 삭제할 이력서를 긁어와서 softRemove 메서드를 사용해서 null 값이 deletedAt 에 Date 타입을 넣어준다.

 

import Cron

import { Cron } from '@nestjs/schedule';

따로 입력을 해주어도 되고, 코드 작업을 하면서 mac 기준 cmd+. 을 누르면 TS 경우 자동으로 해당 키워드를 import 해준다.

 

Cron 사용하기

  // 소프트리무브 시킨 이력서가 시간이 지나면 자동으로 삭제 하는 로직
  @Cron('0 0 * * *') // 프로덕션 환경에서는 해당 코드
  // @Cron('*/10 * * * * *') // 개발환경에서는 10초마다 해당 데코레이터 실행으로 설정해서 코드 작업 하시쥬
  async cleanupResumes() {
    // Date 타입의 데이터를 담고
    const oneDayAgo = new Date();
    // 담은 데이터에서 1일을 뺀 데이터를 세팅
    oneDayAgo.setDate(oneDayAgo.getDate() - 1);
    // 1일 이전에 소프트리무브 시킨 이력서 삭제
    const cleanupTarget = await this.resumeRepository.find({
      withDeleted: true,
    });
    // 완전 삭제시킬 cleanupTarget list에서 하나하나를 DB에서 삭제해준다.
    for (const resume of cleanupTarget) {
      // 뽑아온 데이터에서 삭제할 데이터들 조건 만들기
      if (resume.deletedAt <= oneDayAgo && resume.deletedAt !== null) {
        // db에서 삭제 ==> delete 사용시 삭제 안됨 !!
        await this.resumeRepository.remove(resume);
      }
    }
  }

처음 사용해보는 로직이라서 하나하나 주석을 달았다.

 

코드 해석

Cron을 데코레이터를 사용해서 가져오고 옵션을 잡아준다.

총 6개의 옵션자리를 설정할 수 있고, 왼쪽부터 "초 분 시 일 월 요일" 이라고 알고 있다.

2번 코드의 첫번째 옵션자리에 */10은 "초"자리에 들어가는 옵션이고 10초 간격으로 데코레이터 이하의 로직이 실행된다는 뜻이다.

  @Cron('0 0 * * *') // 프로덕션 환경에서는 해당 코드
  // @Cron('*/10 * * * * *') // 개발환경에서는 10초마다 해당 데코레이터 실행으로 설정해서 코드 작업 하시쥬

 

이 코드는 현재의 시간을 담은 식별자인 oneDayAgo에 새로운 데이터를 set해주는 과정이고 set하는 데이터는 현재 날짜데이터에서 1일을 빼주는 로직이다.

 oneDayAgo.setDate(oneDayAgo.getDate() - 1);

 

결과적으로 현재 날짜보다 1일이 지난 날짜데이터를 가진 oneDayAgo를 가지고 DB에서 softRemove된 데이터를 하나하나 반복하면서 deletedAt 값이 oneDayAgo 보다 이전의 날짜라면 삭제를 하는 로직을 구현한다.

    for (const resume of cleanupTarget) {
      // 뽑아온 데이터에서 삭제할 데이터들 조건 만들기
      if (resume.deletedAt <= oneDayAgo && resume.deletedAt !== null) {
        // db에서 삭제 ==> delete 사용시 삭제 안됨 !!
        await this.resumeRepository.remove(resume);
      }
    }

 

 

가장 애먹은 부분

바로 이 부분이다.

이유는 deletedAt에 null이 아닌 Date타입이 담겨있는 애들은 이미 삭제가 되었다는 명목아래 있는 친구들이고, 따라서 기존의 방식대로 DB에서 이 친구들을 조회하려고 하면 조회가 되지 않는다.

나는 new Date() 생성자를 사용해서 할당한 Date값(= ISO 8601) 과 현재 deletedAt에 들어있는 데이터 타입(GMT)이 달라서 조회가 안되는 줄 알았다.

그래서 이 글 제일 윗줄에 참고문서의 절반 이상이 Date 타입 변환시키는 문서인 이유가 그 때문이다.

그래서 LessThan / Not(IsNull()) 아무리 이런 메서드를 갖다 붙혀도 조회가 안되는 줄 알았으나,

위 메서드를 createdAt에 적용을 해서 데이터를 조회해보니 현재 살아있는 이력서는 조회가 되는 것이다.

    const cleanupTarget = await this.resumeRepository.find({
      withDeleted: true,
    });

 

그래서 이미 한 번 softRemove가 된 녀석들을 조회하려면 다른 키워드가 필요하다는 것을 알게 되었고, 해당 옵션을 찾아내면서 정상적으로 내가 생각했던 대로 로직을 구현할 수 있었다.

 

마지막 작성 코드 최상위 모듈 적용하기

// app.module.ts

import { ScheduleModule } from '@nestjs/schedule';

@Module({
  imports: [
    ScheduleModule.forRoot(), // 요 녀석이 꼭 필요
...
  ],
  controllers: [AppController],
  providers: [AppService, ChatGateway],
})

export class AppModule {}

이렇게 되면 정상적으로 스케쥴러가 작동될 것이다.

 

#nest #TS #typeORM #schedule #Cron #데코레이터