Merge pull request #137 from boostcampwm-2024/dev-back

[BE] Merge to main

Author: sjy2335

backend/console-server/src/app.controller.spec.ts

@@ -4,20 +4,20 @@ import { AppController } from './app.controller';
 import { AppService } from './app.service';
 
 describe('AppController', () => {
-  let appController: AppController;
+    let appController: AppController;
 
-  beforeEach(async () => {
-    const app: TestingModule = await Test.createTestingModule({
-      controllers: [AppController],
-      providers: [AppService],
-    }).compile();
+    beforeEach(async () => {
+        const app: TestingModule = await Test.createTestingModule({
+            controllers: [AppController],
+            providers: [AppService],
+        }).compile();
 
-    appController = app.get<AppController>(AppController);
-  });
+        appController = app.get<AppController>(AppController);
+    });
 
-  describe('root', () => {
-    it('should return "Hello World!"', () => {
-      expect(appController.getHello()).toBe('Hello World!');
+    describe('root', () => {
+        it('should return "Hello World!"', () => {
+            expect(appController.getHello()).toBe('Hello World!');
+        });
     });
-  });
 });

backend/console-server/src/log/dto/get-avg-elapsed-time.dto.ts

@@ -0,0 +1,16 @@
+import { IsNotEmpty, IsNumber } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+import { Expose, Type } from 'class-transformer';
+
+export class GetAvgElapsedTimeDto {
+    @IsNotEmpty()
+    @IsNumber()
+    @ApiProperty({
+        example: 9,
+        description: '기수',
+        type: 'number',
+    })
+    @Type(() => Number)
+    @Expose()
+    generation: number;
+}

backend/console-server/src/log/dto/get-speed-rank-response.dto.ts

@@ -0,0 +1,28 @@
+import { Exclude, Expose, Type } from 'class-transformer';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class ProjectSpeedData {
+    @ApiProperty({
+        example: 'watchducks',
+        description: '해당 프로젝트명',
+    })
+    @Expose()
+    projectName: string;
+
+    @ApiProperty({
+        example: 123.45,
+        description: '평균 응답 소요 시간 (ms).',
+    })
+    @Expose()
+    @Type(() => Number)
+    avgResponseTime: number;
+}
+
+export class GetSpeedRankResponseDto {
+    @ApiProperty({
+        type: [ProjectSpeedData],
+        description: '프로젝트별 응답 속도 배열',
+    })
+    @Type(() => ProjectSpeedData)
+    projectSpeedRank: ProjectSpeedData[];
+}

backend/console-server/src/log/dto/get-speed-rank.dto.ts

@@ -0,0 +1,14 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Type } from 'class-transformer';
+import { IsNumber } from 'class-validator';
+
+export class GetSpeedRankDto {
+    @IsNumber()
+    @Type(() => Number)
+    @ApiProperty({
+        description: '기수',
+        example: 5,
+        required: true,
+    })
+    generation: number;
+}

backend/console-server/src/log/dto/get-traffic-daily-difference-response.dto.ts

@@ -1,12 +1,15 @@
 import { ApiProperty } from '@nestjs/swagger';
 import { Expose } from 'class-transformer';
+import { IsNotEmpty, IsNumber, IsString } from 'class-validator';
 
 export class GetTrafficDailyDifferenceResponseDto {
     @ApiProperty({
         example: '+9100',
         description: '전일 대비 총 트래픽 증감량',
         type: String,
     })
+    @IsString()
+    @IsNotEmpty()
     @Expose()
     traffic_daily_difference: string;
 }

backend/console-server/src/log/dto/get-traffic-rank.dto.ts

@@ -0,0 +1,16 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Expose, Type } from 'class-transformer';
+import { IsNotEmpty, IsNumber } from 'class-validator';
+
+export class GetTrafficRankDto {
+    @ApiProperty({
+        example: 9,
+        description: '기수',
+        type: 'number',
+    })
+    @Type(() => Number)
+    @IsNumber()
+    @IsNotEmpty()
+    @Expose()
+    generation: number;
+}

