Merge branch 'release/0.0.4'

.github/workflows/deploy.yml

@@ -7,6 +7,7 @@ on:
 
 jobs:
   deploy:
+    name: Deploy on Server
     runs-on: [self-hosted, boost-was] # 라벨에 해당하는 runner로 실행
 
     steps:
@@ -18,7 +19,7 @@ jobs:
       - name: Build and Deploy Docker Images
         env:
           NODE_ENV: production
-          MONGODB_URI: ${{ secrets.MONGODB_URI }}
+          MONGO_URI: ${{ secrets.MONGO_URI }}
         run: |
           docker-compose up -d --build
 

.github/workflows/lint_and_test.yml

@@ -1,18 +1,14 @@
 name: Lint and Test
 
 on:
-  push:
-    branches:
-      - main
-      - dev
   pull_request:
     branches:
       - main
       - dev
 
 jobs:
-  lint_and_test:
-    name: Lint and Test
+  lint_and_unit_test:
+    name: Lint and Unit Test
     runs-on: ubuntu-latest
 
     steps:
@@ -35,9 +31,44 @@ jobs:
           cache: "pnpm"
 
       # Run lint
-      - name: Run lint
+      - name: Run Lint
         run: pnpm eslint .
 
-      # Run tests
-      - name: Run tests
+      # Run Unit tests
+      - name: Run Unit Tests
         run: pnpm test
+        env:
+          JWT_SECRET: ${{ secrets.JWT_SECRET }}
+
+  test_building_docker_image:
+    name: Test Building Docker Image
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the repository
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      # Install Docker
+      - name: Install Docker
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y apt-transport-https ca-certificates curl software-properties-common
+          curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
+          echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+          sudo apt-get update
+          sudo apt-get install -y docker-ce docker-ce-cli containerd.io
+
+      # Install Docker Compose
+      - name: Install Docker Compose
+        run: |
+          sudo curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+          sudo chmod +x /usr/local/bin/docker-compose
+
+      # Test Building Docker Images
+      - name: Test Building Docker Images
+        env:
+          NODE_ENV: production
+          MONGO_URI: ${{ secrets.MONGO_URI }}
+        run: |
+          docker-compose build frontend backend

.github/workflows/lint_and_unit_test.yml

@@ -0,0 +1,47 @@
+name: Lint and Unit Test
+
+on:
+  push:
+    branches:
+      - "**"
+
+jobs:
+  lint_and_unit_test:
+    name: Lint and Unit Test
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the repository
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Install pnpm
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+          run_install: true
+
+      # Set up Node.js
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "pnpm"
+
+      # Run build
+      - name: Install dependencies and build packages
+        run: |
+          pnpm install --frozen-lockfile
+          pnpm --filter @noctaCrdt build
+          pnpm --filter server build
+
+      # Run lint
+      - name: Run Lint
+        run: pnpm eslint .
+
+      # Run Unit tests
+      - name: Run Unit Tests
+        run: pnpm test
+        env:
+          JWT_SECRET: ${{ secrets.JWT_SECRET }}

.gitignore

@@ -4,4 +4,7 @@
 */dist
 /build
 .DS_Store
-.env
+.env
+
+# Jest globalConfig file
+../globalConfig.json

@noctaCrdt/Crdt.ts

@@ -1,129 +1,111 @@
 import { LinkedList } from "./LinkedList";
-import { NodeId, Node } from "./Node";
-import { RemoteInsertOperation, RemoteDeleteOperation, SerializedProps } from "./Interfaces";
+import { CharId, BlockId, NodeId } from "./NodeId";
+import { Node, Char, Block } from "./Node";
+import { RemoteDeleteOperation, RemoteInsertOperation, SerializedProps } from "./Interfaces";
 
