Merge pull request #364 from boostcampwm-2024/develop

안정 버전 main 병합

Author: Tolerblanc

Diff for: .dockerignore

@@ -0,0 +1,46 @@
+
+# compiled output
+*/dist
+*/node_modules
+dist
+node_modules
+dist-ssr
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+db.sqlite

Diff for: .gitignore

@@ -3,6 +3,9 @@
 .env*
 *.local
 .turbo
+*.crt
+*.key
+!Dockerfile.local
 
 # compiled output
 */dist
@@ -49,3 +52,6 @@ lerna-debug.log*
 !.vscode/launch.json
 !.vscode/extensions.json
 db.sqlite
+
+*.crt
+*.key

Diff for: README.md

@@ -1,6 +1,5 @@
 ![Sprint 33](https://github.com/user-attachments/assets/2b23184d-90ed-458d-9dc4-dab9579c1e48)
 
-🪝 [**배포 링크**](http://211.188.48.107:3000/)
 
 <br>
 
@@ -9,35 +8,92 @@
 
 
 
+
+
 <div align="center">
 
-   ![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fboostcampwm-2024%2Fweb15-OctoDocs&count_bg=%23000000&title_bg=%23000000&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false) [![Group 83 (2)](https://github.com/user-attachments/assets/2d106d94-430c-47bc-a9e2-1f0026f76c2f)](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki) [![Group 84 (2)](https://github.com/user-attachments/assets/b29b191b-8172-42a9-b541-40fdb8f165f3)](https://github.com/orgs/boostcampwm-2024/projects/120) 
+   ![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fboostcampwm-2024%2Fweb15-OctoDocs&count_bg=%23000000&title_bg=%23000000&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false) [![Group 112 (1)](https://github.com/user-attachments/assets/b7b4387e-ffe9-4469-82b7-c14509282d86)](https://octodocs.site)
+ [![Group 83 (2)](https://github.com/user-attachments/assets/2d106d94-430c-47bc-a9e2-1f0026f76c2f)](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki) [![Group 84 (2)](https://github.com/user-attachments/assets/b29b191b-8172-42a9-b541-40fdb8f165f3)](https://github.com/orgs/boostcampwm-2024/projects/120) 
 
 </div>
 
-## 🐙 프로젝트 소개
+# 🐙 프로젝트 소개
+
+### 🕸️ 관계형 지식 관리 툴 
+
+
+> 문서들을 작성하고 연결하면서 문서들 간의 연관 관계를 시각적으로 확인 가능.
+
+https://github.com/user-attachments/assets/1ac81d56-a0ce-403c-9e3f-7ba092b6a5b6
+
+
+<br>
+
+
+### 🧸 실시간 동시 편집 및 협업 기능
+
+> 실시간으로 다른 사용자들과 동시 편집 및 협업 가능.
+
+https://github.com/user-attachments/assets/ad1f6dc9-50af-46e4-bac4-267b1432b301
+
+<br>
+
+
+### ⛺️ 워크스페이스 초대 기능
+
+> 개별 워크 스페이스에 다른 사용자들을 초대해서 함께 이용 가능.
+
+<br>
+
+
+# 🛠️ 프로젝트 구조
+
+### 🖥️ System Architecture
+
+![image (13)](https://github.com/user-attachments/assets/60bfb7a1-3c1a-436d-b961-5a30dc9dba7f)
+
+
+### 🐳 Sequence Diagram 
+
+<div align="center">
+
+
+![image (14)](https://github.com/user-attachments/assets/ea6853d8-398e-4448-ae0a-07bffc653722)
+
+</div>
+
+# 🗺️ 프로젝트 타임라인
+
+![Overview-variant (18)](https://github.com/user-attachments/assets/a503f8fe-bab9-4cf3-8d9d-98ff43ab0c3e)
+
+
+# 🚧 문제와 해결과정
+
+### 실시간 편집 구현 과정
+
+Octodocs 팀은 핵심 기능인 에디터와 노드 캔버스의 **실시간 편집**을 위해 **CRDT** 라이브러리인 **YJS**와 **SocketIO**를 어떻게 활용 했을까요? [🔗 링크 준비 중](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki)
+
+### 데이터 흐름 변경
 
-> “Notion을 쓰고 있는데, 문서끼리 관계 표현이 너무 어려워요…”
-> 
-> “Obsidian으로 노트 정리를 잘 하고 있는데, 공유하기가 너무 불편해요…”
+YDoc과 소켓을 사용하면서도 RESTful 방식으로 일부 상태를 관리하던 구조를, YDoc 중심의 **단일 truth source**와 소켓 기반 **단방향 흐름**으로 단순화했습니다. 그 결과 모든 상태가 YDoc을 통해 일관성 있게 관리되며, 클라이언트와 서버 간 데이터 흐름도 간소화되었습니다. 중복 관리와 데이터 충돌을 줄이기 위한 이런 **data flow 변화**의 핵심은 무엇이었을까요? [🔗 링크 준비 중](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki)
 
-이런 고민, 이제 **OctoDocs**로 해결해보세요!!
+### FE 프로젝트 구조 개선 과정
 
-- **실시간 협업**이 지원되는 **연결형 지식관리 도구**입니다.
-- **실시간 동시편집** 과 **마크다운** 형식 문서편집을 지원합니다.
+Octodocs 팀은 기존 **프로젝트 구조**의 문제점을 어떻게 파악했고, 어떤 방법으로 개선을 했을까요? [🔗 링크 준비 중](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki)
 
-## 📢 핵심 기능
+### 드래그 이벤트 발생 시 생기는 쿼리 최적화
 
-![image](https://github.com/user-attachments/assets/4c0010db-d4a3-455f-ab26-03e04c85e46e)
+**노트 카드를 드래그** 할 때, 그 위치를 DB에 저장하기 위해 **너무 많은 쿼리가 발생**하는 문제가 있었습니다. 이를 위해 **쿼리를 최적화**해야할 필요성이 생겼는데 이를 어떻게 해결할 수 있었을까요? [🔗 링크 준비 중](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki)
 
-## 🛠️ 시스템 아키텍처
+### redis 캐싱으로 데이터베이스 부하 감소
 
-v.241115
+실시간 문서 동시 편집에서 발생하는 굉장히 많은 변경 사항을 모두 데이터베이스에 저장하기에는 데이터베이스 부하가 너무 많이 발생했고, Octodocs 팀은 redis를 도입하기로 결정했습니다. 저희는 왜 redis를 도입하기로 결정했고 또 redis를 어떻게 활용했을까요? [🔗 링크](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/redis%EB%A5%BC-%ED%86%B5%ED%95%B4-%EB%8D%B0%EC%9D%B4%ED%84%B0%EB%B2%A0%EC%9D%B4%EC%8A%A4-%EC%BF%BC%EB%A6%AC-%EC%A4%84%EC%9D%B4%EA%B8%B0)
 
-![octodocs-architecture](https://github.com/user-attachments/assets/18461bff-25ad-439a-ada0-73f4ea37e4d7)
+### 개발 환경, 배포 환경 및 CI/CD에 대한 개선 과정
 
+Octodocs 팀은 사용자 경험 향상은 물론, 일관된 코드 품질 유지와 개발자 친화적인 쾌적한 개발 환경 조성을 위해 많은 노력을 기울였습니다. 멀티 레포에서 모노레포로의 전환, GitHub Actions를 활용한 CI/CD 구축, Docker와 Docker Compose의 도입까지—우리는 어떤 변화를 거쳤을까요? [🔗 링크 준비 중](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki)
 
-## 🧸 팀원 소개
+# 🧸 팀원 소개
 | [J032_김동준](https://github.com/djk01281) | [J075_김현준](https://github.com/Tolerblanc) | [J097_민서진](https://github.com/summersummerwhy) | [J162_유성민](https://github.com/ezcolin2) | [J248_진예원](https://github.com/yewonJin) |
 |:----------------------------------------:|:------------------------------------------:|:------------------------------------------------:|:----------------------------------------:|:----------------------------------------:|
 | <img width="204" alt="스크린샷 2024-10-29 오후 4" src="https://github.com/user-attachments/assets/71a5a38e-f60c-4f60-97e3-30d7a73a3c77"> | <img width="204" alt="스크린샷 2024-10-29 오후 11 41 04" src="https://github.com/user-attachments/assets/e093f852-a6ea-4937-b0ce-b89276bd7135"> | <img width="204" alt="스크린샷 2024-10-29 오후 11 41 55" src="https://github.com/user-attachments/assets/0f638ba9-a1ad-47b8-a874-957c0119384c"> | <img width="204" alt="스크린샷 2024-10-29 오후 11 41 00" src="https://github.com/user-attachments/assets/1d77b650-70f1-4dee-9489-dc0122b7c9ff"> | <img width="204" alt="스크린샷 2024-10-29 오후 11 40 31" src="https://github.com/user-attachments/assets/db99b6b2-ae06-4758-8687-17ebb860a52b"> |

Diff for: apps/backend/package.json

@@ -9,7 +9,7 @@
     "build": "nest build",
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
     "start": "nest start",
-    "dev": "nest start --watch",
+    "dev": "nest start --tsc --watch --preserveWatchOutput --watchAssets",
     "start:debug": "nest start --debug --watch",
     "start:prod": "node dist/main",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
@@ -30,25 +30,32 @@
     "@nestjs/platform-express": "^10.0.0",
     "@nestjs/platform-socket.io": "^10.4.8",
     "@nestjs/platform-ws": "^10.4.7",
+    "@nestjs/schedule": "^4.1.1",
     "@nestjs/serve-static": "^4.0.2",
     "@nestjs/swagger": "^8.0.5",
     "@nestjs/typeorm": "^10.0.2",
     "@nestjs/websockets": "^10.4.8",
+    "@theinternetfolks/snowflake": "^1.3.0",
     "@types/multer": "^1.4.12",
+    "@types/redlock": "^4.0.7",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.1",
+    "cookie-parser": "^1.4.7",
+    "ioredis": "^5.4.1",
     "lib0": "^0.2.98",
-    "node-ts-cache": "^4.4.0",
-    "node-ts-cache-storage-memory": "^4.4.0",
     "passport": "^0.7.0",
     "passport-kakao": "^1.0.1",
     "passport-naver": "^1.0.6",
     "path": "^0.12.7",
+    "pg": "^8.13.1",
+    "prosemirror-view": "^1.37.0",
+    "redlock": "^5.0.0-beta.2",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.8.1",
     "socket.io": "^4.8.1",
     "sqlite3": "^5.1.7",
     "typeorm": "^0.3.20",
+    "uuid": "^11.0.3",
     "ws": "^8.14.2",
     "y-prosemirror": "^1.2.12",
     "y-protocols": "^1.0.6",

Diff for: apps/backend/src/app.module.ts

@@ -10,15 +10,23 @@ import { Page } from './page/page.entity';
 import { Edge } from './edge/edge.entity';
 import { Node } from './node/node.entity';
 import { User } from './user/user.entity';
+import { Workspace } from './workspace/workspace.entity';
+import { Role } from './role/role.entity';
 import { YjsModule } from './yjs/yjs.module';
 import * as path from 'path';
 import { ServeStaticModule } from '@nestjs/serve-static';
 import { UploadModule } from './upload/upload.module';
 import { AuthModule } from './auth/auth.module';
 import { UserModule } from './user/user.module';
+import { WorkspaceModule } from './workspace/workspace.module';
+import { RoleModule } from './role/role.module';
+import { TasksModule } from './tasks/tasks.module';
+import { ScheduleModule } from '@nestjs/schedule';
+import { RedLockModule } from './red-lock/red-lock.module';
 
 @Module({
   imports: [
+    ScheduleModule.forRoot(),
     ServeStaticModule.forRoot({
       rootPath: path.join(__dirname, '..', '..', 'frontend', 'dist'),
     }),
@@ -30,9 +38,16 @@ import { UserModule } from './user/user.module';
       imports: [ConfigModule],
       inject: [ConfigService],
       useFactory: (configService: ConfigService) => ({
-        type: 'sqlite',
+
+        // type: 'sqlite',
+        // database: 'db.sqlite',
+        type: 'postgres',
+        host: configService.get('DB_HOST'),
+        port: configService.get('DB_PORT'),
+        username: configService.get('DB_USER'),
+        password: configService.get('DB_PASSWORD'),
         database: configService.get('DB_NAME'),
-        entities: [Node, Page, Edge, User],
+        entities: [Node, Page, Edge, User, Workspace, Role],
         logging: true,
         synchronize: true,
       }),
@@ -44,6 +59,10 @@ import { UserModule } from './user/user.module';
     UploadModule,
     AuthModule,
     UserModule,
+    WorkspaceModule,
+    RoleModule,
+    TasksModule,
+    RedLockModule,
   ],
   controllers: [AppController],
   providers: [AppService],

Diff for: apps/backend/src/auth/auth.controller.spec.ts

@@ -1,19 +1,18 @@
 import { Test, TestingModule } from '@nestjs/testing';
 import { AuthController } from './auth.controller';
 import { AuthService } from './auth.service';
-import { JwtService } from '@nestjs/jwt';
-import { InvalidTokenException } from '../exception/invalid.exception';
-// import { LoginRequiredException } from '../exception/login.exception';
-// TODO: 테스트 코드 개선
+import { JwtAuthGuard } from './guards/jwt-auth.guard';
+import { TokenService } from './token/token.service';
+import { User } from '../user/user.entity';
+
 describe('AuthController', () => {
-  let authController: AuthController;
+  let controller: AuthController;
+  let authService: AuthService;
 
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
       controllers: [AuthController],
       providers: [
-        AuthService,
-        JwtService,
         {
           provide: AuthService,
           useValue: {
@@ -23,58 +22,42 @@ describe('AuthController', () => {
           },
         },
         {
-          provide: JwtService,
+          provide: TokenService,
           useValue: {
-            sign: jest.fn().mockReturnValue('test-token'),
-            verify: jest.fn((token: string) => {
-              if (token === 'invalid-token') {
-                throw new InvalidTokenException();
-              }
-              return { sub: 1, provider: 'naver' };
-            }),
+            generateAccessToken: jest.fn(() => 'mockedAccessToken'),
+            generateRefreshToken: jest.fn(() => 'mockedRefreshToken'),
+            refreshAccessToken: jest.fn(() => 'mockedAccessToken'),
           },
         },
       ],
-    }).compile();
+    })
+      .overrideGuard(JwtAuthGuard)
+      .useValue({
+        canActivate: jest.fn(() => true),
+      })
+      .compile();
 
-    authController = module.get<AuthController>(AuthController);
+    controller = module.get<AuthController>(AuthController);
+    authService = module.get<AuthService>(AuthService);
   });
 
   it('컨트롤러 클래스가 정상적으로 인스턴스화된다.', () => {
-    expect(authController).toBeDefined();
+    expect(controller).toBeDefined();
   });
 
   describe('getProfile', () => {
     it('JWT 토큰이 유효한 경우 profile을 return한다.', async () => {
       const req = {
-        user: { sub: 1, email: '[email protected]', provider: 'naver' },
+        user: { sub: 1 },
       } as any;
-      const result = await authController.getProfile(req);
+      const returnedUser = { id: 1, snowflakeId: 'snowflake-id-1' } as User;
+      jest.spyOn(authService, 'findUserById').mockResolvedValue(returnedUser);
+
+      const result = await controller.getProfile(req);
       expect(result).toEqual({
         message: '인증된 사용자 정보',
-        user: req.user,
+        snowflakeId: returnedUser.snowflakeId,
       });
     });
-
-    // it('JWT 토큰이 유효가지 않은 경우 InvalidTokenException을 throw한다.', async () => {
-    //   const req = {
-    //     headers: { authorization: 'Bearer invalid-token' },
-    //     user: undefined,
-    //   } as any;
-    //   try {
-    //     await authController.getProfile(req);
-    //   } catch (error) {
-    //     expect(error).toBeInstanceOf(InvalidTokenException);
-    //   }
-    // });
-
-    // it('JWT 토큰이 없는 경우 LoginRequiredException을 throw한다.', async () => {
-    //   const req = { headers: {}, user: undefined } as any;
-    //   try {
-    //     await authController.getProfile(req);
-    //   } catch (error) {
-    //     expect(error).toBeInstanceOf(LoginRequiredException);
-    //   }
-    // });
   });
 });