backend/console-server/src/log/dto/get-traffic-top5-chart-response.dto.ts

@@ -0,0 +1,26 @@
+import { Expose } from 'class-transformer';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class TrafficTop5Chart {
+    name: string;
+    traffic: [string, string][];
+}
+
+export class GetTrafficTop5ChartResponseDto {
+    @ApiProperty({
+        example: [
+            {
+                name: 'watchducks',
+                traffic: [
+                    ['2024-01-01 11:12:00', '100'],
+                    ['2024-01-02 11:13:00', '100'],
+                    ['2024-01-02 11:14:00', '100'],
+                    ['2024-01-02 11:15:00', '100'],
+                ],
+            },
+        ],
+        description: '해당 기수의 트래픽 Top5 프로젝트에 대한 작일 차트 데이터',
+    })
+    @Expose()
+    trafficCharts: TrafficTop5Chart[];
+}

backend/console-server/src/log/dto/get-traffic-top5-chart.dto.ts

@@ -0,0 +1,14 @@
+import { IsNumber } from 'class-validator';
+import { Type } from 'class-transformer';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class GetTrafficTop5ChartDto {
+    @IsNumber()
+    @Type(() => Number)
+    @ApiProperty({
+        description: '기수',
+        example: 9,
+        required: true,
+    })
+    generation: number;
+}

backend/console-server/src/log/log.contorller.spec.ts

@@ -3,6 +3,10 @@ import { HttpStatus } from '@nestjs/common';
 import type { TestingModule } from '@nestjs/testing';
 import { LogController } from './log.controller';
 import { LogService } from './log.service';
