CBG-4752: Bulk APIs for CV (read and write) (#7714)

bbrks · web-flow · commit a99df746e92c · 2025-08-29T13:04:41.000+01:00
diff --git a/channels/log_entry.go b/channels/log_entry.go
@@ -168,6 +168,9 @@ func (rv *RevAndVersion) UnmarshalJSON(data []byte) error {
 
 // CV returns ver@src in big endian format 1@cbl for CBL format.
 func (rv RevAndVersion) CV() string {
+	if rv.CurrentSource == "" || rv.CurrentVersion == "" {
+		return ""
+	}
 	// this should match db.Version.String()
 	return strconv.FormatUint(base.HexCasToUint64(rv.CurrentVersion), 16) + "@" + rv.CurrentSource
 }
diff --git a/db/database.go b/db/database.go
@@ -984,17 +984,17 @@ func (c *DatabaseCollection) processForEachDocIDResults(ctx context.Context, cal
 			found = results.Next(ctx, &viewRow)
 			if found {
 				docid = viewRow.Key
-				revid = viewRow.Value.RevID.RevTreeID
-				cv = viewRow.Value.RevID.CV()
+				revid = viewRow.Value.Rev.RevTreeID
+				cv = viewRow.Value.Rev.CV()
 				seq = viewRow.Value.Sequence
 				channels = viewRow.Value.Channels
 			}
 		} else {
 			found = results.Next(ctx, &queryRow)
 			if found {
 				docid = queryRow.Id
-				revid = queryRow.RevID.RevTreeID
-				cv = queryRow.RevID.CV()
+				revid = queryRow.Rev.RevTreeID
+				cv = queryRow.Rev.CV()
 				seq = queryRow.Sequence
 				channels = make([]string, 0)
 				// Query returns all channels, but we only want to return active channels
diff --git a/db/document.go b/db/document.go
@@ -131,6 +131,13 @@ func (sd *SyncData) GetRevTreeID() string {
 	return sd.RevAndVersion.RevTreeID
 }
 
+func (sd *SyncData) CV() string {
+	if sd == nil {
+		return ""
+	}
+	return sd.RevAndVersion.CV()
+}
+
 // determine set of current channels based on removal entries.
 func (sd *SyncData) getCurrentChannels() base.Set {
 	ch := base.SetOf()
diff --git a/db/query.go b/db/query.go
@@ -688,15 +688,15 @@ func (context *DatabaseContext) QueryAllRoles(ctx context.Context, startKey stri
 type AllDocsViewQueryRow struct {
 	Key   string
 	Value struct {
-		RevID    channels.RevAndVersion `json:"r"`
+		Rev      channels.RevAndVersion `json:"r"`
 		Sequence uint64                 `json:"s"`
 		Channels []string               `json:"c"`
 	}
 }
 
 type AllDocsIndexQueryRow struct {
 	Id       string
-	RevID    channels.RevAndVersion `json:"r"`
+	Rev      channels.RevAndVersion `json:"r"`
 	Sequence uint64                 `json:"s"`
 	Channels channels.ChannelMap    `json:"c"`
 }
diff --git a/docs/api/components/parameters.yaml b/docs/api/components/parameters.yaml
@@ -387,13 +387,6 @@ show_exp:
   schema:
     type: boolean
   description: Whether to show the expiry property (`_exp`) in the response.
-show_cv:
-  name: show_cv
-  in: query
-  required: false
-  schema:
-    type: boolean
-  description: Output the Current Version in the response as property `_cv`.
 startkey:
   name: startkey
   in: query
diff --git a/docs/api/paths/admin/keyspace-_all_docs.yaml b/docs/api/paths/admin/keyspace-_all_docs.yaml
@@ -29,7 +29,6 @@ get:
     - $ref: ../../components/parameters.yaml#/startkey
     - $ref: ../../components/parameters.yaml#/endkey
     - $ref: ../../components/parameters.yaml#/limit-result-rows
-    - $ref: ../../components/parameters.yaml#/show_cv
   responses:
     '200':
       $ref: ../../components/responses.yaml#/all-docs
diff --git a/docs/api/paths/admin/keyspace-_bulk_get.yaml b/docs/api/paths/admin/keyspace-_bulk_get.yaml
@@ -45,7 +45,6 @@ post:
       description: If this header includes `gzip` then the the HTTP response will be compressed. This takes priority over `X-Accept-Part-Encoding`. Only part compression will be done if `X-Accept-Part-Encoding=gzip` and the `User-Agent` is below 1.2 due to clients not being able to handle full compression.
       schema:
         type: string
-    - $ref: ../../components/parameters.yaml#/show_cv
   requestBody:
     content:
       application/json:
diff --git a/docs/api/paths/public/keyspace-_all_docs.yaml b/docs/api/paths/public/keyspace-_all_docs.yaml
@@ -24,7 +24,6 @@ get:
     - $ref: ../../components/parameters.yaml#/startkey
     - $ref: ../../components/parameters.yaml#/endkey
     - $ref: ../../components/parameters.yaml#/limit-result-rows
-    - $ref: ../../components/parameters.yaml#/show_cv
   responses:
     '200':
       $ref: ../../components/responses.yaml#/all-docs
diff --git a/docs/api/paths/public/keyspace-_bulk_get.yaml b/docs/api/paths/public/keyspace-_bulk_get.yaml
@@ -40,7 +40,6 @@ post:
       description: If this header includes `gzip` then the the HTTP response will be compressed. This takes priority over `X-Accept-Part-Encoding`. Only part compression will be done if `X-Accept-Part-Encoding=gzip` and the `User-Agent` is below 1.2 due to clients not being able to handle full compression.
       schema:
         type: string
-    - $ref: ../../components/parameters.yaml#/show_cv
   requestBody:
     content:
       application/json:
diff --git a/rest/access_test.go b/rest/access_test.go
@@ -496,11 +496,20 @@ func TestForceAPIForbiddenErrors(t *testing.T) {
 		})
 	}
 }
-func TestBulkDocsChangeToAccess(t *testing.T) {
 
+// TestBulkDocsChangeToAccess verifies that access() grants from one doc in a single bulk_docs request apply to subsequent docs in the same batch.
+func TestBulkDocsChangeToAccess(t *testing.T) {
 	base.SetUpTestLogging(t, base.LevelInfo, base.KeyAccess)
 
-	rtConfig := RestTesterConfig{SyncFn: `function(doc) {if(doc.type == "setaccess") {channel(doc.channel); access(doc.owner, doc.channel);} else { requireAccess(doc.channel)}}`}
+	rtConfig := RestTesterConfig{SyncFn: `
+		function(doc) {
+			if(doc.type == "setaccess") {
+				channel(doc.channel);
+				access(doc.owner, doc.channel);
+			} else {
+				requireAccess(doc.channel);
+			}
+		}`}
 	rt := NewRestTesterDefaultCollection(t, &rtConfig)
 	defer rt.Close()
 
@@ -518,17 +527,18 @@ func TestBulkDocsChangeToAccess(t *testing.T) {
 	assert.NoError(t, a.Save(user))
 
 	input := `{"docs": [{"_id": "bulk1", "type" : "setaccess", "owner":"user1" , "channel":"chan1"}, {"_id": "bulk2" , "channel":"chan1"}]}`
-
 	response := rt.SendUserRequest("POST", "/db/_bulk_docs", input, "user1")
 	RequireStatus(t, response, 201)
 
 	var docs []interface{}
 	require.NoError(t, base.JSONUnmarshal(response.Body.Bytes(), &docs))
-	assert.Len(t, docs, 2)
-	assert.Equal(t, map[string]interface{}{"rev": "1-afbcffa8a4641a0f4dd94d3fc9593e74", "id": "bulk1"}, docs[0])
-
-	assert.Equal(t, map[string]interface{}{"rev": "1-4d79588b9fe9c38faae61f0c1b9471c0", "id": "bulk2"}, docs[1])
-
+	require.Len(t, docs, 2)
+	assert.NotContains(t, response.BodyString(), `missing channel access`)
+	assert.NotContains(t, response.BodyString(), `"status":403"`)
+	assert.Contains(t, response.BodyString(), `"id":"bulk1"`)
+	assert.Contains(t, response.BodyString(), `"rev":"1-afbcffa8a4641a0f4dd94d3fc9593e74"`)
+	assert.Contains(t, response.BodyString(), `"id":"bulk2"`)
+	assert.Contains(t, response.BodyString(), `"rev":"1-4d79588b9fe9c38faae61f0c1b9471c0"`)
 }
 
 // Test _all_docs API call under different security scenarios
@@ -1154,15 +1164,6 @@ func TestAllDocsCV(t *testing.T) {
 		{
 			name: "no query string",
 			url:  "/{{.keyspace}}/_all_docs",
-			output: fmt.Sprintf(`{
-				"total_rows": 1,
-				"update_seq": 1,
-				"rows": [{"key": "%s", "id": "%s", "value": {"rev": "%s"}}]
-			}`, docID, docID, docVersion.RevTreeID),
-		},
-		{
-			name: "cvs=true",
-			url:  "/{{.keyspace}}/_all_docs?show_cv=true",
 			output: fmt.Sprintf(`{
 				"total_rows": 1,
 				"update_seq": 1,
diff --git a/rest/adminapitest/admin_api_test.go b/rest/adminapitest/admin_api_test.go
@@ -2229,8 +2229,15 @@ func TestHandleGetRevTree(t *testing.T) {
 
 	resp := rt.SendAdminRequest(http.MethodPost, "/{{.keyspace}}/_bulk_docs", reqBodyJson)
 	rest.RequireStatus(t, resp, http.StatusCreated)
-	respBodyExpected := `[{"id":"foo","rev":"1-123"},{"id":"foo","rev":"1-456"},{"id":"foo","rev":"1-789"}]`
-	assert.Equal(t, respBodyExpected, resp.Body.String())
+	// Response now includes unpredictable CV values - just validate ids and revs...
+	// It's likely this test will be removed in 4.0, or shortly after, since we're never allowing new conflicts to be created
+	var bulkDocsResp []map[string]interface{}
+	require.NoError(t, json.Unmarshal(resp.BodyBytes(), &bulkDocsResp))
+	require.Len(t, bulkDocsResp, 3)
+	for _, d := range bulkDocsResp {
+		assert.Equal(t, "foo", d["id"])
+		assert.Truef(t, strings.HasPrefix(d["rev"].(string), "1-"), "expected rev to start with '1-', got %s", d["rev"])
+	}
 
 	// Get the revision tree  of the user foo
 	resp = rt.SendAdminRequest(http.MethodGet, "/{{.keyspace}}/_revtree/foo", "")
diff --git a/rest/api_test.go b/rest/api_test.go
diff --git a/rest/bulk_api.go b/rest/bulk_api.go
diff --git a/rest/doc_api_test.go b/rest/doc_api_test.go
diff --git a/rest/role_api_test.go b/rest/role_api_test.go
diff --git a/rest/utilities_testing_resttester.go b/rest/utilities_testing_resttester.go

Original file line number	Diff line number	Diff line change
`@@ -168,6 +168,9 @@ func (rv *RevAndVersion) UnmarshalJSON(data []byte) error {`
`168`	`168`
`169`	`169`	`// CV returns ver@src in big endian format 1@cbl for CBL format.`
`170`	`170`	`func (rv RevAndVersion) CV() string {`
	`171`	`+ if rv.CurrentSource == "" \|\| rv.CurrentVersion == "" {`
	`172`	`+ return ""`
	`173`	`+ }`
`171`	`174`	`// this should match db.Version.String()`
`172`	`175`	`return strconv.FormatUint(base.HexCasToUint64(rv.CurrentVersion), 16) + "@" + rv.CurrentSource`
`173`	`176`	`}`
Original file line number	Diff line number	Diff line change
`@@ -688,15 +688,15 @@ func (context *DatabaseContext) QueryAllRoles(ctx context.Context, startKey stri`
`688`	`688`	`type AllDocsViewQueryRow struct {`
`689`	`689`	`Key string`
`690`	`690`	`Value struct {`
`691`		- RevID channels.RevAndVersion `json:"r"`
	`691`	+ Rev channels.RevAndVersion `json:"r"`
`692`	`692`	Sequence uint64 `json:"s"`
`693`	`693`	Channels []string `json:"c"`
`694`	`694`	`}`
`695`	`695`	`}`
`696`	`696`
`697`	`697`	`type AllDocsIndexQueryRow struct {`
`698`	`698`	`Id string`
`699`		- RevID channels.RevAndVersion `json:"r"`
	`699`	+ Rev channels.RevAndVersion `json:"r"`
`700`	`700`	Sequence uint64 `json:"s"`
`701`	`701`	Channels channels.ChannelMap `json:"c"`
`702`	`702`	`}`