boostcampwm-2024 · codemario318 · Dec 5, 2024 · Dec 4, 2024 · Dec 4, 2024 · Dec 4, 2024
diff --git a/.github/workflows/test-backend.yml b/.github/workflows/test-backend.yml
@@ -1,8 +1,8 @@
 name: backend test
 
 on:
-  push:
-    pull_request: [develop, main]
+  pull_request:
+    branches: [develop, main]
     paths:
       - apps/backend/**
 

diff --git a/README.md b/README.md
@@ -43,13 +43,13 @@
 
 ## 🛠 기술 스택
 
-| 영역          | 기술 스택                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
-| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| **공통**      | ![TypeScript](https://img.shields.io/badge/TypeScript-5.6.3-3178C6?style=flat-square&logo=typescript&logoColor=white) ![WebSocket](https://img.shields.io/badge/WebSocket-8.18.0-010101?style=flat-square&logo=socket.io&logoColor=white) ![TSDoc](https://img.shields.io/badge/TSDoc-0.26.11-3178C6?style=flat-square&logo=typescript&logoColor=white)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
-| **Frontend**  | ![React](https://img.shields.io/badge/React-18.3.1-61DAFB?style=flat-square&logo=react&logoColor=white) ![Vite](https://img.shields.io/badge/Vite-5.4.10-646CFF?style=flat-square&logo=vite&logoColor=white) ![Tailwind CSS](https://img.shields.io/badge/Tailwind%20CSS-3.4-38B2AC?style=flat-square&logo=tailwind-css&logoColor=white) ![shadcn/ui](https://img.shields.io/badge/shadcn%2Fui-latest-000000?style=flat-square) ![Vitest](https://img.shields.io/badge/Vitest-latest-6E9F18?style=flat-square&logo=vitest&logoColor=white) ![Testing Library](https://img.shields.io/badge/Testing%20Library-latest-E33332?style=flat-square&logo=testing-library&logoColor=white) ![Storybook](https://img.shields.io/badge/Storybook-8.4.2-FF4785?style=flat-square&logo=storybook&logoColor=white)                                                                                |
-| **Backend**   | ![NestJS](https://img.shields.io/badge/NestJS-10.4.7-E0234E?style=flat-square&logo=nestjs&logoColor=white) ![MySQL](https://img.shields.io/badge/MySQL-2-4479A1?style=flat-square&logo=mysql&logoColor=white) ![SQLite](https://img.shields.io/badge/SQLite-3-003B57?style=flat-square&logo=sqlite&logoColor=white) ![TypeORM](https://img.shields.io/badge/TypeORM-0.3.20-E93524?style=flat-square&logo=typeorm&logoColor=white) ![Swagger](https://img.shields.io/badge/Swagger-8.0.5-85EA2D?style=flat-square&logo=swagger&logoColor=black) ![Jest](https://img.shields.io/badge/Jest-Testing-C21325?style=flat-square&logo=jest&logoColor=white) ![SuperTest](https://img.shields.io/badge/SuperTest-Testing-009688?style=flat-square&logo=testing-library&logoColor=white) ![Artillery](https://img.shields.io/badge/Artillery-2.0.21-CA2B2B?style=flat-square&logoColor=white) |
-| **인프라**    | ![NCP](https://img.shields.io/badge/Naver%20Cloud%20Platform-latest-03C75A?style=flat-square&logo=naver&logoColor=white) ![Nginx](https://img.shields.io/badge/Nginx-1.24.0-009639?style=flat-square&logo=nginx&logoColor=white) ![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-3.0-2088FF?style=flat-square&logo=github-actions&logoColor=white) ![Docker](https://img.shields.io/badge/Docker-24.0.7-2496ED?style=flat-square&logo=docker&logoColor=white) ![Linux](https://img.shields.io/badge/Linux-Ubuntu%2022.04-FCC624?style=flat-square&logo=linux&logoColor=black)                                                                                                                                                                                                                                                                                        |
-| **협업 도구** | ![Notion](https://img.shields.io/badge/Notion-2.0.41-000000?style=flat-square&logo=notion&logoColor=white) ![Figma](https://img.shields.io/badge/Figma-latest-F24E1E?style=flat-square&logo=figma&logoColor=white) ![Excalidraw](https://img.shields.io/badge/Excalidraw-latest-6965DB?style=flat-square&logo=excalidraw&logoColor=white) ![Zoom](https://img.shields.io/badge/Zoom-5.17.0-2D8CFF?style=flat-square&logo=zoom&logoColor=white) ![Git](https://img.shields.io/badge/Git-2.42.0-F05032?style=flat-square&logo=git&logoColor=white) ![GitHub](https://img.shields.io/badge/GitHub-latest-181717?style=flat-square&logo=github&logoColor=white) ![GitHub Projects](https://img.shields.io/badge/GitHub%20Projects-latest-181717?style=flat-square&logo=github&logoColor=white)                                                                                           |
+| 영역          | 기술 스택                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+| ------------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **공통**      | ![TypeScript](https://img.shields.io/badge/TypeScript-5.6.3-3178C6?style=flat-square&logo=typescript&logoColor=white) ![WebSocket](https://img.shields.io/badge/WebSocket-8.18.0-010101?style=flat-square&logo=socket.io&logoColor=white) ![TSDoc](https://img.shields.io/badge/TSDoc-0.26.11-3178C6?style=flat-square&logo=typescript&logoColor=white)                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| **Frontend**  | ![React](https://img.shields.io/badge/React-18.3.1-61DAFB?style=flat-square&logo=react&logoColor=white) ![Vite](https://img.shields.io/badge/Vite-5.4.10-646CFF?style=flat-square&logo=vite&logoColor=white) ![Tailwind CSS](https://img.shields.io/badge/Tailwind%20CSS-3.4-38B2AC?style=flat-square&logo=tailwind-css&logoColor=white) ![shadcn/ui](https://img.shields.io/badge/shadcn%2Fui-latest-000000?style=flat-square) ![Vitest](https://img.shields.io/badge/Vitest-latest-6E9F18?style=flat-square&logo=vitest&logoColor=white) ![Testing Library](https://img.shields.io/badge/Testing%20Library-latest-E33332?style=flat-square&logo=testing-library&logoColor=white) ![Storybook](https://img.shields.io/badge/Storybook-8.4.2-FF4785?style=flat-square&logo=storybook&logoColor=white)                               |
+| **Backend**   | ![NestJS](https://img.shields.io/badge/NestJS-10.4.7-E0234E?style=flat-square&logo=nestjs&logoColor=white) ![MySQL](https://img.shields.io/badge/MySQL-2-4479A1?style=flat-square&logo=mysql&logoColor=white) ![SQLite](https://img.shields.io/badge/SQLite-3-003B57?style=flat-square&logo=sqlite&logoColor=white) ![TypeORM](https://img.shields.io/badge/TypeORM-0.3.20-E93524?style=flat-square&logo=typeorm&logoColor=white) ![Swagger](https://img.shields.io/badge/Swagger-8.0.5-85EA2D?style=flat-square&logo=swagger&logoColor=black) ![Jest](https://img.shields.io/badge/Jest-Testing-C21325?style=flat-square&logo=jest&logoColor=white) ![SuperTest](https://img.shields.io/badge/SuperTest-Testing-009688?style=flat-square&logo=testing-library&logoColor=white)                                                     |
+| **인프라**    | ![NCP](https://img.shields.io/badge/Naver%20Cloud%20Platform-latest-03C75A?style=flat-square&logo=naver&logoColor=white) ![Nginx](https://img.shields.io/badge/Nginx-1.24.0-009639?style=flat-square&logo=nginx&logoColor=white) ![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-3.0-2088FF?style=flat-square&logo=github-actions&logoColor=white) ![Docker](https://img.shields.io/badge/Docker-24.0.7-2496ED?style=flat-square&logo=docker&logoColor=white) ![Linux](https://img.shields.io/badge/Linux-Ubuntu%2022.04-FCC624?style=flat-square&logo=linux&logoColor=black) ![Grafana](https://img.shields.io/badge/Grafana-10.2.3-F46800?style=flat-square&logo=grafana&logoColor=white) ![Prometheus](https://img.shields.io/badge/Prometheus-2.43.0-E6522C?style=flat-square&logo=prometheus&logoColor=white) ![k6](https://img.shields.io/badge/k6-0.55.0-7D64FF?style=flat-square&logo=k6&logoColor=white)|
+| **협업 도구** | ![Notion](https://img.shields.io/badge/Notion-2.0.41-000000?style=flat-square&logo=notion&logoColor=white) ![Figma](https://img.shields.io/badge/Figma-latest-F24E1E?style=flat-square&logo=figma&logoColor=white) ![Excalidraw](https://img.shields.io/badge/Excalidraw-latest-6965DB?style=flat-square&logo=excalidraw&logoColor=white) ![Zoom](https://img.shields.io/badge/Zoom-5.17.0-2D8CFF?style=flat-square&logo=zoom&logoColor=white) ![Git](https://img.shields.io/badge/Git-2.42.0-F05032?style=flat-square&logo=git&logoColor=white) ![GitHub](https://img.shields.io/badge/GitHub-latest-181717?style=flat-square&logo=github&logoColor=white) ![GitHub Projects](https://img.shields.io/badge/GitHub%20Projects-latest-181717?style=flat-square&logo=github&logoColor=white)                                          |
 
 ## 🏗 시스템 아키텍처
 
@@ -456,7 +456,7 @@ pnpm run start
 └── ...
 ```
 
-## 팀 소개(표인데 얘는 수정하지 말아주세요)
+## 팀 소개
 
 | [J004 강준현](https://github.com/JunhyunKang)             | [J074 김현우](https://github.com/krokerdile)              | [J086 도선빈](https://github.com/typingmistake)            | [J175 이동현](https://github.com/codemario318)             | [J217 전현민](https://github.com/joyjhm)                  |
 | --------------------------------------------------------- | --------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | --------------------------------------------------------- |

diff --git a/apps/backend/src/play/entities/quiz-summary.entity.ts b/apps/backend/src/play/entities/quiz-summary.entity.ts
@@ -0,0 +1,6 @@
+import { Rank } from './rank.entity';
+
+export interface QuizSummary {
+    readonly ranks: Rank[];
+    readonly endSocketTime?: number;
+}
diff --git a/apps/backend/src/play/entities/rank.entity.ts b/apps/backend/src/play/entities/rank.entity.ts
@@ -0,0 +1,6 @@
+export interface Rank {
+    readonly id: string;
+    readonly nickname: string;
+    readonly score: number;
+    readonly ranking: number;
+}
diff --git a/apps/backend/src/play/play.gateway.ts b/apps/backend/src/play/play.gateway.ts
@@ -15,11 +15,10 @@ import { SendEventMessage } from './entities/send-event.entity';
 import { ClientInfo } from './entities/client-info.entity';
 import { WebSocketWithSession } from '../core/SessionWsAdapter';
 import { RuntimeException } from '@nestjs/core/errors/exceptions';
-import { CLOSE_CODE } from '../common/constants';
 import { SubmitResponseDto } from './dto/submit-response.dto';
-import { clearTimeout } from 'node:timers';
 import { ChatMessage } from 'src/chat/entities/chat-message.entity';
-import { ChatService } from '../chat/chat.service'; // 경로 수정
+import { ChatService } from '../chat/chat.service';
+import { CLOSE_CODE } from '../common/constants'; // 경로 수정
 
 /**
  * 퀴즈 게임에 대한 WebSocket 연결을 관리하는 Gateway입니다.
@@ -248,7 +247,7 @@ export class PlayGateway implements OnGatewayInit {
 
         const clientsIds = summaries.map(({ id }) => id);
 
-        this.clearQuizZone(clientsIds, quizZoneId, endSocketTime);
+        this.clearQuizZone(clientsIds, quizZoneId, endSocketTime - Date.now());
     }
 
     /**
@@ -258,16 +257,16 @@ export class PlayGateway implements OnGatewayInit {
      * - 일반 플레이어가 나가면 퀴즈 존에서 나가고 다른 플레이어에게 나갔다고 알립니다.
      * @param clientIds - 퀴즈존에 참여하고 있는 클라이언트 id 리스트
      * @param quizZoneId - 퀴즈가 끝난 퀴즈존 id
-     * @param endSocketTime - 소켓 연결 종료 시간 종료 시간
+     * @param time - 소켓 연결 종료 시간 종료 시간
      */
