CBG-5331: Wire up User Channel History compaction to REST API by RIT3shSapata · Pull Request #8277 · couchbase/sync_gateway

RIT3shSapata · 2026-05-15T16:46:36Z

CBG-5331

Describe your PR here...

Wire up User Channel History compaction to REST API
Added test coverage for the API
Added test coverage for revocations

Pre-review checklist

Removed debug logging (fmt.Print, log.Print, ...)
Logging sensitive data? Make sure it's tagged (e.g. base.UD(docID), base.MD(dbName))
Updated relevant information in the API specifications (such as endpoint descriptions, schemas, ...) in docs/api

Dependencies (if applicable)

Link upstream PRs
Update Go module dependencies when merged

Integration Tests

https://jenkins.sgwdev.com/job/SyncGatewayIntegration/635/

github-actions · 2026-05-15T16:46:49Z

Redocly previews

Copilot

Pull request overview

This PR wires user channel-history retrieval/compaction into the Admin REST API and adds tests/docs for the new behavior.

Changes:

Adds GET/POST /_user/{name}/_channel_history routes and handlers.
Adds API tests for retrieving and compacting user channel history.
Updates/removes OpenAPI path entries related to user history compaction.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
`rest/admin_api.go`	Adds channel history response types and REST handlers.
`rest/routing.go`	Registers channel history admin routes.
`rest/user_api_test.go`	Adds coverage for GET/POST user channel history behavior.
`rest/revocation_test.go`	Extends revocation coverage to include compaction.
`auth/principal.go`	Adds channel history compaction to the user interface.
`docs/api/admin.yaml`	Removes the old compact path reference.
`docs/api/paths/admin/db-_user-name-_history.yaml`	Adds POST documentation for compaction.
`docs/api/paths/admin/db-_user-name-_history-compact.yaml`	Deletes the standalone compact path spec.

Comments suppressed due to low confidence (1)

docs/api/paths/admin/db-_user-name-_history.yaml:83

The documented 400 response mentions invalid channel names, but the handler only returns 400 for JSON decoding failures and otherwise silently ignores unknown or malformed channel strings. Either validate the request and return this error, or narrow the documentation to malformed request bodies so clients do not rely on validation that is not implemented.

    '400':
      description: Bad request. Invalid channel names or malformed request body.
      content:
        application/json:
          schema:
            $ref: ../../components/schemas.yaml#/HTTP-Error
          example:
            error: "Bad Request"
            reason: "Invalid channel format: channels must be non-empty strings"

 	assert.Equal(t, "doc", changes.Results[0].ID)
 	assert.True(t, changes.Results[0].Revoked)
+
+	body := fmt.Sprintf(`{"channels": {%q:{%q:["A"]}}}'`, dataStore.ScopeName(), dataStore.CollectionName())


adamcfraser · 2026-05-22T00:08:27Z

+            channels:
+              scope1:
+                collection1:
+                  - scoped_channel2


+	err = authenticator.Save(user)
+	if err != nil {
+		return err
+	}
+
+	h.writeJSON(userCompactedChannelHistory)


+	for scope, _ := range colAccess {
+		colAccessHistoryMap[scope] = make(map[string][]string)
+		for col, _ := range colAccess[scope] {
+			colAccessHistoryMap[scope][col] = slices.Collect(maps.Keys(colAccess[scope][col].ChannelHistory_))
+		}
+	}
+


+	dbr.Handle("/_user/{name}/_channel_history",
+		makeHandler(sc, adminPrivs, []Permission{PermReadPrincipal}, nil, (*handler).getUserChannelHistory)).Methods("GET")
+	dbr.Handle("/_user/{name}/_channel_history",
+		makeHandler(sc, adminPrivs, []Permission{PermWritePrincipal}, nil, (*handler).compactUserChannelHistory)).Methods("POST")


Copilot

Pull request overview

Copilot reviewed 9 out of 10 changed files in this pull request and generated 3 comments.

adamcfraser · 2026-05-22T00:08:27Z

+            channels:
+              scope1:
+                collection1:
+                  - scoped_channel2


adamcfraser

A few suggestions for refactoring to move logic to a more appropriate place, and some minor code style suggestions.

adamcfraser · 2026-05-22T23:40:27Z

