Change 'Documents' from plural to singular in DocEvent

api/converter/from_pb.go

@@ -204,12 +204,12 @@ func FromDocumentID(pbID string) (types.ID, error) {
 // FromEventType converts the given Protobuf formats to model format.
 func FromEventType(pbDocEventType api.DocEventType) (types.DocEventType, error) {
 	switch pbDocEventType {
-	case api.DocEventType_DOC_EVENT_TYPE_DOCUMENTS_CHANGED:
-		return types.DocumentsChangedEvent, nil
-	case api.DocEventType_DOC_EVENT_TYPE_DOCUMENTS_WATCHED:
-		return types.DocumentsWatchedEvent, nil
-	case api.DocEventType_DOC_EVENT_TYPE_DOCUMENTS_UNWATCHED:
-		return types.DocumentsUnwatchedEvent, nil
+	case api.DocEventType_DOC_EVENT_TYPE_DOCUMENT_CHANGED:
+		return types.DocumentChangedEvent, nil
+	case api.DocEventType_DOC_EVENT_TYPE_DOCUMENT_WATCHED:
+		return types.DocumentWatchedEvent, nil
+	case api.DocEventType_DOC_EVENT_TYPE_DOCUMENT_UNWATCHED:
+		return types.DocumentUnwatchedEvent, nil
 	}
 	return "", fmt.Errorf("%v: %w", pbDocEventType, ErrUnsupportedEventType)
 }

api/converter/to_pb.go

@@ -201,12 +201,12 @@ func ToChangeID(id change.ID) *api.ChangeID {
 // ToDocEventType converts the given model format to Protobuf format.
 func ToDocEventType(eventType types.DocEventType) (api.DocEventType, error) {
 	switch eventType {
-	case types.DocumentsChangedEvent:
-		return api.DocEventType_DOC_EVENT_TYPE_DOCUMENTS_CHANGED, nil
-	case types.DocumentsWatchedEvent:
-		return api.DocEventType_DOC_EVENT_TYPE_DOCUMENTS_WATCHED, nil
-	case types.DocumentsUnwatchedEvent:
-		return api.DocEventType_DOC_EVENT_TYPE_DOCUMENTS_UNWATCHED, nil
+	case types.DocumentChangedEvent:
+		return api.DocEventType_DOC_EVENT_TYPE_DOCUMENT_CHANGED, nil
+	case types.DocumentWatchedEvent:
+		return api.DocEventType_DOC_EVENT_TYPE_DOCUMENT_WATCHED, nil
+	case types.DocumentUnwatchedEvent:
+		return api.DocEventType_DOC_EVENT_TYPE_DOCUMENT_UNWATCHED, nil
 	default:
 		return 0, fmt.Errorf("%s: %w", eventType, ErrUnsupportedEventType)
 	}

api/types/event.go

@@ -4,15 +4,15 @@ package types
 type DocEventType string
 
 const (
-	// DocumentsChangedEvent is an event indicating that documents are being
+	// DocumentChangedEvent is an event indicating that document is being
 	// modified by a change.
-	DocumentsChangedEvent DocEventType = "documents-changed"
+	DocumentChangedEvent DocEventType = "document-changed"
 
-	// DocumentsWatchedEvent is an event that occurs when documents are watched
+	// DocumentWatchedEvent is an event that occurs when document is watched
 	// by other clients.
-	DocumentsWatchedEvent DocEventType = "documents-watched"
+	DocumentWatchedEvent DocEventType = "document-watched"
 
-	// DocumentsUnwatchedEvent is an event that occurs when documents are
+	// DocumentUnwatchedEvent is an event that occurs when document is
 	// unwatched by other clients.
-	DocumentsUnwatchedEvent DocEventType = "documents-unwatched"
+	DocumentUnwatchedEvent DocEventType = "document-unwatched"
 )

api/yorkie/v1/resources.proto

@@ -353,9 +353,9 @@ enum ValueType {
 }
 
 enum DocEventType {
-  DOC_EVENT_TYPE_DOCUMENTS_CHANGED = 0;
-  DOC_EVENT_TYPE_DOCUMENTS_WATCHED = 1;
-  DOC_EVENT_TYPE_DOCUMENTS_UNWATCHED = 2;
+  DOC_EVENT_TYPE_DOCUMENT_CHANGED = 0;
+  DOC_EVENT_TYPE_DOCUMENT_WATCHED = 1;
+  DOC_EVENT_TYPE_DOCUMENT_UNWATCHED = 2;
 }
 
 message DocEvent {

client/client.go

@@ -446,9 +446,9 @@ func (c *Client) Watch(
 			}
 
 			switch eventType {
-			case types.DocumentsChangedEvent:
+			case types.DocumentChangedEvent:
 				return &WatchResponse{Type: DocumentChanged}, nil
-			case types.DocumentsWatchedEvent:
+			case types.DocumentWatchedEvent:
 				doc.AddOnlineClient(cli.String())
 				if doc.Presence(cli.String()) == nil {
 					return nil, nil
@@ -460,7 +460,7 @@ func (c *Client) Watch(
 						cli.String(): doc.Presence(cli.String()),
 					},
 				}, nil
-			case types.DocumentsUnwatchedEvent:
+			case types.DocumentUnwatchedEvent:
 				p := doc.Presence(cli.String())
 				doc.RemoveOnlineClient(cli.String())
 				if p == nil {

pkg/document/internal_document.go

@@ -259,6 +259,9 @@ func (d *InternalDocument) ApplyChanges(changes ...*change.Change) ([]DocEvent,
 			if _, ok := d.onlineClients.Load(clientID); ok {
 				switch c.PresenceChange().ChangeType {
 				case innerpresence.Put:
+					// NOTE(chacha912): When the user exists in onlineClients, but
+					// their presence was initially absent, we can consider that we have
+					// received their initial presence, so trigger the 'watched' event.
 					eventType := PresenceChangedEvent
 					if !d.presences.Has(clientID) {
 						eventType = WatchedEvent
@@ -271,6 +274,11 @@ func (d *InternalDocument) ApplyChanges(changes ...*change.Change) ([]DocEvent,
 					}
 					events = append(events, event)
 				case innerpresence.Clear:
+					// NOTE(chacha912): When the user exists in onlineClients, but
+					// PresenceChange(clear) is received, we can consider it as detachment
+					// occurring before unwatching.
+					// Detached user is no longer participating in the document, we remove
+					// them from the online clients and trigger the 'unwatched' event.
 					event := DocEvent{
 						Type: UnwatchedEvent,
 						Presences: map[string]innerpresence.Presence{

server/backend/sync/memory/pubsub_test.go

@@ -39,7 +39,7 @@ func TestPubSub(t *testing.T) {
 		pubSub := memory.NewPubSub()
 		id := types.ID(t.Name() + "id")
 		docEvent := sync.DocEvent{
-			Type:       types.DocumentsWatchedEvent,
+			Type:       types.DocumentWatchedEvent,
 			Publisher:  idB,
 			DocumentID: id,
 		}

server/packs/packs.go

@@ -132,7 +132,7 @@ func PushPull(
 				ctx,
 				publisherID,
 				sync.DocEvent{
-					Type:       types.DocumentsChangedEvent,
+					Type:       types.DocumentChangedEvent,
 					Publisher:  publisherID,
 					DocumentID: docInfo.ID,
 				},

server/rpc/admin_server.go

@@ -375,7 +375,7 @@ func (s *adminServer) RemoveDocumentByAdmin(
 		ctx,
 		publisherID,
 		sync.DocEvent{
-			Type:       types.DocumentsChangedEvent,
+			Type:       types.DocumentChangedEvent,
 			Publisher:  publisherID,
 			DocumentID: docInfo.ID,
 		},

server/rpc/yorkie_server.go

@@ -530,7 +530,7 @@ func (s *yorkieServer) watchDoc(
 		ctx,
 		subscription.Subscriber(),
 		sync.DocEvent{
-			Type:       types.DocumentsWatchedEvent,
+			Type:       types.DocumentWatchedEvent,
 			Publisher:  subscription.Subscriber(),
 			DocumentID: documentID,
 		},
@@ -549,7 +549,7 @@ func (s *yorkieServer) unwatchDoc(
 		ctx,
 		subscription.Subscriber(),
 		sync.DocEvent{
-			Type:       types.DocumentsUnwatchedEvent,
+			Type:       types.DocumentUnwatchedEvent,
 			Publisher:  subscription.Subscriber(),
 			DocumentID: documentID,
 		},