Reflect feedback

pkg/document/crdt/tree.go

@@ -123,8 +123,8 @@ func NewTreeNode(id *TreeNodeID, nodeType string, attributes *RHT, value ...stri
 	return node
 }
 
-// ToIDString returns a string that can be used as an ID for this TreeNodeID.
-func (t *TreeNodeID) ToIDString() string {
+// toIDString returns a string that can be used as an ID for this TreeNodeID.
+func (t *TreeNodeID) toIDString() string {
 	return t.CreatedAt.ToTestString() + ":" + strconv.Itoa(t.Offset)
 }
 
@@ -471,7 +471,7 @@ func (t *Tree) purgeNode(node *TreeNode) error {
 	node.InsPrevID = nil
 	node.InsNextID = nil
 
-	delete(t.removedNodeMap, node.ID.ToIDString())
+	delete(t.removedNodeMap, node.ID.toIDString())
 	return nil
 }
 
@@ -651,7 +651,7 @@ func (t *Tree) Edit(
 	// 02. Delete: delete the nodes that are marked as removed.
 	for _, node := range toBeRemoveds {
 		if node.remove(editedAt) {
-			t.removedNodeMap[node.ID.ToIDString()] = node
+			t.removedNodeMap[node.ID.toIDString()] = node
 		}
 	}
 
@@ -702,7 +702,7 @@ func (t *Tree) Edit(
 							createdAtMapByActor[actorIDHex] = createdAt
 						}
 					}
-					t.removedNodeMap[node.Value.ID.ToIDString()] = node.Value
+					t.removedNodeMap[node.Value.ID.toIDString()] = node.Value
 				}
 
 				t.NodeMapByID.Put(node.Value.ID, node.Value)

pkg/document/crdt/tree_test.go

@@ -34,28 +34,9 @@ var (
 	}
 )
 
-type TreeNodePair struct {
-	treeNode     *crdt.TreeNode
-	parentNodeID *crdt.TreeNodeID
-}
-
-func CollectNodesWithParentID(node *crdt.TreeNode, parentNodeID *crdt.TreeNodeID) []TreeNodePair {
-	var list []TreeNodePair
-
-	list = append(list, TreeNodePair{node, parentNodeID})
-	for _, child := range node.Index.Children(true) {
-		list = append(list, CollectNodesWithParentID(child.Value, node.ID)...)
-	}
-	return list
-}
-
-func assertEqualTreeNode(t *testing.T, nodeA, nodeB *crdt.TreeNode) {
-	listA := CollectNodesWithParentID(nodeA, nil)
-	listB := CollectNodesWithParentID(nodeB, nil)
-	assert.Equal(t, listA, listB)
-}
-
 func createHelloTree(t *testing.T, ctx *change.Context) *crdt.Tree {
+	// TODO(raararaara): This test should be generalized. e.g) createTree(ctx, "<r><p>hello</p></r>")
+	// https://pkg.go.dev/encoding/xml#Unmarshal
 	tree := crdt.NewTree(crdt.NewTreeNode(helper.PosT(ctx), "r", nil), helper.TimeT(ctx))
 	_, err := tree.EditT(0, 0, []*crdt.TreeNode{
 		crdt.NewTreeNode(helper.PosT(ctx), "p", nil),
@@ -160,7 +141,7 @@ func TestTreeNode(t *testing.T) {
 		// 03. Make a deep copy of the root and check if the node is the same as the original.
 		clone, err := tree.Root().DeepCopy()
 		assert.NoError(t, err)
-		assertEqualTreeNode(t, tree.Root(), clone)
+		helper.AssertEqualTreeNode(t, tree.Root(), clone)
 	})
 
 	t.Run("deepcopy test with split", func(t *testing.T) {
@@ -176,7 +157,7 @@ func TestTreeNode(t *testing.T) {
 		// 03. Make a deep copy of the root and check if the node is the same as the original.
 		clone, err := tree.Root().DeepCopy()
 		assert.NoError(t, err)
-		assertEqualTreeNode(t, tree.Root(), clone)
+		helper.AssertEqualTreeNode(t, tree.Root(), clone)
 	})
 }
 

test/helper/helper.go

@@ -198,6 +198,28 @@ func BuildTreeNode(node *json.TreeNode) *crdt.TreeNode {
 	return doc.Root().GetTree("test").Root()
 }
 
+type treeNodePair struct {
+	node     *crdt.TreeNode
+	parentID *crdt.TreeNodeID
+}
+
+func createTreeNodePairs(node *crdt.TreeNode, parentID *crdt.TreeNodeID) []treeNodePair {
+	var pairs []treeNodePair
+
+	pairs = append(pairs, treeNodePair{node, parentID})
+	for _, child := range node.Index.Children(true) {
+		pairs = append(pairs, createTreeNodePairs(child.Value, node.ID)...)
+	}
+	return pairs
+}
+
+// AssertEqualTreeNode asserts that the given TreeNodes are equal.
+func AssertEqualTreeNode(t *testing.T, nodeA, nodeB *crdt.TreeNode) {
+	pairsA := createTreeNodePairs(nodeA, nil)
+	pairsB := createTreeNodePairs(nodeB, nil)
+	assert.Equal(t, pairsA, pairsB)
+}
+
 var portOffset = 0
 
 // TestConfig returns config for creating Yorkie instance.