Add support for BypassIntegratedCache option (Azure#24772)

* Add support for BypassIntegratedCache option

* Update CHANGELOG

* Fix lint and add more tests

* Update sdk/data/azcosmos/cosmos_item_request_options_test.go

Co-authored-by: Copilot <[email protected]>

---------

Co-authored-by: Copilot <[email protected]>

Author: AndrewRPorter

sdk/data/azcosmos/CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ### Features Added
 
+* Added support for BypassIntegratedCache option See [PR 24772](https://github.com/Azure/azure-sdk-for-go/pull/24772)
+
 ### Breaking Changes
 
 ### Bugs Fixed

sdk/data/azcosmos/cosmos_dedicated_gateway_request_options.go

@@ -12,4 +12,7 @@ type DedicatedGatewayRequestOptions struct {
 	// responses from the integrated cache are guaranteed to be no staler than value indicated by this MaxIntegratedCacheStaleness.
 	// Cache Staleness is supported in milliseconds granularity. Anything smaller than milliseconds will be ignored.
 	MaxIntegratedCacheStaleness *time.Duration
+
+	// When set to true, the request will not be served from the integrated cache, and the response will not be cached either.
+	BypassIntegratedCache bool
 }

sdk/data/azcosmos/cosmos_http_constants.go

@@ -83,6 +83,7 @@ const (
 	cosmosHeaderQueryExecutionInfo                 string = "x-ms-cosmos-query-execution-info"
 	headerXmsItemCount                             string = "x-ms-item-count"
 	headerDedicatedGatewayMaxAge                   string = "x-ms-dedicatedgateway-max-age"
+	headerDedicatedGatewayBypassCache              string = "x-ms-dedicatedgateway-bypass-cache"
 )
 
 const (

sdk/data/azcosmos/cosmos_item_request_options.go

@@ -73,6 +73,10 @@ func (options *ItemOptions) toHeaders() *map[string]string {
 			milliseconds := dedicatedGatewayRequestOptions.MaxIntegratedCacheStaleness.Milliseconds()
 			headers[headerDedicatedGatewayMaxAge] = strconv.FormatInt(milliseconds, 10)
 		}
+
+		if dedicatedGatewayRequestOptions.BypassIntegratedCache {
+			headers[headerDedicatedGatewayBypassCache] = "true"
+		}
 	}
 
 	return &headers

sdk/data/azcosmos/cosmos_item_request_options_test.go

@@ -25,6 +25,7 @@ func TestItemRequestOptionsToHeaders(t *testing.T) {
 	options.DedicatedGatewayRequestOptions = &DedicatedGatewayRequestOptions{
 		MaxIntegratedCacheStaleness: &maxIntegratedCacheStalenessDuration,
 	}
+	options.DedicatedGatewayRequestOptions.BypassIntegratedCache = true
 	header := options.toHeaders()
 	if header == nil {
 		t.Fatal("toHeaders should return non-nil")
@@ -52,4 +53,20 @@ func TestItemRequestOptionsToHeaders(t *testing.T) {
 	if headers[headerDedicatedGatewayMaxAge] != strconv.FormatInt(300000, 10) {
 		t.Errorf("headerDedicatedGatewayMaxAge should be 300000 but got %v", headers[headerDedicatedGatewayMaxAge])
 	}
+	if headers[headerDedicatedGatewayBypassCache] != "true" {
+		t.Errorf("headerDedicatedGatewayBypassCache should be true but got %v", headers[headerDedicatedGatewayBypassCache])
+	}
+}
+
+func TestItemRequestOptionsToHeaders_bypassIntegratedCacheNotSet(t *testing.T) {
+	options := &ItemOptions{}
+	header := options.toHeaders()
+	if header == nil {
+		t.Fatal("toHeaders should return non-nil")
+	}
+
+	headers := *header
+	if _, exists := headers[headerDedicatedGatewayBypassCache]; exists {
+		t.Errorf("headerDedicatedGatewayBypassCache should not exist when BypassIntegratedCache is not set")
+	}
 }

sdk/data/azcosmos/cosmos_query_request_options.go

@@ -84,6 +84,10 @@ func (options *QueryOptions) toHeaders() *map[string]string {
 			milliseconds := dedicatedGatewayRequestOptions.MaxIntegratedCacheStaleness.Milliseconds()
 			headers[headerDedicatedGatewayMaxAge] = strconv.FormatInt(milliseconds, 10)
 		}
+
+		if dedicatedGatewayRequestOptions.BypassIntegratedCache {
+			headers[headerDedicatedGatewayBypassCache] = "true"
+		}
 	}
 
 	headers[cosmosHeaderPopulateQueryMetrics] = "true"

sdk/data/azcosmos/cosmos_query_request_options_test.go

@@ -24,6 +24,7 @@ func TestQueryRequestOptionsToHeaders(t *testing.T) {
 	options.DedicatedGatewayRequestOptions = &DedicatedGatewayRequestOptions{
 		MaxIntegratedCacheStaleness: &maxIntegratedCacheStalenessDuration,
 	}
+	options.DedicatedGatewayRequestOptions.BypassIntegratedCache = true
 	header := options.toHeaders()
 	if header == nil {
 		t.Fatal("toHeaders should return non-nil")
@@ -57,4 +58,20 @@ func TestQueryRequestOptionsToHeaders(t *testing.T) {
 	if headers[headerDedicatedGatewayMaxAge] != strconv.FormatInt(300000, 10) {
 		t.Errorf("headerDedicatedGatewayMaxAge should be 300000 but got %v", headers[headerDedicatedGatewayMaxAge])
 	}
+	if headers[headerDedicatedGatewayBypassCache] != "true" {
+		t.Errorf("headerDedicatedGatewayBypassCache should be true but got %v", headers[headerDedicatedGatewayBypassCache])
+	}
+}
+
+func TestQueryRequestOptionsToHeaders_bypassIntegratedCacheNotSet(t *testing.T) {
+	options := &QueryOptions{}
+	header := options.toHeaders()
+	if header == nil {
+		t.Fatal("toHeaders should return non-nil")
+	}
+
+	headers := *header
+	if _, exists := headers[headerDedicatedGatewayBypassCache]; exists {
+		t.Errorf("headerDedicatedGatewayBypassCache should not exist when BypassIntegratedCache is not set")
+	}
 }