-    private clearQuizZone(clientIds: string[], quizZoneId: string, endSocketTime: number) {
+    private clearQuizZone(clientIds: string[], quizZoneId: string, time: number) {
         setTimeout(() => {
             clientIds.forEach((id) => {
                 this.clearClient(id, 'finish');
             });
             this.playService.clearQuizZone(quizZoneId);
             this.chatService.delete(quizZoneId);
-        }, endSocketTime - Date.now());
+        }, time);
     }
 
     /**
@@ -286,7 +285,7 @@ export class PlayGateway implements OnGatewayInit {
 
         if (isHost) {
             this.broadcast(playerIds, 'close');
-            playerIds.forEach((id) => this.clearClient(id, 'Host leave.'));
+            this.clearQuizZone(playerIds, quizZoneId, 0);
         } else {
             this.broadcast(playerIds, 'someone_leave', clientId);
             this.clearClient(clientId, 'Client leave');

diff --git a/apps/backend/src/play/play.service.ts b/apps/backend/src/play/play.service.ts
@@ -304,14 +304,18 @@ export class PlayService {
         const now = Date.now();
         const endSocketTime = now + socketConnectTime;
 
-        return [...players.values()].map(({ id, score, submits }) => ({
+
+        const summaries = [...players.values()].map(({ id, score, submits }) => ({
             id,
             score,
             submits,
             quizzes,
             ranks,
             endSocketTime
         }));
+
+        quizZone.summaries  = {ranks, endSocketTime};
+        return summaries;
     }
 
     public clearQuizZone(quizZoneId: string) {

diff --git a/apps/backend/src/quiz-zone/dto/create-quiz-zone.dto.ts b/apps/backend/src/quiz-zone/dto/create-quiz-zone.dto.ts
@@ -24,7 +24,7 @@ export class CreateQuizZoneDto {
 
     @IsInt({ message: '최대 플레이어 수가 없습니다.' })
     @Min(1, { message: '최소 1명 이상이어야 합니다.' })
-    // @Max(300, { message: '최대 300명까지 가능합니다.' })
+    @Max(300, { message: '최대 300명까지 가능합니다.' })
     readonly limitPlayerCount: number;
 
     @IsNotEmpty({ message: '퀴즈존을 선택해주세요.' })

diff --git a/apps/backend/src/quiz-zone/dto/find-quiz-zone.dto.ts b/apps/backend/src/quiz-zone/dto/find-quiz-zone.dto.ts
@@ -2,6 +2,8 @@ import { PLAYER_STATE, QUIZ_ZONE_STAGE } from '../../common/constants';
 import { CurrentQuizDto } from '../../play/dto/current-quiz.dto';
 import { SubmittedQuiz } from '../entities/submitted-quiz.entity';
 import { ChatMessage } from 'src/chat/entities/chat-message.entity';
+import { Rank } from '../../play/entities/rank.entity';
+import { Quiz } from '../entities/quiz.entity';
 
 /**
  * 퀴즈 게임에 참여하는 플레이어 엔티티
@@ -42,4 +44,10 @@ export interface FindQuizZoneDto {
     readonly currentQuiz?: CurrentQuizDto;
     readonly maxPlayers?: number;
     readonly chatMessages?: ChatMessage[];
+
+    readonly ranks?: Rank[];
+    readonly endSocketTime?: number;
+    readonly score?: number;
+    readonly quizzes?: Quiz[];
+    readonly submits?: SubmittedQuiz[];
 }
diff --git a/apps/backend/src/quiz-zone/entities/quiz-zone.entity.ts b/apps/backend/src/quiz-zone/entities/quiz-zone.entity.ts
@@ -1,6 +1,7 @@
 import { Quiz } from './quiz.entity';
 import { Player } from './player.entity';
 import { QUIZ_ZONE_STAGE } from '../../common/constants';
+import { QuizSummary } from '../../play/entities/quiz-summary.entity';
 /**
  * 퀴즈 게임을 진행하는 공간을 나타내는 퀴즈존 인터페이스
  *
@@ -28,4 +29,5 @@ export interface QuizZone {
     currentQuizStartTime: number;
     currentQuizDeadlineTime: number;
     intervalTime: number;
+    summaries?: QuizSummary;
 }
diff --git a/apps/backend/src/quiz-zone/quiz-zone.controller.spec.ts b/apps/backend/src/quiz-zone/quiz-zone.controller.spec.ts
@@ -81,8 +81,11 @@ describe('QuizZoneController', () => {
             stage: 'LOBBY',
             playerCount: 1,
             maxPlayers: 8,
+            serverTime: 0,
         };
 
+        Date.now = jest.fn().mockReturnValue(0);
+
         it('퀴즈존 정보를 성공적으로 조회한다', async () => {
             const session = { id: 'sessionId' };
             mockQuizZoneService.getQuizZoneInfo.mockResolvedValue(mockQuizZoneInfo);

diff --git a/apps/backend/src/quiz-zone/quiz-zone.controller.ts b/apps/backend/src/quiz-zone/quiz-zone.controller.ts
@@ -68,12 +68,16 @@ export class QuizZoneController {
         @Session() session: Record<string, any>,
         @Param('quizZoneId') quizZoneId: string,
     ) {
-        const quizZoneInfo = this.quizZoneService.getQuizZoneInfo(
+        const serverTime = Date.now();
+        const quizZoneInfo = await this.quizZoneService.getQuizZoneInfo(
             session.id,
             quizZoneId,
             session.quizZoneId,
         );
         session['quizZoneId'] = quizZoneId;
-        return quizZoneInfo;
+        return {
+            ...quizZoneInfo,
+            serverTime,
+        };
     }
 }