Merge branch 'release/0.0.2'

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,8 +1,4 @@
-## 📋 개요
-
-- 이번 PR에서 해결하려는 문제 또는 구현한 기능에 대한 간단한 설명을 작성합니다.
-
-## 📝 변경 사항 요약
+## 📝 변경 사항
 
 - 변경된 주요 사항을 bullet point로 정리하여 작성합니다.
 

.github/workflows/auto_merge_approved_pr.yml

@@ -0,0 +1,77 @@
+name: "Auto Merge Approved PRs"
+
+on:
+  pull_request_review:
+    types: [submitted]
+
+jobs:
+  auto_merge:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Check Approvals"
+        id: check
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          result-encoding: string
+          script: |
+            const pull_number = context.payload.pull_request.number;
+            const reviews = await github.rest.pulls.listReviews({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: pull_number,
+            });
+            const approvals = reviews.data.filter(review => review.state === 'APPROVED');
+            const approvalCount = approvals.length;
+            core.info(`PR #${pull_number} has ${approvalCount} approval(s).`);
+            return approvalCount >= 2;
+      - name: "Merge PR"
+        if: ${{ steps.check.outputs.result == 'true' }}
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const pull_number = context.payload.pull_request.number;
+
+            // PR 정보 및 병합 가능 상태 확인
+            let pr;
+            for (let i = 0; i < 5; i++) { // 최대 5회 재시도
+              const { data } = await github.rest.pulls.get({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                pull_number: pull_number,
+              });
+              pr = data;
+
+              if (pr.state !== 'open') {
+                core.info(`PR #${pull_number} is not open (state: ${pr.state}).`);
+                return;
+              }
+
+              if (pr.mergeable === true) {
+                break; // 병합 가능하면 루프 종료
+              } else if (pr.mergeable === false) {
+                core.info(`PR #${pull_number} cannot be merged due to conflicts or other issues.`);
+                return;
+              } else {
+                // mergeable이 null인 경우 (계산 중), 잠시 대기 후 재시도
+                await new Promise(resolve => setTimeout(resolve, 2000)); // 2초 대기
+              }
+            }
+
+            if (pr.mergeable !== true) {
+              core.info(`PR #${pull_number} mergeable status is unknown after retries.`);
+              return;
+            }
+
+            // PR 병합 시도
+            try {
+              await github.rest.pulls.merge({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                pull_number: pull_number,
+              });
+              core.info(`PR #${pull_number} has been merged successfully.`);
+            } catch (error) {
+              core.info(`Failed to merge PR #${pull_number}: ${error.message}`);
+            }

.github/workflows/deploy.yml

@@ -0,0 +1,27 @@
+name: Deploy on Server
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: [self-hosted, boost-was] # 라벨에 해당하는 runner로 실행
+
+    steps:
+      # 1. 레포지토리 클론
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      # 2. Docker Compose로 서비스 빌드 및 재시작
+      - name: Build and Deploy Docker Images
+        env:
+          NODE_ENV: production
+          MONGODB_URI: ${{ secrets.MONGODB_URI }}
+        run: |
+          docker-compose up -d --build
+
+      # 3. Clean up Old Images
+      - name: Remove Dangling Images
+        run: docker image prune -f

.github/workflows/lint_and_test.yml

@@ -0,0 +1,43 @@
+name: Lint and Test
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+    branches:
+      - main
+      - dev
+
+jobs:
+  lint_and_test:
+    name: Lint and 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 lint
+      - name: Run lint
+        run: pnpm eslint .
+
+      # Run tests
+      - name: Run tests
+        run: pnpm test

.gitignore

@@ -1,7 +1,7 @@
 /node_modules
 **/node_modules
 
-/dist
+*/dist
 /build
 .DS_Store
 .env

.prettierrc

@@ -1,10 +1,12 @@
 {
-  "semi": true,
-  "trailingComma": "all",
-  "singleQuote": true,
+  "arrowParens": "always",
   "printWidth": 100,
   "tabWidth": 2,
-  "arrowParens": "always",
-  "endOfLine": "auto",
-  "bracketSpacing": true
-}
+  "jsxSingleQuote": false,
+  "singleQuote": false,
+
+  "plugins": ["@pandabox/prettier-plugin"],
+  "pandaFirstProps": ["as", "className", "layerStyle", "textStyle"],
+  "pandaStylePropsFirst": true,
+  "pandaSortOtherProps": true
+}

