Test/#333-K: CRDT 테스트 케이스 추가 (#337)

* test: remoteDeletion에 대한 convergence 테스트

* docs: 주석으로 테스트케이스 의존성 명시

* chore: test 폴더 생성 및 utils 분리

* refactor: convergenceCheck 메서드 개선

확인이 필요한 remote site CRDT들을 매개변수로 받도록 변경

* test: 예외 케이스 테스트

* fix: 타입 에러 수정

* chore: tsconfig 추가

필요한 파일인데 서버 빌드하면서 삭제했나봐요

* fix: 테스트 케이스 설명 수정

* Test/C: CRDT 테스트 케이스 수정 및 예외 케이스 추가 (#362)

* test: 의도가 잘 보일 수 있도록 수정 및 예외 케이스 추가

* fix: localDelete 테스트 메서드 수정 및 에러 throw

Co-authored-by: W. Cho <[email protected]>

* refactor: convergence test에 beforeEach-arrange 추가

Co-authored-by: W. Cho <[email protected]>

Author: se030

@wabinar/crdt/convergence.test.ts

@@ -111,11 +111,11 @@ export default class LinkedList {
 
       const prevNode = this.findByIndex(index - 1);
 
-      if (!prevNode.next) return null;
+      if (!prevNode.next) throw new Error();
 
       const targetNode = this.getNode(prevNode.next);
 
-      if (!targetNode) return null;
+      if (!targetNode) throw new Error();
 
       this.deleteNode(targetNode.id);
       prevNode.next = targetNode.next;
@@ -215,7 +215,7 @@ export default class LinkedList {
 
   spread(): string[] {
     let node: Node | null = this.getHeadNode();
-    let result = [];
+    let result: string[] = [];
 
     while (node) {
       result.push(node.value);

@wabinar/crdt/crdt.test.ts

@@ -0,0 +1,92 @@
+import CRDT from '../index';
+import LinkedList from '../linked-list';
+import { convergenceCheck, remoteInsertThroughSocket } from './utils';
+
+let 원희, 주영, 도훈, 세영, remoteSites;
+
+const arrange = () => {
+  const 원희remotes = [원희.localInsert(-1, '녕'), 원희.localInsert(-1, '안')];
+
+  [주영, 도훈, 세영].forEach((나) => {
+    원희remotes.forEach((op) => remoteInsertThroughSocket(나, op));
+  });
+};
+
+describe('Convergence', () => {
+  beforeEach(() => {
+    원희 = new CRDT(1, new LinkedList());
+    주영 = new CRDT(2, new LinkedList());
+    도훈 = new CRDT(3, new LinkedList());
+    세영 = new CRDT(4, new LinkedList());
+
+    remoteSites = [원희, 주영, 도훈, 세영];
+
+    arrange();
+  });
+
+  it('하나의 site에서 삽입', () => {
+    arrange();
+
+    convergenceCheck(remoteSites);
+  });
+
+  it('여러 site에서 같은 위치에 삽입', () => {
+    const 도훈remote = 도훈.localInsert(0, '왭');
+    const 세영remote = 세영.localInsert(0, '?');
+
+    remoteInsertThroughSocket(도훈, 세영remote);
+    remoteInsertThroughSocket(세영, 도훈remote);
+
+    [원희, 주영].forEach((나) => {
+      remoteInsertThroughSocket(나, 도훈remote);
+      remoteInsertThroughSocket(나, 세영remote);
+    });
+
+    convergenceCheck(remoteSites);
+  });
+
+  it('여러 site에서 다른 위치에 삽입', () => {
+    const 원희remote = 원희.localInsert(0, '네');
+    const 주영remote = 주영.localInsert(1, '!');
+
+    remoteInsertThroughSocket(원희, 주영remote);
+    remoteInsertThroughSocket(주영, 원희remote);
+
+    [도훈, 세영].forEach((나) => {
+      remoteInsertThroughSocket(나, 원희remote);
+      remoteInsertThroughSocket(나, 주영remote);
+    });
+
+    convergenceCheck(remoteSites);
+  });
+
+  it('여러 site에서 같은 위치 삭제', () => {
+    const 도훈remote = 도훈.localDelete(0);
+    const 세영remote = 세영.localDelete(0);
+
+    도훈.remoteDelete(세영remote);
+    세영.remoteDelete(도훈remote);
+
+    [원희, 주영].forEach((나) => {
+      나.remoteDelete(세영remote);
+      나.remoteDelete(도훈remote);
+    });
+
+    convergenceCheck(remoteSites);
+  });
+
+  it('여러 site에서 다른 위치 삭제', () => {
+    const 원희remote = 원희.localDelete(0);
+    const 주영remote = 주영.localDelete(1);
+
+    원희.remoteDelete(주영remote);
+    주영.remoteDelete(원희remote);
+
+    [도훈, 세영].forEach((나) => {
+      나.remoteDelete(원희remote);
+      나.remoteDelete(주영remote);
+    });
+
+    convergenceCheck(remoteSites);
+  });
+});

@wabinar/crdt/linked-list.ts

@@ -0,0 +1,61 @@
+import CRDT from '../index';
+import LinkedList from '../linked-list';
+
+describe('CRDT Local operations', () => {
+  let 나;
+
+  beforeEach(() => {
+    const initialStructure = new LinkedList();
+    나 = new CRDT(1, initialStructure);
+  });
+
+  describe('localInsert()', () => {
+    it('head 위치 삽입에 성공한다.', () => {
+      // act
+      나.localInsert(-1, '녕');
+      나.localInsert(-1, '안');
+
+      // assert
+      expect(나.read()).toEqual('안녕');
+    });
+
+    it('tail 위치 삽입에 성공한다.', () => {
+      // act
+      나.localInsert(-1, '안');
+      나.localInsert(0, '녕');
+
+      // assert
+      expect(나.read()).toEqual('안녕');
+    });
+
+    it('없는 위치에 삽입 시도 시 에러를 던진다.', () => {
+      // arrange
+      나.localInsert(-1, '안');
+
+      // act & assert
+      expect(() => 나.localInsert(1, '녕')).toThrow();
+    });
+  });
+
+  describe('localDelete()', () => {
+    it('tail 위치 삭제에 성공한다.', () => {
+      // arrange
+      나.localInsert(-1, '안');
+      나.localInsert(0, '녕');
+
+      // act
+      나.localDelete(1);
+
+      // assert
+      expect(나.read()).toEqual('안');
+    });
+
+    it('없는 위치에 삭제 시도 시 에러를 던진다.', () => {
+      // arrange
+      나.localInsert(-1, '안');
+
+      // act & assert
+      expect(() => 나.localDelete(1)).toThrow();
+    });
+  });
+});

@wabinar/crdt/test/convergence.test.ts

@@ -0,0 +1,42 @@
+import CRDT from '../index';
+import LinkedList from '../linked-list';
+import { remoteInsertThroughSocket } from './utils';
+
+describe('Exceptions', () => {
+  let 도훈, 호둔, remoteSites;
+
+  beforeEach(() => {
+    도훈 = new CRDT(1, new LinkedList());
+    호둔 = new CRDT(2, new LinkedList());
+
+    remoteSites = [도훈, 호둔];
+
+    const 도훈remotes = [
+      도훈.localInsert(-1, '녕'),
+      도훈.localInsert(-1, '안'),
+    ];
+    도훈remotes.forEach((op) => remoteInsertThroughSocket(호둔, op));
+  });
+
+  it('존재하지 않는 인덱스에 localInsert', () => {
+    expect(() => 도훈.localInsert(100, '.')).toThrow();
+  });
+
+  it('존재하지 않는 노드 뒤에 remoteInsert', () => {
+    const 도훈remotes = [
+      도훈.localInsert(1, '.'),
+      도훈.localInsert(2, '.'),
+      도훈.localInsert(3, '.'),
+    ];
+
+    // 연속된 remote operation 순서가 섞이는 케이스
+    expect(() => 호둔.remoteInsert(도훈remotes[1])).toThrow();
+  });
+
+  it('local에서 삭제된 노드 뒤에 삽입', () => {
+    const 도훈remote = 도훈.localInsert(0, '!');
+    const 호둔remote = 호둔.localDelete(0);
+
+    expect(() => 호둔.remoteInsert(도훈remote)).toThrow();
+  });
+});

@wabinar/crdt/test/crdt.test.ts

@@ -0,0 +1,40 @@
+import CRDT from '../index';
+import { RemoteInsertOperation } from '../linked-list';
+import { Node } from '../node';
+
+/**
+ * 모든 remote site 문자열이 일치하는지 확인
+ */
+export const convergenceCheck = (remoteSites) => {
+  const convergenceSet = remoteSites.reduce((prev, cur, index) => {
+    if (index < remoteSites.length - 1) {
+      prev.push([cur, remoteSites[index + 1]]);
+    }
+
+    return prev;
+  }, []);
+
+  convergenceSet.forEach(([first, second]) => {
+    expect(first.read()).toEqual(second.read());
+  });
+};
+
+/**
+ * 바로 전달하면 같은 인스턴스를 가리키게 되어 remote operation 의미가 사라짐
+ */
+const deepCopyRemoteInsertion = (op: RemoteInsertOperation) => {
+  const { node } = op;
+
+  const copy = { ...node };
+  Object.setPrototypeOf(copy, Node.prototype);
+
+  return { node: copy as Node };
+};
+
+export const remoteInsertThroughSocket = (
+  crdt: CRDT,
+  op: RemoteInsertOperation,
+) => {
+  const copy = deepCopyRemoteInsertion(op);
+  crdt.remoteInsert(copy);
+};

@wabinar/crdt/test/exception.test.ts

@@ -0,0 +1,5 @@
+{
+  "compilerOptions": {
+    "esModuleInterop": true
+  }
+}