[Cosmos] Refactor endpoint discovery and failover

sdk/cosmosdb/cosmos/changelog.md

@@ -1,5 +1,6 @@
-## 3.4.3
+## 3.5.0
 
+- FEATURE: Endpoint discovery and multi-region failover improvements. See https://github.com/Azure/azure-sdk-for-js/pull/6283 for more information on this change. (#6283)
 - Makes changeFeed and query options optional. Fix #6232 Fix #6277 (#6273)
 
 ## 3.4.2

sdk/cosmosdb/cosmos/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/cosmos",
-  "version": "3.4.2",
+  "version": "3.5.0",
   "description": "Microsoft Azure Cosmos DB Service Node.js SDK for SQL API",
   "sdk-type": "client",
   "keywords": [

sdk/cosmosdb/cosmos/review/cosmos.api.md

@@ -593,6 +593,8 @@ export interface Location {
     databaseAccountEndpoint: string;
     // (undocumented)
     name: string;
+    // (undocumented)
+    unavailable?: boolean;
 }
 
 // @public
@@ -888,10 +890,6 @@ export interface RequestContext {
     globalEndpointManager: GlobalEndpointManager;
     // (undocumented)
     headers?: CosmosHeaders_2;
-    // Warning: (ae-forgotten-export) The symbol "LocationRouting" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    locationRouting?: LocationRouting;
     // Warning: (ae-forgotten-export) The symbol "HTTPMethod" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)

sdk/cosmosdb/cosmos/src/ClientContext.ts

@@ -79,7 +79,10 @@ export class ClientContext {
       this.applySessionToken(request);
 
       // read will use ReadEndpoint since it uses GET operation
-      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(request);
+      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
+        request.resourceType,
+        request.operationType
+      );
       const response = await executePlugins(request, executeRequest, PluginOn.operation);
       this.captureSessionToken(undefined, path, OperationType.Read, response.headers);
       return response;
@@ -131,7 +134,10 @@ export class ClientContext {
     if (query !== undefined) {
       request.method = HTTPMethod.post;
     }
-    request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(request);
+    request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
+      request.resourceType,
+      request.operationType
+    );
     request.headers = await this.buildHeaders(request);
     if (query !== undefined) {
       request.headers[Constants.HttpHeaders.IsQuery] = "true";
@@ -177,7 +183,10 @@ export class ClientContext {
       plugins: this.cosmosClientOptions.plugins
     };
 
-    request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(request);
+    request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
+      request.resourceType,
+      request.operationType
+    );
     request.headers = await this.buildHeaders(request);
     request.headers[Constants.HttpHeaders.IsQueryPlan] = "True";
     request.headers[Constants.HttpHeaders.QueryVersion] = "1.4";
@@ -246,7 +255,10 @@ export class ClientContext {
       request.headers = await this.buildHeaders(request);
       this.applySessionToken(request);
       // deleteResource will use WriteEndpoint since it uses DELETE operation
-      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(request);
+      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
+        request.resourceType,
+        request.operationType
+      );
       const response = await executePlugins(request, executeRequest, PluginOn.operation);
       if (parseLink(path).type !== "colls") {
         this.captureSessionToken(undefined, path, OperationType.Delete, response.headers);
@@ -296,7 +308,10 @@ export class ClientContext {
       // create will use WriteEndpoint since it uses POST operation
       this.applySessionToken(request);
 
-      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(request);
+      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
+        request.resourceType,
+        request.operationType
+      );
       const response = await executePlugins(request, executeRequest, PluginOn.operation);
       this.captureSessionToken(undefined, path, OperationType.Create, response.headers);
       return response;
@@ -381,7 +396,10 @@ export class ClientContext {
       this.applySessionToken(request);
 
       // replace will use WriteEndpoint since it uses PUT operation
-      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(request);
+      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
+        request.resourceType,
+        request.operationType
+      );
       const response = await executePlugins(request, executeRequest, PluginOn.operation);
       this.captureSessionToken(undefined, path, OperationType.Replace, response.headers);
       return response;
@@ -428,7 +446,10 @@ export class ClientContext {
       this.applySessionToken(request);
 
       // upsert will use WriteEndpoint since it uses POST operation
-      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(request);
+      request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
+        request.resourceType,
+        request.operationType
+      );
       const response = await executePlugins(request, executeRequest, PluginOn.operation);
       this.captureSessionToken(undefined, path, OperationType.Upsert, response.headers);
       return response;
@@ -475,7 +496,10 @@ export class ClientContext {
 
     request.headers = await this.buildHeaders(request);
     // executeStoredProcedure will use WriteEndpoint since it uses POST operation
-    request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(request);
+    request.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(
+      request.resourceType,
+      request.operationType
+    );
     return executePlugins(request, executeRequest, PluginOn.operation);
   }