+
+// TestCompactUserChannelHistory tests the POST /_user/{name}/_access_history/compact admin endpoint,
+// which removes specified channels from a user's revocation history and returns those that were found and removed.
+func TestCompactUserChannelHistory(t *testing.T) {


Given the custom handling for the default collection, this should include tests for a mix of default-only, named collections only, and the combination of both.

The default collection and named collections are handled in the CI runs, when they are run using SG_TEST_USE_DEFAULT_COLLECTION=true for default collections. Did you want me to write subtests that use NewRestTesterDefaultCollection?

We want to test the combination of _default._default and _default.collection1 in the same database, which I don't think is covered by USE_DEFAULT_COLLECTION=true, which just uses _default._default?

In this scenario the channel history will end up both at the root level (for _default._default) and inside collection_access (for _default.collection1) and we want to make sure compaction is properly handling this case.

adamcfraser · 2026-05-22T23:42:10Z


+// TestGetUserChannelHistory tests the GET /_user/{name}/_access_history admin endpoint,
+// which returns the revoked channel history for a user across all scopes and collections.
+func TestGetUserChannelHistory(t *testing.T) {


Given the custom handling for the default collection, this should include tests for a mix of default-only, named collections only, and the combination of both.

- added docstrings - updated api spec

- updated the rest api for get and post reqests - fix the case for default collection - update the open api spec

- moved few methods under principal - abstract the channel history implementation - rename few structs

adamcfraser · 2026-05-28T21:31:59Z

+
+// TestCompactUserChannelHistory tests the POST /_user/{name}/_access_history/compact admin endpoint,
+// which removes specified channels from a user's revocation history and returns those that were found and removed.
+func TestCompactUserChannelHistory(t *testing.T) {


We want to test the combination of _default._default and _default.collection1 in the same database, which I don't think is covered by USE_DEFAULT_COLLECTION=true, which just uses _default._default?

In this scenario the channel history will end up both at the root level (for _default._default) and inside collection_access (for _default.collection1) and we want to make sure compaction is properly handling this case.

RIT3shSapata · 2026-06-01T08:53:18Z

As discussed offline, the test for the case that you pointed out is covered in the tests in rest/upgradetest/user_access_history_test.go

adamcfraser

LGTM - thanks.

RIT3shSapata self-assigned this May 15, 2026

Copilot AI review requested due to automatic review settings May 15, 2026 16:46

RIT3shSapata assigned adamcfraser and unassigned RIT3shSapata May 15, 2026

RIT3shSapata requested a review from adamcfraser May 15, 2026 16:46

Copilot started reviewing on behalf of RIT3shSapata May 15, 2026 16:47 View session

Copilot AI reviewed May 15, 2026

View reviewed changes

RIT3shSapata assigned RIT3shSapata and unassigned adamcfraser May 15, 2026

RIT3shSapata force-pushed the CBG-5331 branch from 61cd57b to 33cf7be Compare May 21, 2026 17:05

RIT3shSapata requested a review from Copilot May 21, 2026 17:06

RIT3shSapata assigned adamcfraser and unassigned RIT3shSapata May 21, 2026

Copilot started reviewing on behalf of RIT3shSapata May 21, 2026 17:06 View session

Copilot AI reviewed May 21, 2026

View reviewed changes

Comment thread rest/revocation_test.go Outdated

Comment thread rest/user_api_test.go Outdated

Comment thread docs/api/paths/admin/db-_user-name-_channel_history.yaml Outdated

adamcfraser requested changes May 22, 2026

View reviewed changes

adamcfraser assigned RIT3shSapata and unassigned adamcfraser May 22, 2026

RIT3shSapata requested a review from adamcfraser May 22, 2026 16:14

RIT3shSapata assigned adamcfraser and unassigned RIT3shSapata May 22, 2026

adamcfraser requested changes May 22, 2026

View reviewed changes

adamcfraser assigned RIT3shSapata and unassigned adamcfraser May 22, 2026

RIT3shSapata added 5 commits May 25, 2026 14:42

wire up rest api

5c595a2

add test coverage for revocations

d9a1c90

add more test cases

c5e397e

add documentation

5197815

- added docstrings - updated api spec

update rest api and handle default collection

34c03ad

- updated the rest api for get and post reqests - fix the case for default collection - update the open api spec

fixes based on PR comments

196ea46

RIT3shSapata force-pushed the CBG-5331 branch from c69aac9 to 196ea46 Compare May 25, 2026 09:13

RIT3shSapata added 3 commits May 25, 2026 17:29

fixes based on pr comments

a26ae48

- moved few methods under principal - abstract the channel history implementation - rename few structs

lint fix

aa19305

Added test for the upgrade scenario

232d499

RIT3shSapata requested a review from adamcfraser May 27, 2026 13:05

RIT3shSapata assigned adamcfraser and unassigned RIT3shSapata May 27, 2026

lint fix

e49e484

adamcfraser requested changes May 28, 2026

View reviewed changes

adamcfraser assigned RIT3shSapata and unassigned adamcfraser May 28, 2026

RIT3shSapata assigned adamcfraser and unassigned RIT3shSapata Jun 1, 2026

RIT3shSapata requested a review from adamcfraser June 1, 2026 08:53

adamcfraser approved these changes Jun 1, 2026

View reviewed changes

adamcfraser merged commit 2cc594d into main Jun 1, 2026
51 checks passed

adamcfraser deleted the CBG-5331 branch June 1, 2026 14:54

RIT3shSapata added a commit that referenced this pull request Jun 8, 2026

CBG-5331: Wire up User Channel History compaction to REST API (#8277)

26870d5

Uh oh!

Conversation

RIT3shSapata commented May 15, 2026

Pre-review checklist

Dependencies (if applicable)

Uh oh!

github-actions Bot commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Redocly previews

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adamcfraser left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RIT3shSapata commented Jun 1, 2026

Uh oh!

adamcfraser left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented May 15, 2026 •

edited

Loading