Refactor Presence data structure to repeated string (#1335)

raararaara · hackerwins · hackerwins · commit de29cdcca406 · 2025-06-20T16:56:34.000+09:00
Co-authored-by: Youngteac Hong &lt;susukang98@gmail.com&gt;
diff --git a/api/docs/yorkie/v1/admin.openapi.yaml b/api/docs/yorkie/v1/admin.openapi.yaml
@@ -2043,26 +2043,12 @@ components:
         data:
           additionalProperties: false
           description: ""
+          items:
+            type: string
           title: data
-          type: object
+          type: array
       title: Presence
       type: object
-    yorkie.v1.Presence.DataEntry:
-      additionalProperties: false
-      description: ""
-      properties:
-        key:
-          additionalProperties: false
-          description: ""
-          title: key
-          type: string
-        value:
-          additionalProperties: false
-          description: ""
-          title: value
-          type: string
-      title: DataEntry
-      type: object
     yorkie.v1.PresenceChange:
       additionalProperties: false
       description: ""
diff --git a/api/docs/yorkie/v1/resources.openapi.yaml b/api/docs/yorkie/v1/resources.openapi.yaml
@@ -1335,26 +1335,12 @@ components:
         data:
           additionalProperties: false
           description: ""
+          items:
+            type: string
           title: data
-          type: object
+          type: array
       title: Presence
       type: object
-    yorkie.v1.Presence.DataEntry:
-      additionalProperties: false
-      description: ""
-      properties:
-        key:
-          additionalProperties: false
-          description: ""
-          title: key
-          type: string
-        value:
-          additionalProperties: false
-          description: ""
-          title: value
-          type: string
-      title: DataEntry
-      type: object
     yorkie.v1.PresenceChange:
       additionalProperties: false
       description: ""
diff --git a/api/docs/yorkie/v1/yorkie.openapi.yaml b/api/docs/yorkie/v1/yorkie.openapi.yaml
@@ -1268,26 +1268,12 @@ components:
         data:
           additionalProperties: false
           description: ""
+          items:
+            type: string
           title: data
-          type: object
+          type: array
       title: Presence
       type: object
-    yorkie.v1.Presence.DataEntry:
-      additionalProperties: false
-      description: ""
-      properties:
-        key:
-          additionalProperties: false
-          description: ""
-          title: key
-          type: string
-        value:
-          additionalProperties: false
-          description: ""
-          title: value
-          type: string
-      title: DataEntry
-      type: object
     yorkie.v1.PresenceChange:
       additionalProperties: false
       description: ""
diff --git a/api/yorkie/v1/resources.pb.go b/api/yorkie/v1/resources.pb.go
diff --git a/api/yorkie/v1/resources.proto b/api/yorkie/v1/resources.proto
@@ -362,7 +362,7 @@ message PresenceChange {
 }
 
 message Presence {
-  map<string, string> data = 1;
+  repeated string data = 1;
 }
 
 message Checkpoint {
diff --git a/pkg/document/innerpresence/presence.go b/pkg/document/innerpresence/presence.go
@@ -114,21 +114,38 @@ func (m *Map) DeepCopy() *Map {
 }
 
 // Presence represents custom presence that can be defined by the client.
-type Presence map[string]string
+type Presence []string
 
 // New creates a new instance of Presence.
 func New() Presence {
-	return make(map[string]string)
+	return make([]string, 0)
+}
+
+// index returns the index of the given key in the presence.
+func (p *Presence) index(key string) int {
+	for i := 0; i < len(*p); i += 2 {
+		if (*p)[i] == key {
+			return i
+		}
+	}
+
+	return -1
 }
 
 // Set sets the value of the given key.
-func (p Presence) Set(key string, value string) {
-	p[key] = value
+func (p *Presence) Set(key string, value string) {
+	if idx := p.index(key); idx != -1 {
+		(*p)[idx] = key
+		(*p)[idx+1] = value
+		return
+	}
+	*p = append(*p, key)
+	*p = append(*p, value)
 }
 
 // Clear clears the presence.
 func (p *Presence) Clear() {
-	*p = make(map[string]string)
+	clear(*p)
 }
 
 // DeepCopy copies itself deeply.
@@ -137,9 +154,7 @@ func (p Presence) DeepCopy() Presence {
 		return nil
 	}
 
-	clone := make(map[string]string, len(p))
-	for k, v := range p {
-		clone[k] = v
-	}
+	clone := make(Presence, len(p))
+	copy(clone, p)
 	return clone
 }
diff --git a/test/integration/presence_test.go b/test/integration/presence_test.go
@@ -60,14 +60,14 @@ func TestPresence(t *testing.T) {
 		}))
 		encoded, err := gojson.Marshal(d1.AllPresences())
 		assert.NoError(t, err)
-		assert.Equal(t, fmt.Sprintf(`{"%s":{"updated":"true"}}`, c1.ID()), string(encoded))
+		assert.Equal(t, fmt.Sprintf(`{"%s":["updated","true"]}`, c1.ID()), string(encoded))
 
 		// 03 Sync documents and check that the presence is updated on the other client
 		assert.NoError(t, c1.Sync(ctx))
 		assert.NoError(t, c2.Sync(ctx))
 		encoded, err = gojson.Marshal(d2.AllPresences())
 		assert.NoError(t, err)
