Made User Agent configurable post Cosmos client creation

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

@@ -290,6 +290,8 @@ export class ClientContext {
         diagnosticNode: DiagnosticNodeInternal;
     }): Promise<Response_2<T & Resource>>;
     // (undocumented)
+    updateHostFramework(hostFramework: string): void;
+    // (undocumented)
     upsert<T, U = T>({ body, path, resourceType, resourceId, options, partitionKey, diagnosticNode, }: {
         body: T;
         path: string;
@@ -699,21 +701,24 @@ export class CosmosClient {
     getWriteEndpoints(): Promise<readonly string[]>;
     offer(id: string): Offer;
     readonly offers: Offers;
+    updateHostFramework(hostFramework: string): Promise<void>;
 }
 
 // @public (undocumented)
 export interface CosmosClientOptions {
     aadCredentials?: TokenCredential;
     agent?: Agent;
     connectionPolicy?: ConnectionPolicy;
+    connectionString?: string;
     consistencyLevel?: keyof typeof ConsistencyLevel;
     // Warning: (ae-forgotten-export) The symbol "CosmosHeaders_2" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
     defaultHeaders?: CosmosHeaders_2;
     // (undocumented)
     diagnosticLevel?: CosmosDbDiagnosticLevel;
-    endpoint: string;
+    endpoint?: string;
+    hostFramework?: string;
     httpClient?: HttpClient;
     key?: string;
     permissionFeed?: PermissionDefinition[];

sdk/cosmosdb/cosmos/src/ClientContext.ts

@@ -38,6 +38,7 @@ import type { DiagnosticFormatter } from "./diagnostics/DiagnosticFormatter";
 import { DefaultDiagnosticFormatter } from "./diagnostics/DiagnosticFormatter";
 import { CosmosDbDiagnosticLevel } from "./diagnostics/CosmosDbDiagnosticLevel";
 import { randomUUID } from "@azure/core-util";
+import { getUserAgent } from "./common/platform";
 
 const logger: AzureLogger = createClientLogger("ClientContext");
 
@@ -978,4 +979,17 @@ export class ClientContext {
   public getClientConfig(): ClientConfigDiagnostic {
     return this.clientConfig;
   }
+
+  private refreshUserAgent(): void {
+    const updatedUserAgent = getUserAgent(
+      this.cosmosClientOptions.userAgentSuffix,
+      this.cosmosClientOptions.hostFramework,
+    );
+    this.cosmosClientOptions.defaultHeaders[Constants.HttpHeaders.UserAgent] = updatedUserAgent;
+  }
+
+  public updateHostFramework(hostFramework: string): void {
+    this.cosmosClientOptions.hostFramework = hostFramework;
+    this.refreshUserAgent();
+  }
 }

sdk/cosmosdb/cosmos/src/CosmosClient.ts

@@ -70,8 +70,14 @@ export class CosmosClient {
   constructor(optionsOrConnectionString: string | CosmosClientOptions) {
     if (typeof optionsOrConnectionString === "string") {
       optionsOrConnectionString = parseConnectionString(optionsOrConnectionString);
+    } else if (optionsOrConnectionString.connectionString) {
+      const { endpoint, key } = parseConnectionString(optionsOrConnectionString.connectionString);
+      optionsOrConnectionString.endpoint = endpoint;
+      optionsOrConnectionString.key = key;
+    }
+    if (!optionsOrConnectionString.endpoint) {
+      throw new Error("Invalid endpoint specified");
     }
-
     const endpoint = checkURL(optionsOrConnectionString.endpoint);
     if (!endpoint) {
       throw new Error("Invalid endpoint specified");
@@ -97,6 +103,7 @@ export class CosmosClient {
 
     optionsOrConnectionString.defaultHeaders[Constants.HttpHeaders.UserAgent] = getUserAgent(
       optionsOrConnectionString.userAgentSuffix,
+      optionsOrConnectionString.hostFramework,
     );
 
     const globalEndpointManager = new GlobalEndpointManager(
@@ -272,4 +279,13 @@ export class CosmosClient {
       this.endpointRefresher.unref();
     }
   }
+
+  /**
+   * Update the host framework. If provided host framework will be used to generate the defualt SDK user agent.
+   * @param hostFramework - A custom string.
+   * @hidden
+   */
+  public async updateHostFramework(hostFramework: string): Promise<void> {
+    this.clientContext.updateHostFramework(hostFramework);
+  }
 }

sdk/cosmosdb/cosmos/src/CosmosClientOptions.ts

@@ -20,7 +20,7 @@ export interface Agent {
 
 export interface CosmosClientOptions {
   /** The service endpoint to use to create the client. */
-  endpoint: string;
+  endpoint?: string;
   /** The account master or readonly key */
   key?: string;
   /** An object that contains resources tokens.
@@ -60,4 +60,8 @@ export interface CosmosClientOptions {
   diagnosticLevel?: CosmosDbDiagnosticLevel;
   /** @internal */
   plugins?: PluginConfig[];
+  /** An optional parameter that represents the connection string. Your database connection string can be found in the Azure Portal. */
+  connectionString?: string;
+  /** A custom string used to generate the default SDK user agent. */
+  hostFramework?: string;
 }

sdk/cosmosdb/cosmos/src/common/platform.ts

@@ -6,11 +6,15 @@ import { Constants } from "./constants";
 /**
  * @hidden
  */
-export function getUserAgent(suffix?: string): string {
-  const ua = `${userAgentDetails()} ${Constants.SDKName}/${Constants.SDKVersion}`;
+export function getUserAgent(suffix?: string, hostFramework?: string): string {
+  let ua = `${userAgentDetails()} ${Constants.SDKName}/${Constants.SDKVersion}`;
+  if (hostFramework) {
+    ua = ua + " " + hostFramework;
+  }
   if (suffix) {
-    return ua + " " + suffix;
+    ua = ua + " " + suffix;
   }
+
   return ua;
 }