.vscode/settings.json

@@ -0,0 +1,15 @@
+{
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "eslint.workingDirectories": [
+    {
+      "pattern": "./packages/*/"
+    }
+  ],
+  "eslint.useFlatConfig": true,
+  "eslint.validate": ["javascript", "typescript", "javascriptreact", "html", "typescriptreact"],
+  "eslint.enable": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "always"
+  }
+}

@noctaCrdt/Crdt.ts

@@ -0,0 +1,129 @@
+import { LinkedList } from "./LinkedList";
+import { NodeId, Node } from "./Node";
+import { RemoteInsertOperation, RemoteDeleteOperation, SerializedProps } from "./Interfaces";
+
+export class CRDT {
+  clock: number;
+  client: number;
+  textLinkedList: LinkedList;
+
+  constructor(client: number) {
+    this.clock = 0; // 이 CRDT의 논리적 시간 설정
+    this.client = client;
+    this.textLinkedList = new LinkedList();
+  }
+
+  /**
+   * 로컬에서 삽입 연산을 수행하고, 원격에 전파할 연산 객체를 반환합니다.
+   * @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);
+    return { node: remoteInsertion.node };
+  }
+
+  /**
+   * 로컬에서 삭제 연산을 수행하고, 원격에 전파할 연산 객체를 반환합니다.
+   * @param index 삭제할 인덱스
+   * @returns 원격에 전파할 삭제 연산 객체
+   */
+  localDelete(index: number): RemoteDeleteOperation {
+    // 유효한 인덱스인지 확인
+    if (index < 0 || index >= this.textLinkedList.spread().length) {
+      throw new Error(`유효하지 않은 인덱스입니다: ${index}`);
+    }
+
+    // 삭제할 노드 찾기
+    const nodeToDelete = this.textLinkedList.findByIndex(index);
+    if (!nodeToDelete) {
+      throw new Error(`삭제할 노드를 찾을 수 없습니다. 인덱스: ${index}`);
+    }
+
+    // 삭제 연산 객체 생성
+    const operation: RemoteDeleteOperation = {
+      targetId: nodeToDelete.id,
+      clock: this.clock + 1,
+    };
+
+    // 로컬 삭제 수행
+    this.textLinkedList.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);
+    newNode.next = operation.node.next;
+    newNode.prev = operation.node.prev;
+    this.textLinkedList.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);
+    }
+    // 동기화 논리적 시간
+    if (this.clock <= clock) {
+      this.clock = clock + 1;
+    }
+  }
+
+  /**
+   * 현재 텍스트를 문자열로 반환합니다.
+   * @returns 현재 텍스트
+   */
+  read(): string {
+    return this.textLinkedList.stringify();
+  }
+
+  /**
+   * 현재 텍스트를 배열로 반환합니다.
+   * @returns 현재 텍스트 배열
+   */
+  spread(): string[] {
+    return this.textLinkedList.spread();
+  }
+
+  /**
+   * textLinkedList를 반환하는 getter 메서드
+   * @returns LinkedList 인스턴스
+   */
+  public getTextLinkedList(): LinkedList {
+    return this.textLinkedList;
+  }
+
+  /**
+   * CRDT의 상태를 직렬화 가능한 객체로 반환합니다.
+   * @returns 직렬화 가능한 CRDT 상태
+   */
+  serialize(): SerializedProps {
+    return {
+      clock: this.clock,
+      client: this.client,
+      textLinkedList: {
+        head: this.textLinkedList.head,
+        nodeMap: this.textLinkedList.nodeMap,
+      },
+    };
+  }
+}

@noctaCrdt/Interfaces.ts

@@ -0,0 +1,32 @@
+import { NodeId, Node } from "./Node";
+
+export interface InsertOperation {
+  node: Node;
+}
+
+export interface DeleteOperation {
+  targetId: NodeId | null;
+  clock: number;
+}
+export interface RemoteInsertOperation {
+  node: Node;
+}
+
+export interface RemoteDeleteOperation {
+  targetId: NodeId | null;
+  clock: number;
+}
+
+export interface CursorPosition {
+  clientId: number;
+  position: number;
+}
+
+export interface SerializedProps {
+  clock: number;
+  client: number;
+  textLinkedList: {
+    head: NodeId | null;
+    nodeMap: { [key: string]: Node };
+  };
+}