fixes based on pr comments

- renamed the api path fixes
- changed the response of the get request to include multiple sequences
- updated the docstrings and the open api spec
- fixed the permission issue in the route
- handle not found error in the rest handler

Author: RIT3shSapata

db/crud.go

@@ -222,54 +222,58 @@ func (c *DatabaseCollection) GetDocSyncData(ctx context.Context, docid string) (
 
 }
 
+type ChannelHistory map[string]map[uint64]bool
+
+func (ch ChannelHistory) addChannelHistoryEntry(name string, seq uint64) {
+	if _, ok := ch[name]; !ok {
+		ch[name] = make(map[uint64]bool)
+	}
+	if _, ok := ch[name][seq]; !ok {
+		ch[name][seq] = true
+	}
+}
+
+func (ch ChannelHistory) getChannelHistoryResponse() map[string][]uint64 {
+	response := make(map[string][]uint64)
+	for chanName, chanEntry := range ch {
+		response[chanName] = make([]uint64, 0)
+		for seq, _ := range chanEntry {
+			response[chanName] = append(response[chanName], seq)
+		}
+	}
+	return response
+}
+
 // GetDocChannelHistory returns the channel revocation history for the given document as a map
 // from channel name to the sequences at which the document was removed from that channel.
 // It collects revocation sequences from the active Channels map, the ChannelSet, and the
 // ChannelSetHistory (overflow). Only channels that have been revoked at least once appear in
 // the result; active memberships with no revocation history are omitted, even though a currently
 // assigned channel can still appear if it was revoked and later re-added.