-export class CRDT {
+export class CRDT<T extends Node<NodeId>> {
   clock: number;
   client: number;
-  textLinkedList: LinkedList;
+  LinkedList: LinkedList<T>;
 
   constructor(client: number) {
-    this.clock = 0; // 이 CRDT의 논리적 시간 설정
+    this.clock = 0;
     this.client = client;
-    this.textLinkedList = new LinkedList();
+    this.LinkedList = new LinkedList<T>();
   }
 
-  /**
-   * 로컬에서 삽입 연산을 수행하고, 원격에 전파할 연산 객체를 반환합니다.
-   * @param index 삽입할 인덱스
-   * @param value 삽입할 값
-   * @returns 원격에 전파할 삽입 연산 객체
-   */
   localInsert(index: number, value: string): RemoteInsertOperation {
-    const id = new NodeId((this.clock += 1), this.client);
-    const remoteInsertion = this.textLinkedList.insertAtIndex(index, value, id);
+    const id =
+      this instanceof BlockCRDT
+        ? new CharId(this.clock + 1, this.client)
+        : new BlockId(this.clock + 1, this.client);
+
+    const remoteInsertion = this.LinkedList.insertAtIndex(index, value, id);
+    this.clock += 1;
     return { node: remoteInsertion.node };
   }
 
-  /**
-   * 로컬에서 삭제 연산을 수행하고, 원격에 전파할 연산 객체를 반환합니다.
-   * @param index 삭제할 인덱스
-   * @returns 원격에 전파할 삭제 연산 객체
-   */
   localDelete(index: number): RemoteDeleteOperation {
-    // 유효한 인덱스인지 확인
-    if (index < 0 || index >= this.textLinkedList.spread().length) {
-      throw new Error(`유효하지 않은 인덱스입니다: ${index}`);
+    if (index < 0 || index >= this.LinkedList.spread().length) {
+      throw new Error(`Invalid index: ${index}`);
     }
 
-    // 삭제할 노드 찾기
-    const nodeToDelete = this.textLinkedList.findByIndex(index);
+    const nodeToDelete = this.LinkedList.findByIndex(index);
     if (!nodeToDelete) {
-      throw new Error(`삭제할 노드를 찾을 수 없습니다. 인덱스: ${index}`);
+      throw new Error(`Node not found at index: ${index}`);
     }
 
-    // 삭제 연산 객체 생성
     const operation: RemoteDeleteOperation = {
       targetId: nodeToDelete.id,
       clock: this.clock + 1,
     };
 
-    // 로컬 삭제 수행
-    this.textLinkedList.deleteNode(nodeToDelete.id);
-
-    // 클록 업데이트
+    this.LinkedList.deleteNode(nodeToDelete.id);
     this.clock += 1;
 
     return operation;
   }
 
-  /**
-   * 원격에서 삽입 연산을 수신했을 때 처리합니다.
-   * @param operation 원격 삽입 연산 객체
-   */
   remoteInsert(operation: RemoteInsertOperation): void {
-    const newNodeId = new NodeId(operation.node.id.clock, operation.node.id.client);
-    const newNode = new Node(operation.node.value, newNodeId);
+    const NodeIdClass = this instanceof BlockCRDT ? CharId : BlockId;
+    const NodeClass = this instanceof BlockCRDT ? Char : Block;
+
+    const newNodeId = new NodeIdClass(operation.node.id.clock, operation.node.id.client);
+    const newNode = new NodeClass(operation.node.value, newNodeId) as T;
     newNode.next = operation.node.next;
     newNode.prev = operation.node.prev;
-    this.textLinkedList.insertById(newNode);
-    // 동기화 논리적 시간
+
+    this.LinkedList.insertById(newNode);
+
     if (this.clock <= newNode.id.clock) {
       this.clock = newNode.id.clock + 1;
     }
   }
 
-  /**
-   * 원격에서 삭제 연산을 수신했을때 처리합니다.
-   * @param operation 원격 삭제 연산 객체
-   */
   remoteDelete(operation: RemoteDeleteOperation): void {
     const { targetId, clock } = operation;
     if (targetId) {
-      this.textLinkedList.deleteNode(targetId);
+      this.LinkedList.deleteNode(targetId);
     }
-    // 동기화 논리적 시간
     if (this.clock <= clock) {
       this.clock = clock + 1;
     }
   }
 
-  /**
-   * 현재 텍스트를 문자열로 반환합니다.
-   * @returns 현재 텍스트
-   */
   read(): string {
-    return this.textLinkedList.stringify();
-  }
-
-  /**
-   * 현재 텍스트를 배열로 반환합니다.
-   * @returns 현재 텍스트 배열
-   */
-  spread(): string[] {
-    return this.textLinkedList.spread();
+    return this.LinkedList.stringify();
   }
 
-  /**
-   * textLinkedList를 반환하는 getter 메서드
-   * @returns LinkedList 인스턴스
-   */
-  public getTextLinkedList(): LinkedList {
-    return this.textLinkedList;
+  spread(): T[] {
+    return this.LinkedList.spread();
   }
 
-  /**
-   * CRDT의 상태를 직렬화 가능한 객체로 반환합니다.
-   * @returns 직렬화 가능한 CRDT 상태
-   */
-  serialize(): SerializedProps {
+  serialize(): SerializedProps<T> {
     return {
       clock: this.clock,
       client: this.client,
-      textLinkedList: {
-        head: this.textLinkedList.head,
-        nodeMap: this.textLinkedList.nodeMap,
+      LinkedList: {
+        head: this.LinkedList.head,
+        nodeMap: this.LinkedList.nodeMap,
       },
     };
   }
 }
+
+export class EditorCRDT extends CRDT<Block> {
+  currentBlock: Block | null;
+
+  constructor(client: number) {
+    super(client);
+    this.currentBlock = null;
+  }
+}
+
+export class BlockCRDT extends CRDT<Char> {
+  currentCaret: number;
+
+  constructor(client: number) {
+    super(client);
+    this.currentCaret = 0;
+  }
+}