Introducing version vector to solve GC problem

examples/vanilla-codemirror6/src/main.ts

@@ -28,15 +28,18 @@ async function main() {
   await client.activate();
 
   // 02-1. create a document then attach it into the client.
-  const doc = new yorkie.Document<YorkieDoc>(
-    `codemirror6-${new Date()
-      .toISOString()
-      .substring(0, 10)
-      .replace(/-/g, '')}`,
-    {
-      enableDevtools: true,
-    },
-  );
+  // TODO(JOOHOJANG):Put it back to how the document’s dockey was.
+  const doc = new yorkie.Document<YorkieDoc>('dailysync', {
+    enableDevtools: true,
+  });
+  window.addEventListener('beforeunload', async () => {
+    await client.detach(doc);
+    await client.deactivate();
+  });
+  window.addEventListener('unload', async () => {
+    await client.detach(doc);
+    await client.deactivate();
+  });
   doc.subscribe('connection', (event) => {
     network.statusListener(networkStatusElem)(event);
   });

packages/sdk/buf.gen.yaml

@@ -3,10 +3,10 @@ plugins:
   - plugin: es
     out: .
     opt:
-      - target=ts
+      - target=js+dts
       - js_import_style=module
   - plugin: connect-es
     out: .
     opt:
-      - target=ts
+      - target=js+dts
       - js_import_style=module

packages/sdk/src/api/converter.ts

@@ -45,6 +45,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 +80,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,
@@ -162,6 +164,7 @@ function toChangeID(changeID: ChangeID): PbChangeID {
     clientSeq: changeID.getClientSeq(),
     lamport: changeID.getLamportAsString(),
     actorId: toUint8Array(changeID.getActorID()),
+    versionVector: toVersionVector(changeID.getVersionVector()),
   });
 }
 
@@ -180,6 +183,22 @@ function toTimeTicket(ticket?: TimeTicket): PbTimeTicket | undefined {
   });
 }
 
+/**
+ * `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 +800,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()),
   });
 }
@@ -814,10 +834,29 @@ function fromChangeID(pbChangeID: PbChangeID): ChangeID {
     pbChangeID.clientSeq,
     Long.fromString(pbChangeID.lamport, true),
     toHexString(pbChangeID.actorId),
+    fromVersionVector(pbChangeID.versionVector)!,
     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]) => {
+    // TODO(hackerwins): Remove Long after introducing BigInt.
+    vector.set(key, Long.fromString(value.toString(), true));
+  });
+  return vector;
+}
+
 /**
  * `fromTimeTicket` converts the given Protobuf format to model format.
  */
@@ -1331,6 +1370,7 @@ function fromChangePack<P extends Indexable>(
     fromCheckpoint(pbPack.checkpoint!),
     pbPack.isRemoved,
     fromChanges(pbPack.changes),
+    fromVersionVector(pbPack.versionVector),
     pbPack.snapshot,
     fromTimeTicket(pbPack.minSyncedTicket),
   );
@@ -1477,6 +1517,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 +1668,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 {
@@ -60,6 +61,11 @@ message ChangeID {
   int64 server_seq = 2 [jstype = JS_STRING];
   int64 lamport = 3 [jstype = JS_STRING];
   bytes actor_id = 4;
+  VersionVector version_vector = 5;
+}
+
+message VersionVector {
+  map<string, int64> vector = 1;
 }
 
 message Operation {

packages/sdk/src/api/yorkie/v1/resources_pb.d.ts

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// @generated by protoc-gen-es v1.6.0 with parameter "target=js+dts,js_import_style=module"
+// @generated by protoc-gen-es v1.10.0 with parameter "target=js+dts,js_import_style=module"
 // @generated from file src/api/yorkie/v1/resources.proto (package yorkie.v1, syntax proto3)
 /* eslint-disable */
 // @ts-nocheck
@@ -182,6 +182,8 @@ export declare class ChangePack extends Message<ChangePack> {
   changes: Change[];
 
   /**
+   * Deprecated
+   *
    * @generated from field: yorkie.v1.TimeTicket min_synced_ticket = 5;
    */
   minSyncedTicket?: TimeTicket;
@@ -191,6 +193,11 @@ export declare class ChangePack extends Message<ChangePack> {
    */
   isRemoved: boolean;
 
+  /**
+   * @generated from field: yorkie.v1.VersionVector version_vector = 7;
+   */
+  versionVector?: VersionVector;
+
   constructor(data?: PartialMessage<ChangePack>);
 
   static readonly runtime: typeof proto3;
@@ -269,6 +276,11 @@ export declare class ChangeID extends Message<ChangeID> {
    */
   actorId: Uint8Array;
 
+  /**
+   * @generated from field: yorkie.v1.VersionVector version_vector = 5;
+   */
+  versionVector?: VersionVector;
+
   constructor(data?: PartialMessage<ChangeID>);
 
   static readonly runtime: typeof proto3;
@@ -284,6 +296,30 @@ export declare class ChangeID extends Message<ChangeID> {
   static equals(a: ChangeID | PlainMessage<ChangeID> | undefined, b: ChangeID | PlainMessage<ChangeID> | undefined): boolean;
 }
 
+/**
+ * @generated from message yorkie.v1.VersionVector
+ */
+export declare class VersionVector extends Message<VersionVector> {
+  /**
+   * @generated from field: map<string, int64> vector = 1;
+   */
+  vector: { [key: string]: bigint };
+
+  constructor(data?: PartialMessage<VersionVector>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "yorkie.v1.VersionVector";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): VersionVector;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): VersionVector;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): VersionVector;
+
+  static equals(a: VersionVector | PlainMessage<VersionVector> | undefined, b: VersionVector | PlainMessage<VersionVector> | undefined): boolean;
+}
+
 /**
  * @generated from message yorkie.v1.Operation
  */