Add comments

yorkie-team · Dec 19, 2024 · e37c3ea · e37c3ea
1 parent 6f98675
commit e37c3ea
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 5 deletions.
diff --git a/pkg/document/crdt/rga_tree_split.go b/pkg/document/crdt/rga_tree_split.go
@@ -548,16 +548,18 @@ func (s *RGATreeSplit[V]) deleteNodes(
 		var maxCreatedAt *time.Ticket
 		var clientLamportAtChange int64
 		if isVersionVectorEmpty && isMaxCreatedAtMapByActorEmpty {
-			// Local edit - use version vector comparison
+			// Case 1: local editing from json package
 			clientLamportAtChange = time.MaxLamport
 		} else if !isVersionVectorEmpty {
+			// Case 2: from operation with version vector(After v0.5.7)
 			lamport, ok := versionVector.Get(actorID)
 			if ok {
 				clientLamportAtChange = lamport
 			} else {
 				clientLamportAtChange = 0
 			}
 		} else {
+			// Case 3: from operation without version vector(Before v0.5.6)
 			createdAt, ok := maxCreatedAtMapByActor[actorIDHex]
 			if ok {
 				maxCreatedAt = createdAt

diff --git a/pkg/document/crdt/text.go b/pkg/document/crdt/text.go
@@ -324,16 +324,18 @@ func (t *Text) Style(
 		var maxCreatedAt *time.Ticket
 		var clientLamportAtChange int64
 		if isVersionVectorEmpty && isMaxCreatedAtMapByActorEmpty {
-			// Local edit - use version vector comparison
+			// Case 1: local editing from json package
 			clientLamportAtChange = time.MaxLamport
 		} else if !isVersionVectorEmpty {
+			// Case 2: from operation with version vector(After v0.5.7)
 			lamport, ok := versionVector.Get(actorID)
 			if ok {
 				clientLamportAtChange = lamport
 			} else {
 				clientLamportAtChange = 0
 			}
 		} else {
+			// Case 3: from operation without version vector(Before v0.5.6)
 			createdAt, ok := maxCreatedAtMapByActor[actorIDHex]
 			if ok {
 				maxCreatedAt = createdAt

diff --git a/pkg/document/crdt/tree.go b/pkg/document/crdt/tree.go
@@ -872,17 +872,20 @@ func (t *Tree) collectBetween(
 
 			var maxCreatedAt *time.Ticket
 			var clientLamportAtChange int64
+
 			if isVersionVectorEmpty && isMaxCreatedAtMapByActorEmpty {
-				// Local edit - use version vector comparison
+				// Case 1: local editing from json package
 				clientLamportAtChange = time.MaxLamport
 			} else if !isVersionVectorEmpty {
+				// Case 2: from operation with version vector(After v0.5.7)
 				lamport, ok := versionVector.Get(actorID)
 				if ok {
 					clientLamportAtChange = lamport
 				} else {
 					clientLamportAtChange = 0
 				}
 			} else {
+				// Case 3: from operation without version vector(Before v0.5.6)
 				createdAt, ok := maxCreatedAtMapByActor[actorIDHex]
 				if ok {
 					maxCreatedAt = createdAt
@@ -1016,16 +1019,18 @@ func (t *Tree) Style(
 		var maxCreatedAt *time.Ticket
 		var clientLamportAtChange int64
 		if isVersionVectorEmpty && isMaxCreatedAtMapByActorEmpty {
-			// Local edit - use version vector comparison
+			// Case 1: local editing from json package
 			clientLamportAtChange = time.MaxLamport
 		} else if !isVersionVectorEmpty {
+			// Case 2: from operation with version vector(After v0.5.7)
 			lamport, ok := versionVector.Get(actorID)
 			if ok {
 				clientLamportAtChange = lamport
 			} else {
 				clientLamportAtChange = 0
 			}
 		} else {
+			// Case 3: from operation without version vector(Before v0.5.6)
 			createdAt, ok := maxCreatedAtMapByActor[actorIDHex]
 			if ok {
 				maxCreatedAt = createdAt
@@ -1088,16 +1093,18 @@ func (t *Tree) RemoveStyle(
 		var maxCreatedAt *time.Ticket
 		var clientLamportAtChange int64
 		if isVersionVectorEmpty && isMaxCreatedAtMapByActorEmpty {
-			// Local edit - use version vector comparison
+			// Case 1: local editing from json package
 			clientLamportAtChange = time.MaxLamport
 		} else if !isVersionVectorEmpty {
+			// Case 2: from operation with version vector(After v0.5.7)
 			lamport, ok := versionVector.Get(actorID)
 			if ok {
 				clientLamportAtChange = lamport
 			} else {
 				clientLamportAtChange = 0
 			}
 		} else {
+			// Case 3: from operation without version vector(Before v0.5.6)
 			createdAt, ok := maxCreatedAtMapByActor[actorIDHex]
 			if ok {
 				maxCreatedAt = createdAt