Clear presence when housekeeping process

build/charts/yorkie-cluster/templates/yorkie/deployment.yaml

@@ -45,6 +45,8 @@ spec:
           "{{ .Values.yorkie.ports.rpcPort }}",
           "--profiling-port",
           "{{ .Values.yorkie.ports.profilingPort }}",
+          "--backend-gateway-host",
+          "{{ .Values.yorkie.gateway }}.{{ .Values.yorkie.namespace }}.svc.cluster.local",
         ]
         ports:
           - containerPort: {{ .Values.yorkie.ports.rpcPort }}

build/charts/yorkie-cluster/values.yaml

@@ -3,6 +3,8 @@ yorkie:
   name: yorkie
   namespace: yorkie
 
+  gateway: yorkie-gateway
+
   autoscaling:
     enabled: false
     replicaCount: 3

client/client.go

@@ -393,6 +393,8 @@ func (c *Client) Detach(ctx context.Context, doc *document.Document, options ...
 		return err
 	}
 
+	// TODO(raararaara): We need to revert the presence clearing from the local
+	// changes, if the server fails to detach the document.
 	res, err := c.client.DetachDocument(
 		ctx,
 		withShardKey(connect.NewRequest(&api.DetachDocumentRequest{

cmd/yorkie/server.go

@@ -345,6 +345,19 @@ func init() {
 		server.DefaultHostname,
 		"Yorkie Server Hostname",
 	)
+	cmd.Flags().StringVar(
+		&conf.Backend.GatewayAddr,
+		"backend-gateway-addr",
+		server.DefaultGatewayAddr,
+		"Gateway address",
+	)
+
+	//cmd.Flags().StringVar(
+	//	&conf.Backend.SystemServerAddr,
+	//	"backend-gateway-addr",
+	//	server.DefaultSystemServerAddr,
+	//	"Gateway address",
+	//)
 
 	rootCmd.AddCommand(cmd)
 }

pkg/document/document.go

@@ -454,6 +454,11 @@ func (d *Document) BroadcastEventHandlers() map[string]func(
 	return d.broadcastEventHandlers
 }
 
+// setInternalDoc sets the given internal document to this document.
+func (d *Document) setInternalDoc(internalDoc *InternalDocument) {
+	d.doc = internalDoc
+}
+
 func messageFromMsgAndArgs(msgAndArgs ...interface{}) string {
 	if len(msgAndArgs) == 0 {
 		return ""

pkg/document/internal_document.go

@@ -136,6 +136,18 @@ func (d *InternalDocument) Checkpoint() change.Checkpoint {
 	return d.checkpoint
 }
 
+// SyncCheckpoint syncs the checkpoint and the changeID with the given serverSeq
+// and clientSeq.
+func (d *InternalDocument) SyncCheckpoint(serverSeq int64, clientSeq uint32) {
+	d.changeID = change.NewID(
+		clientSeq,
+		serverSeq,
+		d.changeID.Lamport(),
+		d.changeID.ActorID(),
+	)
+	d.checkpoint = d.checkpoint.SyncClientSeq(clientSeq)
+}
+
 // HasLocalChanges returns whether this document has local changes or not.
 func (d *InternalDocument) HasLocalChanges() bool {
 	return len(d.localChanges) > 0
@@ -372,3 +384,10 @@ func (d *InternalDocument) AddOnlineClient(clientID string) {
 func (d *InternalDocument) RemoveOnlineClient(clientID string) {
 	d.onlineClients.Delete(clientID)
 }
+
+// ToDocument converts this document to Document.
+func (d *InternalDocument) ToDocument() *Document {
+	doc := New(d.key)
+	doc.setInternalDoc(d)
+	return doc
+}

server/backend/config.go

@@ -81,6 +81,22 @@ type Config struct {
 
 	// Hostname is yorkie server hostname. hostname is used by metrics.
 	Hostname string `yaml:"Hostname"`
+
+	// GatewayAddr is the address of the gateway server.
+	GatewayAddr string `yaml:"GatewayAddr"`
+
+	ServerToken string `yaml:"YorkieServerToken"`
+
+	SystemServerAddr string `yaml:"SystemServerAddr"`
+}
+
+// FetchGatewayAddr returns the address of the gateway server.
+func (c *Config) FetchGatewayAddr(rpcAddr string) string {
+	if c.SystemServerAddr == "" {
+		return rpcAddr
+	}
+
+	return c.SystemServerAddr
 }
 
 // Validate validates this config.

server/backend/database/memory/database.go

@@ -569,13 +569,6 @@ func (d *DB) DeactivateClient(_ context.Context, refKey types.ClientRefKey) (*da
 	// the stored objects are returned instead of new objects. This can cause
 	// problems when directly modifying loaded objects. So, we need to DeepCopy.
 	clientInfo = clientInfo.DeepCopy()
-	for docID := range clientInfo.Documents {
-		if clientInfo.Documents[docID].Status == database.DocumentAttached {
-			if err := clientInfo.DetachDocument(docID); err != nil {
-				return nil, err
-			}
-		}
-	}
 	clientInfo.Deactivate()
 
 	if err := txn.Insert(tblClients, clientInfo); err != nil {

server/backend/database/mongo/client.go

@@ -549,39 +549,15 @@ func (c *Client) ActivateClient(ctx context.Context, projectID types.ID, key str
 	return &clientInfo, nil
 }
 
-// DeactivateClient deactivates the client of the given refKey and updates document statuses as detached.
+// DeactivateClient deactivates the client of the given refKey.
 func (c *Client) DeactivateClient(ctx context.Context, refKey types.ClientRefKey) (*database.ClientInfo, error) {
 	res := c.collection(ColClients).FindOneAndUpdate(ctx, bson.M{
 		"project_id": refKey.ProjectID,
 		"_id":        refKey.ClientID,
-	}, bson.A{
-		bson.M{
-			"$set": bson.M{
-				"status":     database.ClientDeactivated,
-				"updated_at": gotime.Now(),
-				"documents": bson.M{
-					"$arrayToObject": bson.M{
-						"$map": bson.M{
-							"input": bson.M{"$objectToArray": "$documents"},
-							"as":    "doc",
-							"in": bson.M{
-								"k": "$$doc.k",
-								"v": bson.M{
-									"$cond": bson.M{
-										"if": bson.M{"$eq": bson.A{"$$doc.v.status", database.DocumentAttached}},
-										"then": bson.M{
-											"client_seq": 0,
-											"server_seq": 0,
-											"status":     database.DocumentDetached,
-										},
-										"else": "$$doc.v",
-									},
-								},
-							},
-						},
-					},
-				},
-			},
+	}, bson.M{
+		"$set": bson.M{
+			"status":     database.ClientDeactivated,
+			"updated_at": gotime.Now(),
 		},
 	}, options.FindOneAndUpdate().SetReturnDocument(options.After))
 

server/backend/database/testcases/testcases.go

@@ -676,56 +676,6 @@ func RunActivateClientDeactivateClientTest(t *testing.T, db database.Database, p
 		assert.Equal(t, t.Name(), clientInfo.Key)
 		assert.Equal(t, database.ClientDeactivated, clientInfo.Status)
 	})
-
-	t.Run("ensure document detached when deactivate client test", func(t *testing.T) {
-		ctx := context.Background()
-
-		// 01. Create a client
-		clientInfo, err := db.ActivateClient(ctx, projectID, t.Name())
-		assert.NoError(t, err)
-		assert.Equal(t, t.Name(), clientInfo.Key)
-		assert.Equal(t, database.ClientActivated, clientInfo.Status)
-
-		// 02. Create documents and attach them to the client
-		for i := 0; i < 3; i++ {
-			docInfo, _ := db.FindDocInfoByKeyAndOwner(ctx, clientInfo.RefKey(), helper.TestDocKey(t, i), true)
-			assert.NoError(t, clientInfo.AttachDocument(docInfo.ID, false))
-			clientInfo.Documents[docInfo.ID].ServerSeq = 1
-			clientInfo.Documents[docInfo.ID].ClientSeq = 1
-			assert.NoError(t, db.UpdateClientInfoAfterPushPull(ctx, clientInfo, docInfo))
-
-			result, err := db.FindClientInfoByRefKey(ctx, clientInfo.RefKey())
-			assert.Equal(t, result.Documents[docInfo.ID].Status, database.DocumentAttached)
-			assert.Equal(t, result.Documents[docInfo.ID].ServerSeq, int64(1))
-			assert.Equal(t, result.Documents[docInfo.ID].ClientSeq, uint32(1))
-			assert.NoError(t, err)
-		}
-
-		// 03. Remove one document
-		docInfo, err := db.FindDocInfoByKeyAndOwner(ctx, clientInfo.RefKey(), helper.TestDocKey(t, 2), true)
-		assert.NoError(t, err)
-		assert.NoError(t, clientInfo.RemoveDocument(docInfo.ID))
-		assert.NoError(t, db.UpdateClientInfoAfterPushPull(ctx, clientInfo, docInfo))
-
-		// 04. Deactivate the client
-		result, err := db.DeactivateClient(ctx, types.ClientRefKey{
-			ProjectID: projectID,
-			ClientID:  clientInfo.ID,
-		})
-		assert.NoError(t, err)
-
-		// 05. Check whether doc.Status is reflected properly.
-		// If it was `DocumentAttached`, it should be changed to `DocumentDetached`.
-		for i := 0; i < 2; i++ {
-			docInfo, err := db.FindDocInfoByKeyAndOwner(ctx, clientInfo.RefKey(), helper.TestDocKey(t, i), true)
-			assert.NoError(t, err)
-			assert.Equal(t, result.Documents[docInfo.ID].Status, database.DocumentDetached)
-		}
-		// If it was `DocumentRemoved`, it should be remained `DocumentRemoved`.
-		docInfo, err = db.FindDocInfoByKeyAndOwner(ctx, clientInfo.RefKey(), helper.TestDocKey(t, 2), true)
-		assert.NoError(t, err)
-		assert.Equal(t, result.Documents[docInfo.ID].Status, database.DocumentRemoved)
-	})
 }
 
 // RunUpdateProjectInfoTest runs the UpdateProjectInfo tests for the given db.