-		assert.Equal(t, fmt.Sprintf(`{"%s":{"updated":"true"},"%s":{}}`, c1.ID(), c2.ID()), string(encoded))
+		assert.Equal(t, fmt.Sprintf(`{"%s":["updated","true"],"%s":[]}`, c1.ID(), c2.ID()), string(encoded))
 	})
 
 	t.Run("presence with snapshot test", func(t *testing.T) {
@@ -90,36 +90,36 @@ func TestPresence(t *testing.T) {
 		}
 		encoded, err := gojson.Marshal(d1.AllPresences())
 		assert.NoError(t, err)
-		assert.Equal(t, fmt.Sprintf(`{"%s":{"updated":"9"}}`, c1.ID()), string(encoded))
+		assert.Equal(t, fmt.Sprintf(`{"%s":["updated","9"]}`, c1.ID()), string(encoded))
 
 		// 03 Sync documents and check that the presence is updated on the other client
 		assert.NoError(t, c1.Sync(ctx))
 		assert.NoError(t, c2.Sync(ctx))
 		encoded, err = gojson.Marshal(d2.AllPresences())
 		assert.NoError(t, err)
-		assert.Equal(t, fmt.Sprintf(`{"%s":{"updated":"9"},"%s":{}}`, c1.ID(), c2.ID()), string(encoded))
+		assert.Equal(t, fmt.Sprintf(`{"%s":["updated","9"],"%s":[]}`, c1.ID(), c2.ID()), string(encoded))
 	})
 
 	t.Run("presence with attach and detach test", func(t *testing.T) {
 		// 01. Create a document and attach it to the clients
 		ctx := context.Background()
 		d1 := document.New(helper.TestDocKey(t))
-		assert.NoError(t, c1.Attach(ctx, d1, client.WithPresence(innerpresence.Presence{"key": c1.Key()})))
+		assert.NoError(t, c1.Attach(ctx, d1, client.WithPresence(innerpresence.Presence{"key", c1.Key()})))
 		d2 := document.New(helper.TestDocKey(t))
-		assert.NoError(t, c2.Attach(ctx, d2, client.WithPresence(innerpresence.Presence{"key": c2.Key()})))
+		assert.NoError(t, c2.Attach(ctx, d2, client.WithPresence(innerpresence.Presence{"key", c2.Key()})))
 		defer func() { assert.NoError(t, c2.Detach(ctx, d2)) }()
 
 		// 02. Check that the presence is updated on the other client.
 		assert.NoError(t, c1.Sync(ctx))
-		assert.Equal(t, innerpresence.Presence{"key": c1.Key()}, d1.MyPresence())
-		assert.Equal(t, innerpresence.Presence{"key": c2.Key()}, d1.PresenceForTest(c2.ID().String()))
-		assert.Equal(t, innerpresence.Presence{"key": c2.Key()}, d2.MyPresence())
-		assert.Equal(t, innerpresence.Presence{"key": c1.Key()}, d2.PresenceForTest(c1.ID().String()))
+		assert.Equal(t, innerpresence.Presence{"key", c1.Key()}, d1.MyPresence())
+		assert.Equal(t, innerpresence.Presence{"key", c2.Key()}, d1.PresenceForTest(c2.ID().String()))
+		assert.Equal(t, innerpresence.Presence{"key", c2.Key()}, d2.MyPresence())
+		assert.Equal(t, innerpresence.Presence{"key", c1.Key()}, d2.PresenceForTest(c1.ID().String()))
 
 		// 03. The first client detaches the document and check that the presence is updated on the other client.
 		assert.NoError(t, c1.Detach(ctx, d1))
 		assert.NoError(t, c2.Sync(ctx))
-		assert.Equal(t, innerpresence.Presence{"key": c2.Key()}, d2.MyPresence())
+		assert.Equal(t, innerpresence.Presence{"key", c2.Key()}, d2.MyPresence())
 		assert.Nil(t, d2.PresenceForTest(c1.ID().String()))
 	})
 
@@ -559,7 +559,7 @@ func TestPresence(t *testing.T) {
 		expected = append(expected, watchResponsePair{
 			Type: client.DocumentWatched,
 			Presences: map[string]innerpresence.Presence{
-				c2.ID().String(): {"updated": "true"},
+				c2.ID().String(): {"updated", "true"},
 			},
 		})
 		err = d2.Update(func(root *json.Object, p *presence.Presence) error {
diff --git a/test/k6/presence.ts b/test/k6/presence.ts
@@ -263,9 +263,7 @@ function attachDocument(clientID: string, actorID: string, docKey: string) {
           presenceChange: {
             type: "CHANGE_TYPE_PUT",
             presence: {
-              data: {
-                color: `"${randomColor}"`,
-              },
+              data: ["color", `"${randomColor}"`],
             },
           },
         },

Original file line number	Diff line number	Diff line change
`@@ -362,7 +362,7 @@ message PresenceChange {`
`362`	`362`	`}`
`363`	`363`
`364`	`364`	`message Presence {`
`365`		`- map<string, string> data = 1;`
	`365`	`+ repeated string data = 1;`
`366`	`366`	`}`
`367`	`367`
`368`	`368`	`message Checkpoint {`