feat: standardize user agent value (#1775)

* fix: update default useragent string to comply metrics requirements * feat(util-user-agent-node): update node user agent provider to the latest * feat(types): add user agent type * feat(types): add useragent to handler exec context * feat(util-user-agent-node): update node user agent provider to the latest design * feat(util-user-agent-node): support app id and add unit tests * feat(util-user-agent-browser): detect browser UA in new format * feat(util-user-agent-browser): support react native user agent * feat(middleware-user-agent): combine ua from context, default, and config into new sdk ua header * feat(middleware-user-agent): add injectUserAgent plugin * feat(middleware-user-agent): add retry mode metrics * feat(util-user-agent-*): support non-AWS clients * chore(codegen): consolidate user-agent customization to a codegen plugin * fix(middleware-user-agent): remove injectUAPlugin because it's not used for now * fix(util-user-agent-*): not to update version to 3.x.x * feat(middleware-user-agent): lowercase service ids * feat: rename defaultUserAgent config to defaultUserAgentProvider * feat(client-*): update user-agent population and injecting
aws · Dec 19, 2020 · 388b180 · 388b180
1 parent 0011af2
commit 388b180
Show file tree

Hide file tree

Showing 1,035 changed files with 6,356 additions and 4,411 deletions.
diff --git a/clients/client-accessanalyzer/AccessAnalyzerClient.ts b/clients/client-accessanalyzer/AccessAnalyzerClient.ts
@@ -62,6 +62,7 @@ import {
   SmithyResolvedConfiguration as __SmithyResolvedConfiguration,
 } from "@aws-sdk/smithy-client";
 import {
+  Provider,
   RegionInfoProvider,
   Credentials as __Credentials,
   Decoder as __Decoder,
@@ -72,6 +73,7 @@ import {
   Provider as __Provider,
   StreamCollector as __StreamCollector,
   UrlParser as __UrlParser,
+  UserAgent as __UserAgent,
 } from "@aws-sdk/types";
 
 export type ServiceInputTypes =
@@ -161,11 +163,6 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
    */
   utf8Encoder?: __Encoder;
 
-  /**
-   * The string that will be used to populate default value in 'User-Agent' header
-   */
-  defaultUserAgent?: string;
-
   /**
    * The runtime environment
    */
@@ -207,6 +204,12 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
    * Fetch related hostname, signing name or signing region with given region.
    */
   regionInfoProvider?: RegionInfoProvider;
+
+  /**
+   * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
+   * @internal
+   */
+  defaultUserAgentProvider?: Provider<__UserAgent>;
 }
 
 export type AccessAnalyzerClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
@@ -215,17 +218,17 @@ export type AccessAnalyzerClientConfig = Partial<__SmithyConfiguration<__HttpHan
   EndpointsInputConfig &
   AwsAuthInputConfig &
   RetryInputConfig &
-  UserAgentInputConfig &
-  HostHeaderInputConfig;
+  HostHeaderInputConfig &
+  UserAgentInputConfig;
 
 export type AccessAnalyzerClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
   Required<ClientDefaults> &
   RegionResolvedConfig &
   EndpointsResolvedConfig &
   AwsAuthResolvedConfig &
   RetryResolvedConfig &
-  UserAgentResolvedConfig &
-  HostHeaderResolvedConfig;
+  HostHeaderResolvedConfig &
+  UserAgentResolvedConfig;
 
 /**
  * <p>AWS IAM Access Analyzer helps identify potential resource-access risks by enabling you to identify
@@ -253,16 +256,16 @@ export class AccessAnalyzerClient extends __Client<
     let _config_2 = resolveEndpointsConfig(_config_1);
     let _config_3 = resolveAwsAuthConfig(_config_2);
     let _config_4 = resolveRetryConfig(_config_3);
-    let _config_5 = resolveUserAgentConfig(_config_4);
-    let _config_6 = resolveHostHeaderConfig(_config_5);
+    let _config_5 = resolveHostHeaderConfig(_config_4);
+    let _config_6 = resolveUserAgentConfig(_config_5);
     super(_config_6);
     this.config = _config_6;
     this.middlewareStack.use(getAwsAuthPlugin(this.config));
     this.middlewareStack.use(getRetryPlugin(this.config));
-    this.middlewareStack.use(getUserAgentPlugin(this.config));
     this.middlewareStack.use(getContentLengthPlugin(this.config));
     this.middlewareStack.use(getHostHeaderPlugin(this.config));
     this.middlewareStack.use(getLoggerPlugin(this.config));
+    this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
   destroy(): void {

diff --git a/clients/client-accessanalyzer/runtimeConfig.browser.ts b/clients/client-accessanalyzer/runtimeConfig.browser.ts
@@ -22,7 +22,10 @@ export const ClientDefaultValues: Required<ClientDefaults> = {
   base64Encoder: toBase64,
   bodyLengthChecker: calculateBodyLength,
   credentialDefaultProvider: invalidAsyncFunction("Credentialis missing") as any,
-  defaultUserAgent: defaultUserAgent(packageInfo.name, packageInfo.version),
+  defaultUserAgentProvider: defaultUserAgent({
+    serviceId: ClientSharedValues.serviceId,
+    clientVersion: packageInfo.version,
+  }),
   maxAttempts: DEFAULT_MAX_ATTEMPTS,
   region: invalidAsyncFunction("Region is missing") as any,
   requestHandler: new FetchHttpHandler(),

diff --git a/clients/client-accessanalyzer/runtimeConfig.native.ts b/clients/client-accessanalyzer/runtimeConfig.native.ts
@@ -1,5 +1,3 @@
-import packageInfo from "./package.json";
-
 import { Sha256 } from "@aws-crypto/sha256-js";
 import { parseUrl } from "@aws-sdk/url-parser-node";
 import { ClientDefaults } from "./AccessAnalyzerClient";
@@ -11,7 +9,6 @@ import { ClientDefaultValues as BrowserDefaults } from "./runtimeConfig.browser"
 export const ClientDefaultValues: Required<ClientDefaults> = {
   ...BrowserDefaults,
   runtime: "react-native",
-  defaultUserAgent: `aws-sdk-js-v3-react-native-${packageInfo.name}/${packageInfo.version}`,
   sha256: Sha256,
   urlParser: parseUrl,
 };
diff --git a/clients/client-accessanalyzer/runtimeConfig.ts b/clients/client-accessanalyzer/runtimeConfig.ts
@@ -24,7 +24,10 @@ export const ClientDefaultValues: Required<ClientDefaults> = {
   base64Encoder: toBase64,
   bodyLengthChecker: calculateBodyLength,
   credentialDefaultProvider,
-  defaultUserAgent: defaultUserAgent(packageInfo.name, packageInfo.version),
+  defaultUserAgentProvider: defaultUserAgent({
+    serviceId: ClientSharedValues.serviceId,
+    clientVersion: packageInfo.version,
+  }),
   maxAttempts: loadNodeConfig(NODE_MAX_ATTEMPT_CONFIG_OPTIONS),
   region: loadNodeConfig(NODE_REGION_CONFIG_OPTIONS, NODE_REGION_CONFIG_FILE_OPTIONS),
   requestHandler: new NodeHttpHandler(),

diff --git a/clients/client-acm-pca/ACMPCAClient.ts b/clients/client-acm-pca/ACMPCAClient.ts
@@ -97,6 +97,7 @@ import {
   SmithyResolvedConfiguration as __SmithyResolvedConfiguration,
 } from "@aws-sdk/smithy-client";
 import {
+  Provider,
   RegionInfoProvider,
   Credentials as __Credentials,
   Decoder as __Decoder,
@@ -107,6 +108,7 @@ import {
   Provider as __Provider,
   StreamCollector as __StreamCollector,
   UrlParser as __UrlParser,
+  UserAgent as __UserAgent,
 } from "@aws-sdk/types";
 
 export type ServiceInputTypes =
@@ -206,11 +208,6 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
    */
   utf8Encoder?: __Encoder;
 
-  /**
-   * The string that will be used to populate default value in 'User-Agent' header
-   */
-  defaultUserAgent?: string;
-
   /**
    * The runtime environment
    */
@@ -252,6 +249,12 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
    * Fetch related hostname, signing name or signing region with given region.
    */
   regionInfoProvider?: RegionInfoProvider;
+
+  /**
+   * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
+   * @internal
+   */
+  defaultUserAgentProvider?: Provider<__UserAgent>;
 }
 
 export type ACMPCAClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
