Introducing version vector to solve GC problem

.eslintignore

@@ -8,3 +8,6 @@ packages/sdk/src/api/yorkie/v1/resources_grpc_web_pb.d.ts
 packages/sdk/src/api/yorkie/v1/resources_pb.d.ts
 packages/sdk/test/vitest.d.ts
 packages/sdk/lib
+
+# examples
+examples/react-tldraw/src/tldraw.d.ts

CHANGELOG.md

@@ -7,6 +7,21 @@ and Yorkie JS SDK adheres to [Semantic Versioning](https://semver.org/spec/v2.0.
 
 ## [Unreleased]
 
+## [0.5.1] - 2024-10-15
+
+### Added
+
+- Add configurable retry mechanism to broadcast interface by @gwbaik9717 in https://github.com/yorkie-team/yorkie-js-sdk/pull/901
+
+### Changed
+
+- Ensure `find` and `indexOf` perform splay by @m4ushold in https://github.com/yorkie-team/yorkie-js-sdk/pull/904
+- Restrict presence object type to JSON serializable values by @gwbaik9717 in https://github.com/yorkie-team/yorkie-js-sdk/pull/898
+
+### Fixed
+
+- Automate Linting with Husky and lint-staged to Prevent CI Failures by @gwbaik9717 in https://github.com/yorkie-team/yorkie-js-sdk/pull/896
+
 ## [0.5.0] - 2024-09-05
 
 ### Added

examples/react-tldraw/src/tldraw.d.ts

@@ -0,0 +1,6 @@
+import { Indexable, Json } from '@yorkie-js-sdk/src/document/document';
+import { TDUser } from '@tldraw/tldraw';
+
+declare module '@tldraw/tldraw' {
+  interface TDUser extends Indexable {}
+}

examples/vanilla-quill/src/main.ts

@@ -29,7 +29,7 @@ function toDeltaOperation<T extends TextValueType>(
 ): DeltaOperation {
   const { embed, ...restAttributes } = textValue.attributes ?? {};
   if (embed) {
-    return { insert: JSON.parse(embed), attributes: restAttributes };
+    return { insert: embed, attributes: restAttributes };
   }
 
   return {

examples/vanilla-quill/src/type.ts

@@ -7,5 +7,5 @@ export type YorkieDoc = {
 export type YorkiePresence = {
   username: string;
   color: string;
-  selection: TextPosStructRange | undefined;
+  selection?: TextPosStructRange;
 };

package.json

@@ -33,5 +33,6 @@
     "only-allow": "^1.2.1",
     "eslint-plugin-jsdoc": "^39.3.3",
     "eslint-plugin-prettier": "^5.0.0"
-  }
+  },
+  "packageManager": "pnpm@9.9.0+sha512.60c18acd138bff695d339be6ad13f7e936eea6745660d4cc4a776d5247c540d0edee1a563695c183a66eb917ef88f2b4feb1fc25f32a7adcadc7aaf3438e99c1"
 }

packages/sdk/buf.gen.yaml

@@ -4,9 +4,9 @@ plugins:
     out: .
     opt:
       - target=ts
-      - js_import_style=module
+      - import_extension=none
   - plugin: connect-es
     out: .
     opt:
       - target=ts
-      - js_import_style=module
+      - import_extension=none

packages/sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yorkie-js-sdk",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Yorkie JS SDK",
   "main": "./src/yorkie.ts",
   "publishConfig": {

packages/sdk/src/api/converter.ts

@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 
-import Long from 'long';
 import { ConnectError } from '@connectrpc/connect';
 import { ErrorInfo } from '@buf/googleapis_googleapis.bufbuild_es/google/rpc/error_details_pb';
 import { Code, YorkieError } from '@yorkie-js-sdk/src/util/error';
@@ -45,6 +44,7 @@ import { RGATreeList } from '@yorkie-js-sdk/src/document/crdt/rga_tree_list';
 import { CRDTElement } from '@yorkie-js-sdk/src/document/crdt/element';
 import { CRDTObject } from '@yorkie-js-sdk/src/document/crdt/object';
 import { CRDTArray } from '@yorkie-js-sdk/src/document/crdt/array';
+import { VersionVector } from '@yorkie-js-sdk/src/document/time/version_vector';
 import { CRDTTreePos } from './../document/crdt/tree';
 import {
   RGATreeSplit,
@@ -79,6 +79,7 @@ import {
   TreeNodes as PbTreeNodes,
   TreePos as PbTreePos,
   TreeNodeID as PbTreeNodeID,
+  VersionVector as PbVersionVector,
   ValueType as PbValueType,
   JSONElement_Tree as PbJSONElement_Tree,
   JSONElement_Text as PbJSONElement_Text,
@@ -149,7 +150,7 @@ function toPresenceChange(
  */
 function toCheckpoint(checkpoint: Checkpoint): PbCheckpoint {
   return new PbCheckpoint({
-    serverSeq: checkpoint.getServerSeqAsString(),
+    serverSeq: checkpoint.getServerSeq(),
     clientSeq: checkpoint.getClientSeq(),
   });
 }
@@ -160,8 +161,9 @@ function toCheckpoint(checkpoint: Checkpoint): PbCheckpoint {
 function toChangeID(changeID: ChangeID): PbChangeID {
   return new PbChangeID({
     clientSeq: changeID.getClientSeq(),
-    lamport: changeID.getLamportAsString(),
+    lamport: changeID.getLamport(),
     actorId: toUint8Array(changeID.getActorID()),
+    versionVector: toVersionVector(changeID.getVersionVector()),
   });
 }
 
@@ -174,12 +176,28 @@ function toTimeTicket(ticket?: TimeTicket): PbTimeTicket | undefined {
   }
 
   return new PbTimeTicket({
-    lamport: ticket.getLamportAsString(),
+    lamport: ticket.getLamport(),
     delimiter: ticket.getDelimiter(),
     actorId: toUint8Array(ticket.getActorID()),
   });
 }
 
+/**
+ * `toVersionVector` converts the given model to Protobuf format.
+ */
+function toVersionVector(vector: VersionVector): PbVersionVector | undefined {
+  if (!vector) {
+    return;
+  }
+
+  const pbVector = new PbVersionVector();
+  for (const [actorID, lamport] of vector) {
+    // TODO(hackerwins): Remove Long after introducing BigInt.
+    pbVector.vector[actorID] = BigInt(lamport.toString());
+  }
+  return pbVector;
+}
+
 /**
  * `toValueType` converts the given model to Protobuf format.
  */
@@ -781,6 +799,7 @@ function toChangePack(pack: ChangePack<Indexable>): PbChangePack {
     isRemoved: pack.getIsRemoved(),
     changes: toChanges(pack.getChanges()),
     snapshot: pack.getSnapshot(),
+    versionVector: toVersionVector(pack.getVersionVector()!),
     minSyncedTicket: toTimeTicket(pack.getMinSyncedTicket()),
   });
 }
@@ -805,19 +824,34 @@ export function errorCodeOf(error: ConnectError): string {
  * `fromChangeID` converts the given Protobuf format to model format.
  */
 function fromChangeID(pbChangeID: PbChangeID): ChangeID {
-  let serverSeq: Long | undefined;
-  if (pbChangeID.serverSeq) {
-    serverSeq = Long.fromString(pbChangeID.serverSeq, true);
-  }
-
+  // TODO(hackerwins): Remove BigInt conversion. Some of the bigint values are
+  // passed as string in the protobuf. We should fix this in the future.
   return ChangeID.of(
     pbChangeID.clientSeq,
-    Long.fromString(pbChangeID.lamport, true),
+    BigInt(pbChangeID.lamport),
     toHexString(pbChangeID.actorId),
-    serverSeq,
+    fromVersionVector(pbChangeID.versionVector)!,
+    BigInt(pbChangeID.serverSeq),
   );
 }
 
+/**
+ * `fromVersionVector` converts the given Protobuf format to model format.
+ */
+function fromVersionVector(
+  pbVersionVector?: PbVersionVector,
+): VersionVector | undefined {
+  if (!pbVersionVector) {
+    return;
+  }
+
+  const vector = new VersionVector();
+  Object.entries(pbVersionVector.vector).forEach(([key, value]) => {
+    vector.set(key, BigInt(value.toString()));
+  });
+  return vector;
+}
+
 /**
  * `fromTimeTicket` converts the given Protobuf format to model format.
  */
@@ -827,7 +861,7 @@ function fromTimeTicket(pbTimeTicket?: PbTimeTicket): TimeTicket | undefined {
   }
 
   return TimeTicket.of(
-    Long.fromString(pbTimeTicket.lamport, true),
+    BigInt(pbTimeTicket.lamport),
     pbTimeTicket.delimiter,
     toHexString(pbTimeTicket.actorId),
   );
@@ -1314,10 +1348,7 @@ function fromChanges<P extends Indexable>(
  * `fromCheckpoint` converts the given Protobuf format to model format.
  */
 function fromCheckpoint(pbCheckpoint: PbCheckpoint): Checkpoint {
-  return Checkpoint.of(
-    Long.fromString(pbCheckpoint.serverSeq, true),
-    pbCheckpoint.clientSeq,
-  );
+  return Checkpoint.of(BigInt(pbCheckpoint.serverSeq), pbCheckpoint.clientSeq);
 }
 
 /**
@@ -1331,6 +1362,7 @@ function fromChangePack<P extends Indexable>(
     fromCheckpoint(pbPack.checkpoint!),
     pbPack.isRemoved,
     fromChanges(pbPack.changes),
+    fromVersionVector(pbPack.versionVector),
     pbPack.snapshot,
     fromTimeTicket(pbPack.minSyncedTicket),
   );
@@ -1477,6 +1509,25 @@ function bytesToSnapshot<P extends Indexable>(
   };
 }
 
+/**
+ * `versionVectorToHex` converts the given VersionVector to bytes.
+ */
+function versionVectorToHex(vector: VersionVector): string {
+  const pbVersionVector = toVersionVector(vector)!;
+
+  return bytesToHex(pbVersionVector.toBinary());
+}
+
+/**
+ * `hexToVersionVector` creates a VersionVector from the given bytes.
+ */
+function hexToVersionVector(hex: string): VersionVector {
+  const bytes = hexToBytes(hex);
+  const pbVersionVector = PbVersionVector.fromBinary(bytes);
+
+  return fromVersionVector(pbVersionVector)!;
+}
+
 /**
  * `bytesToObject` creates an JSONObject from the given byte array.
  */
@@ -1609,4 +1660,6 @@ export const converter = {
   PbChangeID,
   bytesToChangeID,
   bytesToOperation,
+  versionVectorToHex,
+  hexToVersionVector,
 };

packages/sdk/src/api/yorkie/v1/resources.proto

@@ -44,8 +44,9 @@ message ChangePack {
   Checkpoint checkpoint = 2;
   bytes snapshot = 3;
   repeated Change changes = 4;
-  TimeTicket min_synced_ticket = 5;
+  TimeTicket min_synced_ticket = 5; // Deprecated
   bool is_removed = 6;
+  VersionVector version_vector = 7;
 }
 
 message Change {
@@ -57,9 +58,14 @@ message Change {
 
 message ChangeID {
   uint32 client_seq = 1;
-  int64 server_seq = 2 [jstype = JS_STRING];
-  int64 lamport = 3 [jstype = JS_STRING];
+  int64 server_seq = 2; 
+  int64 lamport = 3;
   bytes actor_id = 4;
+  VersionVector version_vector = 5;
+}
+
+message VersionVector {
+  map<string, int64> vector = 1;
 }
 
 message Operation {
@@ -136,6 +142,12 @@ message Operation {
     repeated string attributes_to_remove = 6;
     map<string, TimeTicket> created_at_map_by_actor = 7;
   }
+  message ArraySet {
+    TimeTicket parent_created_at = 1;
+    TimeTicket created_at = 2;
+    JSONElementSimple value = 3;
+    TimeTicket executed_at = 4;
+  }
 
   oneof body {
     Set set = 1;
@@ -148,6 +160,7 @@ message Operation {
     Increase increase = 8;
     TreeEdit tree_edit = 9;
     TreeStyle tree_style = 10;
+    ArraySet array_set = 11;
   }
 }
 
@@ -325,7 +338,7 @@ message Presence {
 }
 
 message Checkpoint {
-  int64 server_seq = 1 [jstype = JS_STRING];
+  int64 server_seq = 1; 
   uint32 client_seq = 2;
 }
 
@@ -336,7 +349,7 @@ message TextNodePos {
 }
 
 message TimeTicket {
-  int64 lamport = 1 [jstype = JS_STRING];
+  int64 lamport = 1;
   uint32 delimiter = 2;
   bytes actor_id = 3;
 }