Change ref key of Clients from _id into (key, _id)

api/yorkie/v1/yorkie.proto

@@ -49,6 +49,7 @@ message ActivateClientResponse {
 
 message DeactivateClientRequest {
   string client_id = 1;
+  string client_key = 2;
 }
 
 message DeactivateClientResponse {
@@ -57,6 +58,7 @@ message DeactivateClientResponse {
 message AttachDocumentRequest {
   string client_id = 1;
   ChangePack change_pack = 2;
+  string client_key = 3;
 }
 
 message AttachDocumentResponse {
@@ -69,6 +71,7 @@ message DetachDocumentRequest {
   string document_id = 2;
   ChangePack change_pack = 3;
   bool remove_if_not_attached = 4;
+  string client_key = 5;
 }
 
 message DetachDocumentResponse {
@@ -79,6 +82,7 @@ message WatchDocumentRequest {
   string client_id = 1;
   string document_id = 2;
   string document_key = 3;
+  string client_key = 4;
 }
 
 message WatchDocumentResponse {
@@ -96,6 +100,7 @@ message RemoveDocumentRequest {
   string client_id = 1;
   string document_id = 2;
   ChangePack change_pack = 3;
+  string client_key = 4;
 }
 
 message RemoveDocumentResponse {
@@ -107,6 +112,7 @@ message PushPullChangesRequest {
   string document_id = 2;
   ChangePack change_pack = 3;
   bool push_only = 4;
+  string client_key = 5;
 }
 
 message PushPullChangesResponse {
@@ -119,6 +125,7 @@ message BroadcastRequest {
   string topic = 3;
   bytes payload = 4;
   string document_key = 5;
+  string client_key = 6;
 }
 
 message BroadcastResponse {

build/docker/sharding/test/scripts/init-mongos1.js

@@ -4,28 +4,44 @@ sh.addShard("shard-rs-2/shard2-1:27017")
 // The DB 'yorkie-meta-1' is for the mongo client test.
 sh.enableSharding("yorkie-meta-1")
 sh.shardCollection("yorkie-meta-1.users", { username: 1 }, true)
-// sh.shardCollection("yorkie-meta-1.clients", { _id: 1 }, true)
+sh.shardCollection("yorkie-meta-1.clients", { key: 1 })
 sh.shardCollection("yorkie-meta-1.documents", { key: 1 })
 sh.shardCollection("yorkie-meta-1.changes", { doc_key: 1 })
 sh.shardCollection("yorkie-meta-1.snapshots", { doc_key: 1 })
 sh.shardCollection("yorkie-meta-1.syncedseqs", { doc_key: 1 })
+
+const docSplitKey = "duplicateIDTestDocKey5"
+const clientSplitKey = "duplicateIDTestClientKey5"
+
 // Split the inital range at "duplicateIDTestDocKey5" to allow doc_ids duplicate in different shards.
-sh.splitAt("yorkie-meta-1.documents", { key: "duplicateIDTestDocKey5" })
+sh.splitAt("yorkie-meta-1.documents", { key: docSplitKey })
+// Move the chunk to another shard.
+const currentDocShard = db.getSiblingDB("config").chunks.findOne({ min: { key: docSplitKey } }).shard
+var nextDocShard = ""
+if (currentDocShard == "shard-rs-1") {
+    nextDocShard = "shard-rs-2"
+} else {
+    nextDocShard = "shard-rs-1"
+}
+db.adminCommand({ moveChunk: "yorkie-meta-1.documents", find: { key: docSplitKey }, to: nextDocShard })
+
+// Split the inital range at "duplicateIDTestClientKey5" to allow client_ids duplicate in different shards.
+sh.splitAt("yorkie-meta-1.clients", { key: clientSplitKey })
 // Move the chunk to another shard.
-const currentShard = db.getSiblingDB("config").chunks.findOne({ min: { key: 'duplicateIDTestDocKey5' } }).shard
-var nextShard = ""
-if (currentShard == "shard-rs-1") {
-    nextShard = "shard-rs-2"
+const currentClientShard = db.getSiblingDB("config").chunks.findOne({ min: { key: clientSplitKey } }).shard
+var nextClientShard = ""
+if (currentClientShard == "shard-rs-1") {
+    nextClientShard = "shard-rs-2"
 } else {
-    nextShard = "shard-rs-1"
+    nextClientShard = "shard-rs-1"
 }
-db.adminCommand({ moveChunk: "yorkie-meta-1.documents", find: { key: "duplicateIDTestDocKey5" }, to: nextShard })
+db.adminCommand({ moveChunk: "yorkie-meta-1.clients", find: { key: clientSplitKey }, to: nextClientShard })
 
 
 // The DB 'yorkie-meta-2' is for the server test.
 sh.enableSharding("yorkie-meta-2")
 sh.shardCollection("yorkie-meta-2.users", { username: 1 }, true)
-// sh.shardCollection("yorkie-meta-2.clients", { _id: 1 }, true)
+sh.shardCollection("yorkie-meta-2.clients", { key: 1 })
 sh.shardCollection("yorkie-meta-2.documents", { key: 1 })
 sh.shardCollection("yorkie-meta-2.changes", { doc_key: 1 })
 sh.shardCollection("yorkie-meta-2.snapshots", { doc_key: 1 })

client/client.go

@@ -233,7 +233,8 @@ func (c *Client) Deactivate(ctx context.Context) error {
 	}
 
 	_, err := c.client.DeactivateClient(withShardKey(ctx, c.options.APIKey), &api.DeactivateClientRequest{
-		ClientId: c.id.String(),
+		ClientKey: c.key,
+		ClientId:  c.id.String(),
 	})
 	if err != nil {
 		return err
@@ -277,6 +278,7 @@ func (c *Client) Attach(ctx context.Context, doc *document.Document, options ...
 	res, err := c.client.AttachDocument(
 		withShardKey(ctx, c.options.APIKey, doc.Key().String()),
 		&api.AttachDocumentRequest{
+			ClientKey:  c.key,
 			ClientId:   c.id.String(),
 			ChangePack: pbChangePack,
 		},
@@ -350,6 +352,7 @@ func (c *Client) Detach(ctx context.Context, doc *document.Document, options ...
 	res, err := c.client.DetachDocument(
 		withShardKey(ctx, c.options.APIKey, doc.Key().String()),
 		&api.DetachDocumentRequest{
+			ClientKey:           c.key,
 			ClientId:            c.id.String(),
 			DocumentId:          attachment.docID.String(),
 			ChangePack:          pbChangePack,
@@ -413,6 +416,7 @@ func (c *Client) Watch(
 	stream, err := c.client.WatchDocument(
 		withShardKey(ctx, c.options.APIKey, doc.Key().String()),
 		&api.WatchDocumentRequest{
+			ClientKey:   c.key,
 			ClientId:    c.id.String(),
 			DocumentKey: doc.Key().String(),
 			DocumentId:  attachment.docID.String(),
@@ -600,6 +604,7 @@ func (c *Client) pushPullChanges(ctx context.Context, opt SyncOptions) error {
 	res, err := c.client.PushPullChanges(
 		withShardKey(ctx, c.options.APIKey, opt.key.String()),
 		&api.PushPullChangesRequest{
+			ClientKey:  c.key,
 			ClientId:   c.id.String(),
 			DocumentId: attachment.docID.String(),
 			ChangePack: pbChangePack,
@@ -645,6 +650,7 @@ func (c *Client) Remove(ctx context.Context, doc *document.Document) error {
 	res, err := c.client.RemoveDocument(
 		withShardKey(ctx, c.options.APIKey, doc.Key().String()),
 		&api.RemoveDocumentRequest{
+			ClientKey:  c.key,
 			ClientId:   c.id.String(),
 			DocumentId: attachment.docID.String(),
 			ChangePack: pbChangePack,
@@ -682,6 +688,7 @@ func (c *Client) broadcast(ctx context.Context, doc *document.Document, topic st
 	_, err := c.client.Broadcast(
 		withShardKey(ctx, c.options.APIKey, doc.Key().String()),
 		&api.BroadcastRequest{
+			ClientKey:   c.key,
 			ClientId:    c.id.String(),
 			DocumentKey: doc.Key().String(),
 			DocumentId:  attachment.docID.String(),

server/backend/database/database.go

@@ -127,10 +127,10 @@ type Database interface {
 	ActivateClient(ctx context.Context, projectID types.ID, key string) (*ClientInfo, error)
 
 	// DeactivateClient deactivates the client of the given ID.
-	DeactivateClient(ctx context.Context, projectID, clientID types.ID) (*ClientInfo, error)
+	DeactivateClient(ctx context.Context, clientKey string, clientID types.ID) (*ClientInfo, error)
 
-	// FindClientInfoByID finds the client of the given ID.
-	FindClientInfoByID(ctx context.Context, projectID, clientID types.ID) (*ClientInfo, error)
+	// FindClientInfoByKeyAndID finds the client of the given ID.
+	FindClientInfoByKeyAndID(ctx context.Context, clientKey string, clientID types.ID) (*ClientInfo, error)
 
 	// UpdateClientInfoAfterPushPull updates the client from the given clientInfo
 	// after handling PushPull.

server/backend/database/memory/database.go

@@ -442,27 +442,33 @@ func (d *DB) ActivateClient(
 }
 
 // DeactivateClient deactivates a client.
-func (d *DB) DeactivateClient(_ context.Context, projectID, clientID types.ID) (*database.ClientInfo, error) {
+func (d *DB) DeactivateClient(
+	_ context.Context,
+	clientKey string,
+	clientID types.ID,
+) (*database.ClientInfo, error) {
 	if err := clientID.Validate(); err != nil {
 		return nil, err
 	}
 
 	txn := d.db.Txn(true)
 	defer txn.Abort()
 
-	raw, err := txn.First(tblClients, "id", clientID.String())
+	raw, err := txn.First(
+		tblClients,
+		"key_id",
+		clientKey,
+		clientID.String(),
+	)
 	if err != nil {
-		return nil, fmt.Errorf("find client by id: %w", err)
+		return nil, fmt.Errorf("find client by key and id: %w", err)
 	}
 
 	if raw == nil {
 		return nil, fmt.Errorf("%s: %w", clientID, database.ErrClientNotFound)
 	}
 
 	clientInfo := raw.(*database.ClientInfo)
-	if err := clientInfo.CheckIfInProject(projectID); err != nil {
-		return nil, err
-	}
 
 	// NOTE(hackerwins): When retrieving objects from go-memdb, references to
 	// the stored objects are returned instead of new objects. This can cause
@@ -477,28 +483,33 @@ func (d *DB) DeactivateClient(_ context.Context, projectID, clientID types.ID) (
 	return clientInfo, nil
 }
 
-// FindClientInfoByID finds a client by ID.
-func (d *DB) FindClientInfoByID(_ context.Context, projectID, clientID types.ID) (*database.ClientInfo, error) {
+// FindClientInfoByKeyAndID finds a client by the given key and ID.
+func (d *DB) FindClientInfoByKeyAndID(
+	_ context.Context,
+	clientKey string,
+	clientID types.ID,
+) (*database.ClientInfo, error) {
 	if err := clientID.Validate(); err != nil {
 		return nil, err
 	}
 
 	txn := d.db.Txn(false)
 	defer txn.Abort()
 
-	raw, err := txn.First(tblClients, "id", clientID.String())
+	raw, err := txn.First(
+		tblClients,
+		"key_id",
+		clientKey,
+		clientID.String(),
+	)
 	if err != nil {
-		return nil, fmt.Errorf("find client by id: %w", err)
+		return nil, fmt.Errorf("find client by key and id: %w", err)
 	}
 	if raw == nil {
 		return nil, fmt.Errorf("%s: %w", clientID, database.ErrClientNotFound)
 	}
 
 	clientInfo := raw.(*database.ClientInfo)
-	if err := clientInfo.CheckIfInProject(projectID); err != nil {
-		return nil, err
-	}
-
 	return clientInfo.DeepCopy(), nil
 }
 
@@ -518,9 +529,14 @@ func (d *DB) UpdateClientInfoAfterPushPull(
 	txn := d.db.Txn(true)
 	defer txn.Abort()
 
-	raw, err := txn.First(tblClients, "id", clientInfo.ID.String())
+	raw, err := txn.First(
+		tblClients,
+		"key_id",
+		clientInfo.Key,
+		clientInfo.ID.String(),
+	)
 	if err != nil {
-		return fmt.Errorf("find client by id: %w", err)
+		return fmt.Errorf("find client by key and id: %w", err)
 	}
 	if raw == nil {
 		return fmt.Errorf("%s: %w", clientInfo.ID, database.ErrClientNotFound)
@@ -1171,9 +1187,10 @@ func (d *DB) UpdateSyncedSeq(
 	if !isAttached {
 		if _, err = txn.DeleteAll(
 			tblSyncedSeqs,
-			"doc_key_doc_id_client_id",
+			"doc_key_doc_id_client_key_client_id",
 			docKey.String(),
 			docID.String(),
+			clientInfo.Key,
 			clientInfo.ID.String(),
 		); err != nil {
 			return fmt.Errorf("delete syncedseqs of the document (%s.%s): %w",
@@ -1190,9 +1207,10 @@ func (d *DB) UpdateSyncedSeq(
 
 	raw, err := txn.First(
 		tblSyncedSeqs,
-		"doc_key_doc_id_client_id",
+		"doc_key_doc_id_client_key_client_id",
 		docKey.String(),
 		docID.String(),
+		clientInfo.Key,
 		clientInfo.ID.String(),
 	)
 	if err != nil {

server/backend/database/memory/indexes.go

@@ -83,6 +83,16 @@ var schema = &memdb.DBSchema{
 					Unique:  true,
 					Indexer: &memdb.StringFieldIndex{Field: "ID"},
 				},
+				"key_id": {
+					Name:   "key_id",
+					Unique: true,
+					Indexer: &memdb.CompoundIndex{
+						Indexes: []memdb.Indexer{
+							&memdb.StringFieldIndex{Field: "Key"},
+							&memdb.StringFieldIndex{Field: "ID"},
+						},
+					},
+				},
 				"project_id": {
 					Name:    "project_id",
 					Indexer: &memdb.StringFieldIndex{Field: "ProjectID"},
@@ -207,13 +217,14 @@ var schema = &memdb.DBSchema{
 					Unique:  true,
 					Indexer: &memdb.StringFieldIndex{Field: "ID"},
 				},
-				"doc_key_doc_id_client_id": {
-					Name:   "doc_key_doc_id_client_id",
+				"doc_key_doc_id_client_key_client_id": {
+					Name:   "doc_key_doc_id_client_key_client_id",
 					Unique: true,
 					Indexer: &memdb.CompoundIndex{
 						Indexes: []memdb.Indexer{
 							&memdb.StringFieldIndex{Field: "DocKey"},
 							&memdb.StringFieldIndex{Field: "DocID"},
+							&memdb.StringFieldIndex{Field: "ClientKey"},
 							&memdb.StringFieldIndex{Field: "ClientID"},
 						},
 					},