-func (c *DatabaseCollection) GetDocChannelHistory(ctx context.Context, docid string) (map[string]uint64, error) {
+func (c *DatabaseCollection) GetDocChannelHistory(ctx context.Context, docid string) (map[string][]uint64, error) {
 
-	chanHistory := make(map[string]uint64)
+	chanHistory := make(ChannelHistory)
 	syncData, err := c.GetDocSyncData(ctx, docid)
 	if err != nil {
 		return nil, err
 	}
 	for chanName, chanVal := range syncData.Channels {
 		if chanVal != nil {
-			if _, ok := chanHistory[chanName]; !ok {
-				chanHistory[chanName] = chanVal.Seq
-				continue
-			}
-			if chanVal.Seq > chanHistory[chanName] {
-				chanHistory[chanName] = chanVal.Seq
-			}
+			chanHistory.addChannelHistoryEntry(chanName, chanVal.Seq)
 		}
 	}
 	for _, chanSetEntry := range syncData.ChannelSet {
 		if chanSetEntry.End != 0 {
-			if _, ok := chanHistory[chanSetEntry.Name]; !ok {
-				chanHistory[chanSetEntry.Name] = chanSetEntry.End
-				continue
-			}
-			if chanSetEntry.End > chanHistory[chanSetEntry.Name] {
-				chanHistory[chanSetEntry.Name] = chanSetEntry.End
-			}
+			chanHistory.addChannelHistoryEntry(chanSetEntry.Name, chanSetEntry.End)
 		}
 	}
 	for _, chanSetEntry := range syncData.ChannelSetHistory {
 		if chanSetEntry.End != 0 {
-			if _, ok := chanHistory[chanSetEntry.Name]; !ok {
-				chanHistory[chanSetEntry.Name] = chanSetEntry.End
-				continue
-			}
-			if chanSetEntry.End > chanHistory[chanSetEntry.Name] {
-				chanHistory[chanSetEntry.Name] = chanSetEntry.End
-			}
+			chanHistory.addChannelHistoryEntry(chanSetEntry.Name, chanSetEntry.End)
 		}
 	}
 
-	return chanHistory, nil
+	return chanHistory.getChannelHistoryResponse(), nil
 }
 
 // CompactDocChannelHistory removes channel history entries that ended at or before the given sequence number.

docs/api/admin.yaml

@@ -126,9 +126,9 @@ paths:
   '/{keyspace}/_purge':
     $ref: './paths/admin/keyspace-_purge.yaml'
   '/{keyspace}/_channel_history/{docid}':
-    $ref: './paths/admin/keyspace-_history.yaml'
+    $ref: './paths/admin/keyspace-_channel_history.yaml'
   '/{keyspace}/_channel_history/{docid}/compact':
-    $ref: './paths/admin/keyspace-_history-compact.yaml'
+    $ref: './paths/admin/keyspace-_channel_history-compact.yaml'
   '/{db}/_flush':
     $ref: './paths/admin/db-_flush.yaml'
   '/{db}/_online':

…ths/admin/keyspace-_history-compact.yaml …n/keyspace-_channel_history-compact.yamldocs/api/paths/admin/keyspace-_history-compact.yaml renamed to docs/api/paths/admin/keyspace-_channel_history-compact.yaml docs/api/paths/admin/keyspace-_history-compact.yaml renamed to docs/api/paths/admin/keyspace-_channel_history-compact.yaml

@@ -11,11 +11,11 @@ parameters:
 post:
   summary: Compact Channel History of Document
   description: |-
-    Compacts inactive channel history entries from one or more documents before a specified sequence number.
+    Compacts channel history for a specified document.  Channel history older than the specified sequence will be removed.
 
-    This endpoint removes all inactive channel entries (for sequences before the specified sequence number where the document left the channel),
+    This endpoint removes all channel entries (for sequences before the specified sequence number where the document left the channel),
     effectively cleaning up historical channel membership information while preserving active channels and recent changes.
-    This is useful for reducing storage overhead when maintaining large document histories.
+    This can be useful for reducing metadata size for documents that frequently gain and lose access to channels.
 
     Required Sync Gateway RBAC roles:
 
@@ -30,18 +30,18 @@ post:
           properties:
             seq:
               description: |-
-                Channel history for inactive channels having end sequences earlier than this sequence will be removed from the specified document's metadata.
+                Channel history having end sequences earlier than this sequence will be removed from the specified document's metadata.
               type: integer
               format: int64
               minimum: 0
               example: 12345
   responses:
     '200':
       description: |-
-        Successfully compacted channel history from the specified documents.
-        Returns a mapping of document IDs to the list of channels that were compacted.
+        Successfully compacted channel history from the specified document.
+        Returns a list of channels that were compacted.
 
-        If a document ID has an empty array, it means either no channels were compacted for that document or the document was not found.
+        If the response has an empty array, it means either no channels were compacted.
 
       content:
         application/json:
@@ -61,7 +61,7 @@ post:
                 - channel1
                 - channel2
     '400':
-      description: 'Bad request. This could be due to invalid request parameters such as missing or malformed doc_ids array or invalid seq value.'
+      description: 'Bad request. This could be due to invalid request parameters such as invalid seq value.'
       content:
         application/json:
           schema:

…s/api/paths/admin/keyspace-_history.yaml …ths/admin/keyspace-_channel_history.yamldocs/api/paths/admin/keyspace-_history.yaml renamed to docs/api/paths/admin/keyspace-_channel_history.yaml docs/api/paths/admin/keyspace-_history.yaml renamed to docs/api/paths/admin/keyspace-_channel_history.yaml

@@ -12,9 +12,13 @@ get:
   summary: Get Channel History of Document
   description: |-
     Returns the channel revocation history for the specified document as a map of channel
-    names to the sequence at which the document was removed from each channel. Only channels
+    names to the array of sequences at which the document was removed from each channel. Only channels
     that have been revoked at least once are included; channels the document is currently
-    assigned to are excluded.
+    assigned may be included if they were previously revoked.
+
+    Multiple sequences for a given channel indicate that the document has lost access to that channel
+    more than once — each sequence represents a point in time at which the document was removed from
+    the channel.
 
     Required Sync Gateway RBAC roles:
 
@@ -24,21 +28,26 @@ get:
     '200':
       description: |-
         Successfully retrieved the channel revocation history for the specified document.
-        Returns a JSON object mapping each channel name to the sequence at which
+        Returns a JSON object mapping each channel name to an array of sequences at which
         the document was removed from that channel.
       content:
         application/json:
           schema:
             type: object
             additionalProperties:
-              type: integer
-              format: int64
-              minimum: 0
+              type: array
+              items:
+                type: integer
+                format: int64
+                minimum: 0
               description: Sequences at which the document was removed from this channel.
             description: Map of channel names to their revocation sequences.
             example:
-              channel1: 7
-              channel2: 5
+              channel1:
+                - 3
+                - 7
+              channel2:
+                - 5
     '404':
       description: Document not found.
       content:

rest/api_test.go

@@ -4052,6 +4052,15 @@ func TestDocumentChannelHistoryCompact(t *testing.T) {
 		// Compacting nonexistent doc should return not found error
 		_, err := collection.CompactDocChannelHistory(ctx, "nonexistent", 1)
 		assert.Error(t, err)
+
+		req := CompactDocChannelHistoryRequest{
+			Seq: 999999,
+		}
+
+		bodyBytes, err := base.JSONMarshal(req)
+		require.NoError(t, err)
+		resp := rt.SendAdminRequest("POST", "/{{.keyspace}}/_channel_history/nonexistent/compact", string(bodyBytes))
+		RequireStatus(t, resp, http.StatusNotFound)
 	})
 
 	t.Run("multiple channels with mixed history", func(t *testing.T) {
@@ -4282,6 +4291,7 @@ func TestGetDocChannelHistory(t *testing.T) {
 		version := rt.PutDoc("doc1", `{"channels": ["chan1"]}`)
 
 		version = rt.UpdateDoc("doc1", version, `{"channels": []}`)
+		chanRevocationSeq1 := rt.GetDocumentSequence("doc1")
 
 		version = rt.UpdateDoc("doc1", version, `{"channels": ["chan1","chan2"]}`)
 
@@ -4290,21 +4300,21 @@ func TestGetDocChannelHistory(t *testing.T) {
 
 		rt.UpdateDoc("doc1", version, `{"channels": ["chan3","chan2"]}`)
 
-		expectedChanHistory := map[string]uint64{
-			"chan1": chanRevocationSeq2,
-			"chan2": chanRevocationSeq2,
+		expectedChanHistory := map[string][]uint64{
+			"chan1": {chanRevocationSeq2, chanRevocationSeq1},
+			"chan2": {chanRevocationSeq2},
 		}
 
 		chanHistory, err := collection.GetDocChannelHistory(ctx, "doc1")
 		require.NoError(t, err)
 		require.Len(t, chanHistory, len(expectedChanHistory))
 		for chanName, expectedSeq := range expectedChanHistory {
-			assert.Equal(t, expectedSeq, chanHistory[chanName])
+			assert.ElementsMatch(t, expectedSeq, chanHistory[chanName])
 		}
 
 		resp := rt.SendAdminRequest("GET", "/{{.keyspace}}/_channel_history/doc1", "")
 		RequireStatus(t, resp, http.StatusOK)
-		var apiResult map[string]uint64
+		var apiResult map[string][]uint64
 		require.NoError(t, json.Unmarshal(resp.BodyBytes(), &apiResult))
 		require.Len(t, apiResult, len(expectedChanHistory))
 		for chanName, expectedSeq := range expectedChanHistory {
@@ -4339,15 +4349,15 @@ func TestGetDocChannelHistory(t *testing.T) {
 		version := rt.PutDoc("doc3", `{"channels": ["chan1"]}`)
 		rt.UpdateDoc("doc3", version, `{"channels": []}`)
 		revocationSeq := rt.GetDocumentSequence("doc3")
-		expected := map[string]uint64{"chan1": revocationSeq}
+		expected := map[string][]uint64{"chan1": {revocationSeq}}
 
 		chanHistory, err := collection.GetDocChannelHistory(ctx, "doc3")
 		require.NoError(t, err)
 		assert.Equal(t, expected, chanHistory)
 
 		resp := rt.SendAdminRequest("GET", "/{{.keyspace}}/_channel_history/doc3", "")
 		RequireStatus(t, resp, http.StatusOK)
-		var apiResult map[string]uint64
+		var apiResult map[string][]uint64
 		require.NoError(t, json.Unmarshal(resp.BodyBytes(), &apiResult))
 		assert.Equal(t, expected, apiResult)
 	})
@@ -4356,10 +4366,10 @@ func TestGetDocChannelHistory(t *testing.T) {
 		version := rt.PutDoc("doc4", `{"channels": ["chan1", "chan2", "chan3"]}`)
 		rt.UpdateDoc("doc4", version, `{"channels": []}`)
 		revocationSeq := rt.GetDocumentSequence("doc4")
-		expected := map[string]uint64{
-			"chan1": revocationSeq,
-			"chan2": revocationSeq,
-			"chan3": revocationSeq,
+		expected := map[string][]uint64{
+			"chan1": {revocationSeq},
+			"chan2": {revocationSeq},
+			"chan3": {revocationSeq},
 		}
 
 		chanHistory, err := collection.GetDocChannelHistory(ctx, "doc4")
@@ -4368,7 +4378,7 @@ func TestGetDocChannelHistory(t *testing.T) {
 
 		resp := rt.SendAdminRequest("GET", "/{{.keyspace}}/_channel_history/doc4", "")
 		RequireStatus(t, resp, http.StatusOK)
-		var apiResult map[string]uint64
+		var apiResult map[string][]uint64
 		require.NoError(t, json.Unmarshal(resp.BodyBytes(), &apiResult))
 		assert.Equal(t, expected, apiResult)
 	})
@@ -4388,7 +4398,7 @@ func TestGetDocChannelHistory(t *testing.T) {
 
 		resp := rt.SendAdminRequest("GET", "/{{.keyspace}}/_channel_history/doc5", "")
 		RequireStatus(t, resp, http.StatusOK)
-		var apiResult map[string]uint64
+		var apiResult map[string][]uint64
 		require.NoError(t, json.Unmarshal(resp.BodyBytes(), &apiResult))
 		assert.NotEmpty(t, apiResult["chan1"])
 	})
@@ -4398,7 +4408,7 @@ func TestGetDocChannelHistory(t *testing.T) {
 		version := rt.PutDoc("doc6", `{"channels": ["chan1", "chan2"]}`)
 		rt.UpdateDoc("doc6", version, `{"channels": ["chan2"]}`)
 		revocationSeq := rt.GetDocumentSequence("doc6")
-		expected := map[string]uint64{"chan1": revocationSeq}
+		expected := map[string][]uint64{"chan1": {revocationSeq}}
 
 		chanHistory, err := collection.GetDocChannelHistory(ctx, "doc6")
 		require.NoError(t, err)
@@ -4407,7 +4417,7 @@ func TestGetDocChannelHistory(t *testing.T) {
 
 		resp := rt.SendAdminRequest("GET", "/{{.keyspace}}/_channel_history/doc6", "")
 		RequireStatus(t, resp, http.StatusOK)
-		var apiResult map[string]uint64
+		var apiResult map[string][]uint64
 		require.NoError(t, json.Unmarshal(resp.BodyBytes(), &apiResult))
 		assert.Equal(t, expected, apiResult)
 	})
@@ -4419,15 +4429,15 @@ func TestGetDocChannelHistory(t *testing.T) {
 
 		// Re-add chan1 — it should still appear in history from the earlier revocation
 		rt.UpdateDoc("doc8", version, `{"channels": ["chan1"]}`)
-		expected := map[string]uint64{"chan1": revocationSeq}
+		expected := map[string][]uint64{"chan1": {revocationSeq}}
 
 		chanHistory, err := collection.GetDocChannelHistory(ctx, "doc8")
 		require.NoError(t, err)
 		assert.Equal(t, expected, chanHistory)
 
 		resp := rt.SendAdminRequest("GET", "/{{.keyspace}}/_channel_history/doc8", "")
 		RequireStatus(t, resp, http.StatusOK)
-		var apiResult map[string]uint64
+		var apiResult map[string][]uint64
 		require.NoError(t, json.Unmarshal(resp.BodyBytes(), &apiResult))
 		assert.Equal(t, expected, apiResult)
 	})

rest/doc_api.go

@@ -953,10 +953,10 @@ type CompactDocChannelHistoryRequest struct {
 	Seq uint64 `json:"seq"`
 }
 
-// handleCompactDocChannelHistory handles POST /{keyspace}/_channel_history/_compact.
-// It accepts a JSON body with a list of doc IDs and a sequence number, and removes channel
-// history entries that ended at or before that sequence for each document, returning the
-// list of compacted channel names per doc ID.
+// handleCompactDocChannelHistory handles POST /{keyspace}/_channel_history/{docid}/compact.
+// It accepts a JSON body containing a sequence number and removes channel history entries
+// for the specified document that ended at or before that sequence, returning the compacted
+// channel names for that document.
 func (h *handler) handleCompactDocChannelHistory() error {
 	h.assertAdminOnly()
 
@@ -978,7 +978,7 @@ func (h *handler) handleCompactDocChannelHistory() error {
 	}
 
 	channels, err := h.collection.CompactDocChannelHistory(h.ctx(), docid, req.Seq)
-	if err != nil && !base.IsDocNotFoundError(err) {
+	if err != nil {
 		return err
 	}
 	res := map[string][]string{

rest/routing.go

@@ -156,7 +156,7 @@ func CreateAdminRouter(sc *ServerContext) *mux.Router {
 	keyspace.Handle("/_dumpchannel/{channel}",
 		makeHandler(sc, adminPrivs, []Permission{PermReadAppData}, nil, (*handler).handleDumpChannel)).Methods("GET")
 	keyspace.Handle("/_channel_history/{docid:"+docRegex+"}",
-		makeHandler(sc, adminPrivs, []Permission{PermReadAppData, PermWriteAppData}, nil, (*handler).handleGetDocChannelHistory)).Methods("GET")
+		makeHandler(sc, adminPrivs, []Permission{PermReadAppData}, nil, (*handler).handleGetDocChannelHistory)).Methods("GET")
 	keyspace.Handle("/_channel_history/{docid:"+docRegex+"}/compact",
 		makeHandler(sc, adminPrivs, []Permission{PermWriteAppData}, nil, (*handler).handleCompactDocChannelHistory)).Methods("POST")