Merge pull request #456 from boostcampwm-2024/refactor/convention

🧼 clean: 명칭 컨벤션 일관화 및 Redis Key 상수화

Author: Jo-Minseok

feed-crawler/src/main.ts

@@ -3,14 +3,11 @@ import './common/env-load';
 import logger from './common/logger';
 import { FeedCrawler } from './feed-crawler';
 import { container } from './container';
-import { RssRepository } from './repository/rss.repository';
-import { FeedRepository } from './repository/feed.repository';
 import { DEPENDENCY_SYMBOLS } from './types/dependency-symbols';
 import { DatabaseConnection } from './types/database-connection';
 import { ClaudeService } from './claude.service';
 import * as schedule from 'node-schedule';
 import { RedisConnection } from './common/redis-access';
-import { TagMapRepository } from './repository/tag-map.repository';
 
 function initializeDependencies() {
   return {

server/src/activity/api-docs/readActivities.api-docs.ts

@@ -3,8 +3,6 @@ import {
   ApiNotFoundResponse,
   ApiOkResponse,
   ApiOperation,
-  ApiParam,
-  ApiQuery,
 } from '@nestjs/swagger';
 
 export function ApiReadActivities() {

server/src/activity/controller/activity.controller.ts

@@ -9,8 +9,10 @@ import {
 import { ApiTags } from '@nestjs/swagger';
 import { ActivityService } from '../service/activity.service';
 import { ApiResponse } from '../../common/response/common.response';
-import { ActivityParamRequestDto } from '../dto/request/activity-param.dto';
-import { ActivityQueryRequestDto } from '../dto/request/activity-query.dto';
+import {
+  ReadActivityParamRequestDto,
+  ReadActivityQueryRequestDto,
+} from '../dto/request/readActivity.dto';
 import { ApiReadActivities } from '../api-docs/readActivities.api-docs';
 
 @ApiTags('Activity')
@@ -22,8 +24,8 @@ export class ActivityController {
   @Get(':userId')
   @HttpCode(HttpStatus.OK)
   async readActivities(
-    @Param() paramDto: ActivityParamRequestDto,
-    @Query() queryDto: ActivityQueryRequestDto,
+    @Param() paramDto: ReadActivityParamRequestDto,
+    @Query() queryDto: ReadActivityQueryRequestDto,
   ) {
     return ApiResponse.responseWithData(
       '요청이 성공적으로 처리되었습니다.',

server/src/activity/dto/request/activity-param.dto.ts

@@ -0,0 +1,38 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Type } from 'class-transformer';
+import { IsInt, Min, Max } from 'class-validator';
+
+export class ReadActivityParamRequestDto {
+  @ApiProperty({
+    example: 1,
+    description: '조회할 사용자 ID',
+  })
+  @IsInt({
+    message: '정수를 입력해주세요.',
+  })
+  @Min(1, { message: '사용자 ID는 1 이상이어야 합니다.' })
+  @Type(() => Number)
+  userId: number;
+
+  constructor(partial: Partial<ReadActivityParamRequestDto>) {
+    Object.assign(this, partial);
+  }
+}
+
+export class ReadActivityQueryRequestDto {
+  @ApiProperty({
+    example: 2024,
+    description: '조회할 연도',
+  })
+  @IsInt({
+    message: '정수를 입력해주세요.',
+  })
+  @Min(2000, { message: '연도는 2000년 이상이어야 합니다.' })
+  @Max(3000, { message: '연도는 3000년 이하여야 합니다.' })
+  @Type(() => Number)
+  year: number;
+
+  constructor(partial: Partial<ReadActivityQueryRequestDto>) {
+    Object.assign(this, partial);
+  }
+}

server/src/activity/dto/request/activity-query.dto.ts

@@ -10,7 +10,7 @@ export class DailyActivityDto {
   }
 }
 
-export class ActivityReadResponseDto {
+export class ReadActivityResponseDto {
   @ApiProperty({
     type: [DailyActivityDto],
     description: '연도별 일별 활동 데이터 배열',
@@ -35,12 +35,12 @@ export class ActivityReadResponseDto {
   })
   totalViews: number;
 
-  private constructor(partial: Partial<ActivityReadResponseDto>) {
+  private constructor(partial: Partial<ReadActivityResponseDto>) {
     Object.assign(this, partial);
   }
 
   static toResponseDto(dailyActivities: DailyActivityDto[], user: User) {
-    return new ActivityReadResponseDto({
+    return new ReadActivityResponseDto({
       dailyActivities: dailyActivities,
       maxStreak: user.maxStreak,
       currentStreak: user.currentStreak,

server/src/activity/dto/request/readActivity.dto.ts

@@ -1,9 +1,9 @@
 import { Injectable } from '@nestjs/common';
 import { ActivityRepository } from '../repository/activity.repository';
 import {
-  ActivityReadResponseDto,
+  ReadActivityResponseDto,
   DailyActivityDto,
-} from '../dto/response/activity-read.dto';
+} from '../dto/response/readActivity.dto';
 import { UserService } from '../../user/service/user.service';
 
 @Injectable()
@@ -16,7 +16,7 @@ export class ActivityService {
   async readActivities(
     userId: number,
     year: number,
-  ): Promise<ActivityReadResponseDto> {
+  ): Promise<ReadActivityResponseDto> {
     const user = await this.userService.getUser(userId);
 
     const activities =
@@ -30,7 +30,7 @@ export class ActivityService {
         }),
     );
 
-    return ActivityReadResponseDto.toResponseDto(dailyActivities, user);
+    return ReadActivityResponseDto.toResponseDto(dailyActivities, user);
   }
 
   async upsertActivity(userId: number) {

…tivity/dto/response/activity-read.dto.ts …ctivity/dto/response/readActivity.dto.tsserver/src/activity/dto/response/activity-read.dto.ts renamed to server/src/activity/dto/response/readActivity.dto.ts server/src/activity/dto/response/activity-read.dto.ts renamed to server/src/activity/dto/response/readActivity.dto.ts

@@ -5,7 +5,7 @@ import {
   ApiUnauthorizedResponse,
 } from '@nestjs/swagger';
 
-export function ApiReadSessionIdAdmin() {
+export function ApiGetSessionIdAdmin() {
   return applyDecorators(
     ApiOperation({
       summary: `관리자 페이지 출력을 위한 sessionId 확인 API`,
@@ -31,30 +31,3 @@ export function ApiReadSessionIdAdmin() {
     }),
   );
 }
-
-export function ApiLogout() {
-  return applyDecorators(
-    ApiOperation({
-      summary: '관리자 로그아웃 API',
-    }),
-    ApiOkResponse({
-      description: 'Ok',
-      schema: {
-        properties: {
-          message: {
-            type: 'string',
-          },
-        },
-      },
-      example: {
-        message: '로그아웃이 성공적으로 처리되었습니다.',
-      },
-    }),
-    ApiUnauthorizedResponse({
-      description: 'Unauthorized',
-      example: {
-        message: '인증되지 않은 요청입니다.',
-      },
-    }),
-  );
-}

server/src/activity/service/activity.service.ts

@@ -0,0 +1 @@
+export const SESSION_TTL = 60 * 60 * 12;