@@ -260,17 +263,17 @@ export type ACMPCAClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOpti
   EndpointsInputConfig &
   AwsAuthInputConfig &
   RetryInputConfig &
-  UserAgentInputConfig &
-  HostHeaderInputConfig;
+  HostHeaderInputConfig &
+  UserAgentInputConfig;
 
 export type ACMPCAClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
   Required<ClientDefaults> &
   RegionResolvedConfig &
   EndpointsResolvedConfig &
   AwsAuthResolvedConfig &
   RetryResolvedConfig &
-  UserAgentResolvedConfig &
-  HostHeaderResolvedConfig;
+  HostHeaderResolvedConfig &
+  UserAgentResolvedConfig;
 
 /**
  * <note>
@@ -307,16 +310,16 @@ export class ACMPCAClient extends __Client<
     let _config_2 = resolveEndpointsConfig(_config_1);
     let _config_3 = resolveAwsAuthConfig(_config_2);
     let _config_4 = resolveRetryConfig(_config_3);
-    let _config_5 = resolveUserAgentConfig(_config_4);
-    let _config_6 = resolveHostHeaderConfig(_config_5);
+    let _config_5 = resolveHostHeaderConfig(_config_4);
+    let _config_6 = resolveUserAgentConfig(_config_5);
     super(_config_6);
     this.config = _config_6;
     this.middlewareStack.use(getAwsAuthPlugin(this.config));
     this.middlewareStack.use(getRetryPlugin(this.config));
-    this.middlewareStack.use(getUserAgentPlugin(this.config));
     this.middlewareStack.use(getContentLengthPlugin(this.config));
     this.middlewareStack.use(getHostHeaderPlugin(this.config));
     this.middlewareStack.use(getLoggerPlugin(this.config));
+    this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
   destroy(): void {

diff --git a/clients/client-acm-pca/runtimeConfig.browser.ts b/clients/client-acm-pca/runtimeConfig.browser.ts
@@ -22,7 +22,10 @@ export const ClientDefaultValues: Required<ClientDefaults> = {
   base64Encoder: toBase64,
   bodyLengthChecker: calculateBodyLength,
   credentialDefaultProvider: invalidAsyncFunction("Credentialis missing") as any,
-  defaultUserAgent: defaultUserAgent(packageInfo.name, packageInfo.version),
+  defaultUserAgentProvider: defaultUserAgent({
+    serviceId: ClientSharedValues.serviceId,
+    clientVersion: packageInfo.version,
+  }),
   maxAttempts: DEFAULT_MAX_ATTEMPTS,
   region: invalidAsyncFunction("Region is missing") as any,
   requestHandler: new FetchHttpHandler(),

diff --git a/clients/client-acm-pca/runtimeConfig.native.ts b/clients/client-acm-pca/runtimeConfig.native.ts
@@ -1,5 +1,3 @@
-import packageInfo from "./package.json";
-
 import { Sha256 } from "@aws-crypto/sha256-js";
 import { parseUrl } from "@aws-sdk/url-parser-node";
 import { ClientDefaults } from "./ACMPCAClient";
@@ -11,7 +9,6 @@ import { ClientDefaultValues as BrowserDefaults } from "./runtimeConfig.browser"
 export const ClientDefaultValues: Required<ClientDefaults> = {
   ...BrowserDefaults,
   runtime: "react-native",
-  defaultUserAgent: `aws-sdk-js-v3-react-native-${packageInfo.name}/${packageInfo.version}`,
   sha256: Sha256,
   urlParser: parseUrl,
 };
diff --git a/clients/client-acm-pca/runtimeConfig.ts b/clients/client-acm-pca/runtimeConfig.ts
@@ -24,7 +24,10 @@ export const ClientDefaultValues: Required<ClientDefaults> = {
   base64Encoder: toBase64,
   bodyLengthChecker: calculateBodyLength,
   credentialDefaultProvider,
-  defaultUserAgent: defaultUserAgent(packageInfo.name, packageInfo.version),
+  defaultUserAgentProvider: defaultUserAgent({
+    serviceId: ClientSharedValues.serviceId,
+    clientVersion: packageInfo.version,
+  }),
   maxAttempts: loadNodeConfig(NODE_MAX_ATTEMPT_CONFIG_OPTIONS),
   region: loadNodeConfig(NODE_REGION_CONFIG_OPTIONS, NODE_REGION_CONFIG_FILE_OPTIONS),
   requestHandler: new NodeHttpHandler(),

diff --git a/clients/client-acm/ACMClient.ts b/clients/client-acm/ACMClient.ts
@@ -66,6 +66,7 @@ import {
   SmithyResolvedConfiguration as __SmithyResolvedConfiguration,
 } from "@aws-sdk/smithy-client";
 import {
+  Provider,
   RegionInfoProvider,
   Credentials as __Credentials,
   Decoder as __Decoder,
@@ -76,6 +77,7 @@ import {
   Provider as __Provider,
   StreamCollector as __StreamCollector,
   UrlParser as __UrlParser,
+  UserAgent as __UserAgent,
 } from "@aws-sdk/types";
 
 export type ServiceInputTypes =
@@ -155,11 +157,6 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
    */
   utf8Encoder?: __Encoder;
 
