Revise codes

pkg/document/crdt/counter.go

@@ -154,6 +154,7 @@ func (p *Counter) ValueType() CounterType {
 }
 
 // Value returns the value.
+// TODO(hackerwins): We need to use generics to avoid using interface{}.
 func (p *Counter) Value() interface{} {
 	return p.value
 }

pkg/document/crdt/root.go

@@ -187,7 +187,6 @@ func (r *Root) GarbageLen() int {
 		switch elem := pair.elem.(type) {
 		case Container:
 			elem.Descendants(func(elem Element, parent Container) bool {
-
 				seen[elem.CreatedAt().Key()] = true
 				return false
 			})

pkg/document/json/array.go

@@ -272,17 +272,17 @@ func (p *Array) moveBeforeInternal(nextCreatedAt, createdAt *time.Ticket) {
 	}
 }
 
-// buildArrayMember return the element slice of the given array.
-func buildArrayMember(
+// buildArrayElements return the element slice of the given array.
+func buildArrayElements(
 	context *change.Context,
 	elements []interface{},
 ) []crdt.Element {
-	members := make([]crdt.Element, len(elements))
+	elems := make([]crdt.Element, len(elements))
 
 	for idx, value := range elements {
 		ticket := context.IssueTimeTicket()
-		members[idx] = buildCRDTElement(context, value, ticket)
+		elems[idx] = buildCRDTElement(context, value, ticket)
 	}
 
-	return members
+	return elems
 }

pkg/document/json/json.go

@@ -72,7 +72,7 @@ func buildCRDTElement(
 	ticket *time.Ticket,
 ) crdt.Element {
 	switch elem := value.(type) {
-	case string, int, int32, int64, float32, float64, []byte, bool, gotime.Time:
+	case nil, string, int, int32, int64, float32, float64, []byte, bool, gotime.Time:
 		primitive, err := crdt.NewPrimitive(elem, ticket)
 		if err != nil {
 			panic(err)
@@ -90,17 +90,11 @@ func buildCRDTElement(
 		}
 		return counter
 	case []interface{}:
-		array := crdt.NewArray(crdt.NewRGATreeList(), ticket, buildArrayMember(context, elem))
+		array := crdt.NewArray(crdt.NewRGATreeList(), ticket, buildArrayElements(context, elem))
 		return array
 	case map[string]interface{}:
-		obj := crdt.NewObject(crdt.NewElementRHT(), ticket, buildObjectMember(context, elem))
+		obj := crdt.NewObject(crdt.NewElementRHT(), ticket, buildObjectMembers(context, elem))
 		return obj
-	case nil:
-		primitive, err := crdt.NewPrimitive(nil, ticket)
-		if err != nil {
-			panic(err)
-		}
-		return primitive
 	default:
 		panic("unsupported type")
 	}

pkg/document/json/object.go

@@ -55,6 +55,8 @@ func (p *Object) SetNewObject(k string, v ...map[string]interface{}) *Object {
 
 // SetNewArray sets a new Array for the given key.
 func (p *Object) SetNewArray(k string, v ...[]interface{}) *Array {
+	// TODO(hackerwins): For now, users can only set initial values with []interface{} without
+	// the type information of the elements. We need to support the type information.
 	value := p.setInternal(k, func(ticket *time.Ticket) crdt.Element {
 		elements := crdt.NewRGATreeList()
 		if len(v) == 0 {
@@ -338,8 +340,11 @@ func (p *Object) setInternal(
 	return elem
 }
 
-// buildObjectMember return the element map of the given json.
-func buildObjectMember(
+// buildObjectMembers constructs an object where all values from the
+// user-provided object are transformed into CRDTElements.
+// This function takes an object and iterates through its values,
+// converting each value into a corresponding CRDTElement.
+func buildObjectMembers(
 	context *change.Context,
 	json map[string]interface{},
 ) map[string]crdt.Element {

test/integration/gc_test.go

@@ -430,7 +430,7 @@ func TestGarbageCollection(t *testing.T) {
 		assert.Equal(t, d2.GarbageCollect(time.MaxTicket), 3)
 	})
 
-	t.Run("Deregister nested object gc test", func(t *testing.T) {
+	t.Run("deregister nested object gc test", func(t *testing.T) {
 		ctx := context.Background()
 		d1 := document.New(helper.TestDocKey(t))
 		err := c1.Attach(ctx, d1)
@@ -449,7 +449,6 @@ func TestGarbageCollection(t *testing.T) {
 
 		assert.Equal(t, 5, d1.GarbageLen())
 		assert.Equal(t, 5, d1.GarbageCollect(time.MaxTicket))
-
 	})
 
 }

test/integration/object_test.go

@@ -283,7 +283,7 @@ func TestObject(t *testing.T) {
 		})
 		assert.NoError(t, err)
 
-		// 03. garbage collect ( 3 elements: array, 1, 2)
+		// 03. garbage collect (3 elements: array, 1, 2)
 		assert.Equal(t, 3, d1.GarbageLen())
 		assert.Equal(t, 3, d1.GarbageCollect(time.MaxTicket))
 	})