+import { GetTrafficRankDto } from './dto/get-traffic-rank.dto';
+import { plainToInstance } from 'class-transformer';
+import { GetAvgElapsedTimeDto } from './dto/get-avg-elapsed-time.dto';
+
 interface TrafficRankResponseType {
     status: number;
     data: Array<{ host: string; count: number }>;
@@ -14,7 +18,7 @@ describe('LogController 테스트', () => {
 
     const mockLogService = {
         httpLog: jest.fn(),
-        elapsedTime: jest.fn(),
+        getAvgElapsedTime: jest.fn(),
         trafficRank: jest.fn(),
         getResponseSuccessRate: jest.fn(),
         getResponseSuccessRateByProject: jest.fn(),
@@ -23,6 +27,7 @@ describe('LogController 테스트', () => {
         getTrafficByProject: jest.fn(),
         getTrafficDailyDifferenceByGeneration: jest.fn(),
         getDAUByProject: jest.fn(),
+        getSpeedRank: jest.fn(),
     };
 
     beforeEach(async () => {
@@ -53,9 +58,12 @@ describe('LogController 테스트', () => {
         };
 
         it('평균 응답 시간을 ProjectResponseDto 형식으로 반환해야 한다', async () => {
-            mockLogService.elapsedTime.mockResolvedValue(mockResult);
+            mockLogService.getAvgElapsedTime.mockResolvedValue(mockResult);
+
 
-            const result = await controller.elapsedTime();
+            const result = await controller.getElapsedTime(
+                plainToInstance(GetAvgElapsedTimeDto, { generation: 1 }),
+            );
 
             expect(result).toEqual(mockResult);
             expect(result).toHaveProperty('status', HttpStatus.OK);
@@ -79,7 +87,9 @@ describe('LogController 테스트', () => {
         it('TOP 5 트래픽 순위를 ProjectResponseDto 형식으로 반환해야 한다', async () => {
             mockLogService.trafficRank.mockResolvedValue(mockResult);
 
-            const result = (await controller.trafficRank()) as unknown as TrafficRankResponseType;
+            const result = (await controller.getTrafficRank(
+                plainToInstance(GetTrafficRankDto, { generation: 1 }),
+            )) as unknown as TrafficRankResponseType;
 
             expect(result).toEqual(mockResult);
             expect(result).toHaveProperty('status', HttpStatus.OK);
@@ -300,9 +310,9 @@ describe('LogController 테스트', () => {
                 mockRequestDto,
             );
             expect(service.getTrafficDailyDifferenceByGeneration).toHaveBeenCalledTimes(1);
-        }
-    )}
-             
+        });
+    });
+
     describe('getDAUByProject()는', () => {
         const mockRequestDto = { projectName: 'example-project', date: '2024-11-01' };
 
@@ -335,4 +345,51 @@ describe('LogController 테스트', () => {
             expect(service.getDAUByProject).toHaveBeenCalledTimes(1);
         });
     });
+
+    describe('getSpeedRank()는', () => {
+        const mockRequestDto = {
+            generation: 5,
+        };
+
+        const mockResponseDto = [
+            { projectName: 'project1', avgElapsedTime: 123.45 },
+            { projectName: 'project2', avgElapsedTime: 145.67 },
+            { projectName: 'project3', avgElapsedTime: 150.89 },
+            { projectName: 'project4', avgElapsedTime: 180.23 },
+            { projectName: 'project5', avgElapsedTime: 200.34 },
+        ];
+
+        it('응답 속도 TOP5 데이터를 반환해야 한다', async () => {
+            mockLogService.getSpeedRank.mockResolvedValue(mockResponseDto);
+
+            const result = await controller.getSpeedRank(mockRequestDto);
+
+            expect(result).toEqual(mockResponseDto);
+            expect(result).toHaveLength(5);
+            expect(result[0]).toHaveProperty('projectName', 'project1');
+            expect(result[0]).toHaveProperty('avgElapsedTime', 123.45);
+            expect(service.getSpeedRank).toHaveBeenCalledWith(mockRequestDto);
+            expect(service.getSpeedRank).toHaveBeenCalledTimes(1);
+        });
+
+        it('서비스 메소드 호출시 에러가 발생하면 예외를 throw 해야 한다', async () => {
+            const error = new Error('Database error');
+            mockLogService.getSpeedRank.mockRejectedValue(error);
+
+            await expect(controller.getSpeedRank(mockRequestDto)).rejects.toThrow(error);
+
+            expect(service.getSpeedRank).toHaveBeenCalledWith(mockRequestDto);
+            expect(service.getSpeedRank).toHaveBeenCalledTimes(1);
+        });
+
+        it('데이터가 없을 때 빈 배열을 반환한다', async () => {
+            mockLogService.getSpeedRank.mockResolvedValue([]);
+
+            const result = await controller.getSpeedRank(mockRequestDto);
+
+            expect(result).toEqual([]);
+            expect(service.getSpeedRank).toHaveBeenCalledWith(mockRequestDto);
+            expect(service.getSpeedRank).toHaveBeenCalledTimes(1);
+        });
+    });
 });

backend/console-server/src/log/log.controller.ts

@@ -17,6 +17,12 @@ import { GetTrafficByGenerationResponseDto } from './dto/get-traffic-by-generati
 import { GetSuccessRateByProjectResponseDto } from './dto/get-success-rate-by-project-response.dto';
 import { GetTrafficDailyDifferenceResponseDto } from './dto/get-traffic-daily-difference-response.dto';
 import { GetTrafficDailyDifferenceDto } from './dto/get-traffic-daily-difference.dto';
+import { GetSpeedRankDto } from './dto/get-speed-rank.dto';
+import { GetSpeedRankResponseDto } from './dto/get-speed-rank-response.dto';
+import { GetTrafficRankDto } from './dto/get-traffic-rank.dto';
+import { GetAvgElapsedTimeDto } from './dto/get-avg-elapsed-time.dto';
+import { GetTrafficTop5ChartResponseDto } from './dto/get-traffic-top5-chart-response.dto';
+import { GetTrafficTop5ChartDto } from './dto/get-traffic-top5-chart.dto';
 
 @Controller('log')
 export class LogController {
@@ -33,8 +39,8 @@ export class LogController {
         description: '평균 응답시간이 성공적으로 반환됨.',
         type: GetAvgElapsedTimeResponseDto,
     })
-    async elapsedTime() {
-        return await this.logService.getAvgElapsedTime();
+    async getElapsedTime(@Query() getAvgElapsedTimeDto: GetAvgElapsedTimeDto) {
+        return await this.logService.getAvgElapsedTime(getAvgElapsedTimeDto);
     }
 
     @Get('/traffic/rank')
@@ -48,8 +54,23 @@ export class LogController {
         description: '트래픽 랭킹 TOP 5가 정상적으로 반환됨.',
         type: GetTrafficRankResponseDto,
     })
-    async trafficRank() {
-        return await this.logService.getTrafficRank();
+    async getTrafficRank(@Query() getTrafficRankDto: GetTrafficRankDto) {
+        return await this.logService.getTrafficRank(getTrafficRankDto);
+    }
+
+    @Get('/elapsed-time/top5')
+    @HttpCode(HttpStatus.OK)
+    @ApiOperation({
+        summary: '기수 내 응답 속도 TOP5',
+        description: '요청받은 기수의 응답 속도 랭킹 TOP 5를 반환합니다.',
+    })
+    @ApiResponse({
+        status: HttpStatus.OK,
+        description: '응답 속도 랭킹 TOP5가 정상적으로 반환됨.',
+        type: GetSpeedRankResponseDto,
+    })
+    async getSpeedRank(@Query() getSpeedRankDto: GetSpeedRankDto) {
+        return await this.logService.getSpeedRank(getSpeedRankDto);
     }
 
     @Get('/success-rate')
@@ -63,7 +84,7 @@ export class LogController {
         description: '기수 내 응답 성공률이 성공적으로 반환됨.',
         type: GetSuccessRateResponseDto,
     })
-    async getResponseSuccessRate(getSuccessRateDto: GetSuccessRateDto) {
+    async getResponseSuccessRate(@Query() getSuccessRateDto: GetSuccessRateDto) {
         return await this.logService.getResponseSuccessRate(getSuccessRateDto);
     }
 
@@ -126,7 +147,7 @@ export class LogController {
         type: GetTrafficDailyDifferenceResponseDto,
     })
     async getTrafficDailyDifferenceByGeneration(
-        getTrafficDailyDifferenceDto: GetTrafficDailyDifferenceDto,
+        @Query() getTrafficDailyDifferenceDto: GetTrafficDailyDifferenceDto,
     ) {
         return await this.logService.getTrafficDailyDifferenceByGeneration(
             getTrafficDailyDifferenceDto,
@@ -162,4 +183,19 @@ export class LogController {
     async getDAUByProject(@Query() getDAUByProjectDto: GetDAUByProjectDto) {
         return await this.logService.getDAUByProject(getDAUByProjectDto);
     }
+
+    @Get('/traffic/top5/line-chart')
+    @HttpCode(HttpStatus.OK)
+    @ApiOperation({
+        summary: '프로젝트 트래픽 TOP 5에 대한 트래픽 데이터 조회',
+        description: '프로젝트별 작일 데이터 전체 타임스탬프를 반환',
+    })
+    @ApiResponse({
+        status: HttpStatus.OK,
+        description: '프로젝트별 작일 데이터 전체 타임스탬프가 정상적으로 반환됨',
+        type: GetTrafficTop5ChartResponseDto,
+    })
+    async getTrafficTop5Chart(@Query() getTrafficTop5ChartDto: GetTrafficTop5ChartDto) {
+        return await this.logService.getTrafficTop5Chart(getTrafficTop5ChartDto);
+    }
 }