-  /**
-   * The string that will be used to populate default value in 'User-Agent' header
-   */
-  defaultUserAgent?: string;
-
   /**
    * The runtime environment
    */
@@ -201,6 +198,12 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
    * Fetch related hostname, signing name or signing region with given region.
    */
   regionInfoProvider?: RegionInfoProvider;
+
+  /**
+   * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
+   * @internal
+   */
+  defaultUserAgentProvider?: Provider<__UserAgent>;
 }
 
 export type ACMClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
@@ -209,17 +212,17 @@ export type ACMClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions
   EndpointsInputConfig &
   AwsAuthInputConfig &
   RetryInputConfig &
-  UserAgentInputConfig &
-  HostHeaderInputConfig;
+  HostHeaderInputConfig &
+  UserAgentInputConfig;
 
 export type ACMClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
   Required<ClientDefaults> &
   RegionResolvedConfig &
   EndpointsResolvedConfig &
   AwsAuthResolvedConfig &
   RetryResolvedConfig &
-  UserAgentResolvedConfig &
-  HostHeaderResolvedConfig;
+  HostHeaderResolvedConfig &
+  UserAgentResolvedConfig;
 
 /**
  * <fullname>AWS Certificate Manager</fullname>
@@ -246,16 +249,16 @@ export class ACMClient extends __Client<
     let _config_2 = resolveEndpointsConfig(_config_1);
     let _config_3 = resolveAwsAuthConfig(_config_2);
     let _config_4 = resolveRetryConfig(_config_3);
-    let _config_5 = resolveUserAgentConfig(_config_4);
-    let _config_6 = resolveHostHeaderConfig(_config_5);
+    let _config_5 = resolveHostHeaderConfig(_config_4);
+    let _config_6 = resolveUserAgentConfig(_config_5);
     super(_config_6);
     this.config = _config_6;
     this.middlewareStack.use(getAwsAuthPlugin(this.config));
     this.middlewareStack.use(getRetryPlugin(this.config));
-    this.middlewareStack.use(getUserAgentPlugin(this.config));
     this.middlewareStack.use(getContentLengthPlugin(this.config));
     this.middlewareStack.use(getHostHeaderPlugin(this.config));
     this.middlewareStack.use(getLoggerPlugin(this.config));
+    this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
   destroy(): void {

diff --git a/clients/client-acm/runtimeConfig.browser.ts b/clients/client-acm/runtimeConfig.browser.ts
@@ -22,7 +22,10 @@ export const ClientDefaultValues: Required<ClientDefaults> = {
   base64Encoder: toBase64,
   bodyLengthChecker: calculateBodyLength,
   credentialDefaultProvider: invalidAsyncFunction("Credentialis missing") as any,
-  defaultUserAgent: defaultUserAgent(packageInfo.name, packageInfo.version),
+  defaultUserAgentProvider: defaultUserAgent({
+    serviceId: ClientSharedValues.serviceId,
+    clientVersion: packageInfo.version,
+  }),
   maxAttempts: DEFAULT_MAX_ATTEMPTS,
   region: invalidAsyncFunction("Region is missing") as any,
   requestHandler: new FetchHttpHandler(),

diff --git a/clients/client-acm/runtimeConfig.native.ts b/clients/client-acm/runtimeConfig.native.ts
@@ -1,5 +1,3 @@
-import packageInfo from "./package.json";
-
 import { Sha256 } from "@aws-crypto/sha256-js";
 import { parseUrl } from "@aws-sdk/url-parser-node";
 import { ClientDefaults } from "./ACMClient";
@@ -11,7 +9,6 @@ import { ClientDefaultValues as BrowserDefaults } from "./runtimeConfig.browser"
 export const ClientDefaultValues: Required<ClientDefaults> = {
   ...BrowserDefaults,
   runtime: "react-native",
-  defaultUserAgent: `aws-sdk-js-v3-react-native-${packageInfo.name}/${packageInfo.version}`,
   sha256: Sha256,
   urlParser: parseUrl,
 };
diff --git a/clients/client-acm/runtimeConfig.ts b/clients/client-acm/runtimeConfig.ts
@@ -24,7 +24,10 @@ export const ClientDefaultValues: Required<ClientDefaults> = {
   base64Encoder: toBase64,
   bodyLengthChecker: calculateBodyLength,
   credentialDefaultProvider,
-  defaultUserAgent: defaultUserAgent(packageInfo.name, packageInfo.version),
+  defaultUserAgentProvider: defaultUserAgent({
+    serviceId: ClientSharedValues.serviceId,
+    clientVersion: packageInfo.version,
+  }),
   maxAttempts: loadNodeConfig(NODE_MAX_ATTEMPT_CONFIG_OPTIONS),
   region: loadNodeConfig(NODE_REGION_CONFIG_OPTIONS, NODE_REGION_CONFIG_FILE_OPTIONS),
   requestHandler: new NodeHttpHandler(),