Minor Fix for @azure/cosmos4.6.0 (#35968)

ujjwalsoni1707 · ajnovice · web-flow · commit 1313c7cb5d31 · 2025-09-30T17:34:35.000+05:30
### Packages impacted by this PR @azure/cosmos ### Issues associated with this PR ### Describe the problem that is addressed by this PR ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary) --------- Co-authored-by: ajnovice <ajaysimple91@gmail.com> Co-authored-by: Ajay Singh <ajaysing@microsoft.com>
diff --git a/sdk/cosmosdb/cosmos/CHANGELOG.md b/sdk/cosmosdb/cosmos/CHANGELOG.md
@@ -1,5 +1,5 @@
 # Release History
-## 4.6.0 (2025-09-15)
+## 4.6.0 (2025-10-01)
 
 ### Features Added
 
@@ -17,6 +17,7 @@ await container.item("1").delete(requestOptions);
 ### Bugs Fixed
 - [#35875](https://github.com/Azure/azure-sdk-for-js/issues/35875) Fixed the per-operation partition key format in the batch API to match the API-level partition key,
  preventing partitionKeyMismatch error when an optional partition key value is provided in the operationInput
+- [#35967](https://github.com/Azure/azure-sdk-for-js/issues/35967) Changed the default values of `enablePartitionLevelFailover` and `enablePartitionLevelCircuitBreaker` flags to `true` in the connection policy.
 
 ## 4.5.1 (2025-09-01)
 
diff --git a/sdk/cosmosdb/cosmos/review/cosmos-node.api.md b/sdk/cosmosdb/cosmos/review/cosmos-node.api.md
@@ -929,7 +929,7 @@ export class DatabaseAccount {
     readonly databasesLink: string;
     // (undocumented)
     readonly enableMultipleWritableLocations: boolean;
-    readonly enablePerPartitionFailoverBehavior: boolean;
+    readonly enablePerPartitionFailover: boolean;
     // @deprecated
     get MaxMediaStorageUsageInMB(): number;
     readonly maxMediaStorageUsageInMB: number;
@@ -1326,7 +1326,7 @@ export class GlobalEndpointManager {
     preferredLocationsCount: number;
     refreshEndpointList(diagnosticNode: DiagnosticNodeInternal): Promise<void>;
     // (undocumented)
-    resolveServiceEndpoint(diagnosticNode: DiagnosticNodeInternal, resourceType: ResourceType, operationType: OperationType, startServiceEndpointIndex?: number, options?: SharedOptions | ChangeFeedIteratorOptions): Promise<string>;
+    resolveServiceEndpoint(diagnosticNode: DiagnosticNodeInternal, resourceType: ResourceType, operationType: OperationType, startServiceEndpointIndex?: number): Promise<string>;
 }
 
 // @public (undocumented)
diff --git a/sdk/cosmosdb/cosmos/src/ClientContext.ts b/sdk/cosmosdb/cosmos/src/ClientContext.ts
@@ -148,13 +148,13 @@ export class ClientContext {
       this.applySessionToken(request);
 
       // read will use ReadEndpoint since it uses GET operation
-      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
-        diagnosticNode,
-        request.resourceType,
-        request.operationType,
-        0,
-        options,
-      );
+      request.endpoint = await this.globalEndpointManager.resolveServiceEndpointInternal({
+        diagnosticNode: diagnosticNode,
+        resourceType: request.resourceType,
+        operationType: request.operationType,
+        startServiceEndpointIndex: 0,
+        excludedLocations: options?.excludedLocations,
+      });
       const response = await executePlugins(
         diagnosticNode,
         request,
@@ -219,13 +219,13 @@ export class ClientContext {
     if (query !== undefined) {
       request.method = HTTPMethod.post;
     }
-    request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
-      diagnosticNode,
-      request.resourceType,
-      request.operationType,
-      0,
-      options,
-    );
+    request.endpoint = await this.globalEndpointManager.resolveServiceEndpointInternal({
+      diagnosticNode: diagnosticNode,
+      resourceType: request.resourceType,
+      operationType: request.operationType,
+      startServiceEndpointIndex: 0,
+      excludedLocations: options?.excludedLocations,
+    });
     request.headers = await this.buildHeaders(request);
 
     if (startEpk !== undefined && endEpk !== undefined) {
@@ -282,13 +282,13 @@ export class ClientContext {
       operationType: OperationType.Read,
       resourceType,
     });
-    request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
-      diagnosticNode,
-      request.resourceType,
-      request.operationType,
-      0,
-      options,
-    );
+    request.endpoint = await this.globalEndpointManager.resolveServiceEndpointInternal({
+      diagnosticNode: diagnosticNode,
+      resourceType: request.resourceType,
+      operationType: request.operationType,
+      startServiceEndpointIndex: 0,
+      excludedLocations: options?.excludedLocations,
+    });
     request.headers = await this.buildHeaders(request);
     if (correlatedActivityId !== undefined) {
       request.headers[HttpHeaders.CorrelatedActivityId] = correlatedActivityId;
@@ -368,13 +368,13 @@ export class ClientContext {
       request.partitionKeyRangeId = partitionKeyRangeId;
       this.applySessionToken(request);
       // deleteResource will use WriteEndpoint since it uses DELETE operation
-      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
-        diagnosticNode,
-        request.resourceType,
-        request.operationType,
-        0,
-        options,
-      );
+      request.endpoint = await this.globalEndpointManager.resolveServiceEndpointInternal({
+        diagnosticNode: diagnosticNode,
+        resourceType: request.resourceType,
+        operationType: request.operationType,
+        startServiceEndpointIndex: 0,
+        excludedLocations: options?.excludedLocations,
+      });
       const response = await executePlugins(
         diagnosticNode,
         request,
@@ -433,13 +433,13 @@ export class ClientContext {
       this.applySessionToken(request);
 
       // patch will use WriteEndpoint
-      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
-        diagnosticNode,
-        request.resourceType,
-        request.operationType,
-        0,
-        options,
-      );
+      request.endpoint = await this.globalEndpointManager.resolveServiceEndpointInternal({
+        diagnosticNode: diagnosticNode,
+        resourceType: request.resourceType,
+        operationType: request.operationType,
+        startServiceEndpointIndex: 0,
+        excludedLocations: options?.excludedLocations,
+      });
       const response = await executePlugins(
         diagnosticNode,
         request,
@@ -494,13 +494,13 @@ export class ClientContext {
       // create will use WriteEndpoint since it uses POST operation
       this.applySessionToken(request);
 
-      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
-        diagnosticNode,
-        request.resourceType,
-        request.operationType,
-        0,
-        options,
-      );
+      request.endpoint = await this.globalEndpointManager.resolveServiceEndpointInternal({
+        diagnosticNode: diagnosticNode,
+        resourceType: request.resourceType,
+        operationType: request.operationType,
+        startServiceEndpointIndex: 0,
+        excludedLocations: options?.excludedLocations,
+      });
       const response = await executePlugins(
         diagnosticNode,
         request,
@@ -602,13 +602,13 @@ export class ClientContext {
       this.applySessionToken(request);
 
       // replace will use WriteEndpoint since it uses PUT operation
-      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
-        diagnosticNode,
-        request.resourceType,
-        request.operationType,
-        0,
-        options,
-      );
+      request.endpoint = await this.globalEndpointManager.resolveServiceEndpointInternal({
+        diagnosticNode: diagnosticNode,
+        resourceType: request.resourceType,
+        operationType: request.operationType,
+        startServiceEndpointIndex: 0,
+        excludedLocations: options?.excludedLocations,
+      });
       const response = await executePlugins(
         diagnosticNode,
         request,
@@ -664,13 +664,13 @@ export class ClientContext {
       this.applySessionToken(request);
 
       // upsert will use WriteEndpoint since it uses POST operation
-      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
-        diagnosticNode,
-        request.resourceType,
-        request.operationType,
-        0,
-        options,
-      );
+      request.endpoint = await this.globalEndpointManager.resolveServiceEndpointInternal({
+        diagnosticNode: diagnosticNode,
+        resourceType: request.resourceType,
+        operationType: request.operationType,
+        startServiceEndpointIndex: 0,
+        excludedLocations: options?.excludedLocations,
+      });
       const response = await executePlugins(
         diagnosticNode,
         request,
@@ -726,13 +726,13 @@ export class ClientContext {
     request.headers = await this.buildHeaders(request);
     request.partitionKeyRangeId = partitionKeyRangeId;
     // executeStoredProcedure will use WriteEndpoint since it uses POST operation
-    request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
-      diagnosticNode,
-      request.resourceType,
-      request.operationType,
-      0,
-      options,
-    );
+    request.endpoint = await this.globalEndpointManager.resolveServiceEndpointInternal({
+      diagnosticNode: diagnosticNode,
+      resourceType: request.resourceType,
+      operationType: request.operationType,
+      startServiceEndpointIndex: 0,
+      excludedLocations: options?.excludedLocations,
+    });
     const response = await executePlugins(
       diagnosticNode,
       request,
@@ -840,13 +840,13 @@ export class ClientContext {
 
       this.applySessionToken(request);
 
-      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
-        diagnosticNode,
-        request.resourceType,
-        request.operationType,
-        0,
-        options,
-      );
+      request.endpoint = await this.globalEndpointManager.resolveServiceEndpointInternal({
+        diagnosticNode: diagnosticNode,
+        resourceType: request.resourceType,
+        operationType: request.operationType,
+        startServiceEndpointIndex: 0,
+        excludedLocations: options?.excludedLocations,
+      });
       const response = await executePlugins(
         diagnosticNode,
         request,
@@ -902,13 +902,13 @@ export class ClientContext {
       request.headers[HttpHeaders.BatchContinueOnError] = bulkOptions.continueOnError ?? true;
       this.applySessionToken(request);
 
-      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
-        diagnosticNode,
-        request.resourceType,
-        request.operationType,
-        0,
-        options,
-      );
+      request.endpoint = await this.globalEndpointManager.resolveServiceEndpointInternal({
+        diagnosticNode: diagnosticNode,
+        resourceType: request.resourceType,
+        operationType: request.operationType,
+        startServiceEndpointIndex: 0,
+        excludedLocations: options?.excludedLocations,
+      });
       const response = await executePlugins(
         diagnosticNode,
         request,
diff --git a/sdk/cosmosdb/cosmos/src/GlobalEndpointManagerOptions.ts b/sdk/cosmosdb/cosmos/src/GlobalEndpointManagerOptions.ts
@@ -0,0 +1,22 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import type { ResourceType, OperationType } from "./common/index.js";
+import type { DiagnosticNodeInternal } from "./diagnostics/DiagnosticNodeInternal.js";
+
+/**
+ * @internal
+ */
+export interface ResolveServiceEndpointOptions {
+  diagnosticNode: DiagnosticNodeInternal;
+  resourceType: ResourceType;
+  operationType: OperationType;
+  /**
+   * This is to indicate the starting index for selecting servers.
+   */
+  startServiceEndpointIndex: number;
+  /**
+   * Excludes one or more Azure regions for the operation.
+   * <p>This option is only applied when enableEndPointDiscovery is set to true.</p>
+   */
+  excludedLocations?: string[];
+}
diff --git a/sdk/cosmosdb/cosmos/src/documents/ConnectionPolicy.ts b/sdk/cosmosdb/cosmos/src/documents/ConnectionPolicy.ts
@@ -30,11 +30,11 @@ export interface ConnectionPolicy {
   /** Flag to enable/disable background refreshing of endpoints. Defaults to true.
    * Endpoint discovery using `enableEndpointsDiscovery` will still work for failed requests. */
   enableBackgroundEndpointRefreshing?: boolean;
-  /** Flag to enable/disable the Per Partition Level Failover (PPAF). Defaults to false
-   * If enablePartitionLevelFailover is set to true, by default enablePartitionLevelCircuitBreaker
-   * will also be set to true. This is done to improve the read availability and latency.*/
+  /** Flag to enable/disable the Per Partition Level Failover (PPAF).
+   * Defaults to true. When enablePartitionLevelFailover set to true, enablePartitionLevelCircuitBreaker will also be set to true.
+   * */
   enablePartitionLevelFailover?: boolean;
-  /** Flag to enable/disable the Per Partition Level Circuit Breaker (PPCB). Defaults to false */
+  /** Flag to enable/disable the Per Partition Level Circuit Breaker (PPCB). Defaults to true */
   enablePartitionLevelCircuitBreaker?: boolean;
 }
 
diff --git a/sdk/cosmosdb/cosmos/src/documents/DatabaseAccount.ts b/sdk/cosmosdb/cosmos/src/documents/DatabaseAccount.ts
@@ -70,7 +70,7 @@ export class DatabaseAccount {
   /**
    * Indicates whether per-partition failover behavior is enabled for the database account.
    */
-  public readonly enablePerPartitionFailoverBehavior: boolean = false;
+  public readonly enablePerPartitionFailover: boolean = false;
 
   // TODO: body - any
   public constructor(body: { [key: string]: any }, headers: CosmosHeaders) {
@@ -95,7 +95,7 @@ export class DatabaseAccount {
       this.enableMultipleWritableLocations = false;
     }
     if (body[Constants.ENABLE_PER_PARTITION_FAILOVER_BEHAVIOR]) {
-      this.enablePerPartitionFailoverBehavior =
+      this.enablePerPartitionFailover =
         body[Constants.ENABLE_PER_PARTITION_FAILOVER_BEHAVIOR] === true ||
         body[Constants.ENABLE_PER_PARTITION_FAILOVER_BEHAVIOR] === "true";
     }
diff --git a/sdk/cosmosdb/cosmos/src/globalEndpointManager.ts b/sdk/cosmosdb/cosmos/src/globalEndpointManager.ts
diff --git a/sdk/cosmosdb/cosmos/src/retry/retryUtility.ts b/sdk/cosmosdb/cosmos/src/retry/retryUtility.ts
diff --git a/sdk/cosmosdb/cosmos/test/public/functional/databaseaccount.spec.ts b/sdk/cosmosdb/cosmos/test/public/functional/databaseaccount.spec.ts
