feat(util-user-agent-*): support non-AWS clients

Author: AllanZhengYP

packages/util-user-agent-browser/src/configurations.ts

@@ -0,0 +1,4 @@
+export interface DefaultUserAgentOptions {
+  serviceId?: string;
+  clientVersion: string;
+}

packages/util-user-agent-browser/src/index.native.spec.ts

@@ -4,10 +4,9 @@ it("should response basic browser default user agent", async () => {
   // RN doesn't have userAgent in window.navigator.
   //@ts-ignore mock no userAgent exists.
   jest.spyOn(window.navigator, "userAgent", "get").mockReturnValue(undefined);
-  const userAgent = await defaultUserAgent("s3", "0.1.0")();
-  expect(userAgent).toContainEqual(["aws-sdk-js", "0.1.0"]);
-  expect(userAgent).toContainEqual(["api/s3", "0.1.0"]);
+  const userAgent = await defaultUserAgent({ serviceId: "s3", clientVersion: "0.1.0" })();
   expect(userAgent).toContainEqual(["os/other"]);
   expect(userAgent).toContainEqual(["md/rn"]);
+  expect(userAgent).toContainEqual(["lang/js"]);
   jest.clearAllMocks();
 });

packages/util-user-agent-browser/src/index.native.ts

@@ -1,23 +1,31 @@
 import { Provider, UserAgent } from "@aws-sdk/types";
 
+import { DefaultUserAgentOptions } from "./configurations";
+
 /**
  * Default provider to the user agent in ReactNative. It's a best effort to infer
  * the device information. It uses bowser library to detect the browser and virsion
  */
-export const defaultUserAgent = (packageName: string, packageVersion: string): Provider<UserAgent> => {
+export const defaultUserAgent = ({
+  serviceId,
+  clientVersion,
+}: DefaultUserAgentOptions): Provider<UserAgent> => async () => {
   // TODO: remove this post GA and version changed to 3.x.x
-  const version = packageVersion.replace(/^1\./, "3.");
-  return async () => [
-    // sdk-metadata
-    ["aws-sdk-js", version],
-    // api-metadata
-    // TODO: use api name instead of package name
-    [`api/${packageName}`, version],
+  clientVersion = clientVersion.replace(/^1\./, "3.");
+  const sections: UserAgent = [
     // os-metadata
     ["os/other"],
     // language-metadata
     // ECMAScript edition doesn't matter in JS.
     ["lang/js"],
     ["md/rn"],
   ];
+
+  if (serviceId) {
+    // api-metadata
+    // service Id may not appear in non-AWS clients
+    sections.push([`api/${serviceId}`, clientVersion]);
+  }
+
+  return sections;
 };

packages/util-user-agent-browser/src/index.spec.ts

@@ -1,13 +1,22 @@
 import { defaultUserAgent } from ".";
 
-it("should response basic browser default user agent", async () => {
-  const ua =
-    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.111 Safari/537.36";
+const ua =
+  "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.111 Safari/537.36";
+
+it("should populate metrics", async () => {
   jest.spyOn(window.navigator, "userAgent", "get").mockReturnValue(ua);
-  const userAgent = await defaultUserAgent("s3", "0.1.0")();
+  const userAgent = await defaultUserAgent({ serviceId: "s3", clientVersion: "0.1.0" })();
   expect(userAgent).toContainEqual(["aws-sdk-js", "0.1.0"]);
   expect(userAgent).toContainEqual(["api/s3", "0.1.0"]);
   expect(userAgent).toContainEqual(["os/macOS", "10.15.7"]);
   expect(userAgent).toContainEqual(["md/browser", "Chrome_86.0.4240.111"]);
+  expect(userAgent).toContainEqual(["lang/js"]);
+  jest.clearAllMocks();
+});
+
+it("should populate metrics when service id not available", async () => {
+  jest.spyOn(window.navigator, "userAgent", "get").mockReturnValue(ua);
+  const userAgent = await defaultUserAgent({ serviceId: undefined, clientVersion: "0.1.0" })();
+  expect(userAgent).not.toContainEqual(["api/s3", "0.1.0"]);
   jest.clearAllMocks();
 });

packages/util-user-agent-browser/src/index.ts

@@ -1,20 +1,22 @@
 import { Provider, UserAgent } from "@aws-sdk/types";
 import { parse } from "bowser";
 
+import { DefaultUserAgentOptions } from "./configurations";
+
 /**
  * Default provider to the user agent in browsers. It's a best effort to infer
  * the device information. It uses bowser library to detect the browser and virsion
  */
-export const defaultUserAgent = (packageName: string, packageVersion: string): Provider<UserAgent> => {
+export const defaultUserAgent = ({
+  serviceId,
+  clientVersion,
+}: DefaultUserAgentOptions): Provider<UserAgent> => async () => {
   // TODO: remove this post GA and version changed to 3.x.x
-  const version = packageVersion.replace(/^1\./, "3.");
+  clientVersion = clientVersion.replace(/^1\./, "3.");
   const parsedUA = window?.navigator?.userAgent ? parse(window.navigator.userAgent) : undefined;
-  return async () => [
+  const sections: UserAgent = [
     // sdk-metadata
-    ["aws-sdk-js", version],
-    // api-metadata
-    // TODO: use api name instead of package name
-    [`api/${packageName}`, version],
+    ["aws-sdk-js", clientVersion],
     // os-metadata
     [`os/${parsedUA?.os?.name || "other"}`, parsedUA?.os?.version],
     // language-metadata
@@ -23,4 +25,12 @@ export const defaultUserAgent = (packageName: string, packageVersion: string): P
     // browser vendor and version.
     ["md/browser", `${parsedUA?.browser?.name ?? "unknown"}_${parsedUA?.browser?.version ?? "unknown"}`],
   ];
+
+  if (serviceId) {
+    // api-metadata
+    // service Id may not appear in non-AWS clients
+    sections.push([`api/${serviceId}`, clientVersion]);
+  }
+
+  return sections;
 };

packages/util-user-agent-node/src/index.spec.ts

@@ -28,25 +28,30 @@ describe("defaultUserAgent", () => {
   });
 
   it("should response basic node default user agent", async () => {
-    const userAgent = await defaultUserAgent("s3", "0.1.0")();
+    const userAgent = await defaultUserAgent({ serviceId: "s3", clientVersion: "0.1.0" })();
     expect(userAgent).toContainEqual(["aws-sdk-js", "0.1.0"]);
     expect(userAgent).toContainEqual(["api/s3", "0.1.0"]);
     expect(userAgent).toContainEqual(["os/darwin", "19.6.0"]);
-    expect(userAgent).toContainEqual(["lang/nodejs", "14.13.1"]);
+    expect(userAgent).toContainEqual(["lang/js"]);
+  });
+
+  it("should skip api version if service id is not supplied", async () => {
+    const userAgent = await defaultUserAgent({ serviceId: undefined, clientVersion: "0.1.0" })();
+    expect(userAgent).not.toContainEqual(["api/s3", "0.1.0"]);
   });
 
   it("should add AWS_EXECUTION_ENV", async () => {
     //@ts-ignore mock environmental variables
     mockEnv.AWS_EXECUTION_ENV = "lambda";
-    const userAgent = await defaultUserAgent("s3", "0.1.0")();
+    const userAgent = await defaultUserAgent({ serviceId: "s3", clientVersion: "0.1.0" })();
     expect(userAgent).toContainEqual(["exec-env/lambda"]);
   });
 
   it("should load app id if available", async () => {
     mockAppIdLoader.mockClear();
     const appId = "appId12345";
     mockAppIdLoader.mockResolvedValue(appId);
-    const userAgent = await defaultUserAgent("s3", "0.1.0")();
+    const userAgent = await defaultUserAgent({ serviceId: "s3", clientVersion: "0.1.0" })();
     expect(userAgent).toContainEqual([`app/${appId}`]);
   });
 });

packages/util-user-agent-node/src/index.ts

@@ -6,35 +6,50 @@ import { env, versions } from "process";
 export const UA_APP_ID_ENV_NAME = "AWS_SDK_UA_APP_ID";
 export const UA_APP_ID_INI_NAME = "sdk-ua-app-id";
 
-export const defaultUserAgent = (packageName: string, packageVersion: string): Provider<UserAgent> => {
+interface DefaultUserAgentOptions {
+  serviceId?: string;
+  clientVersion: string;
+}
+
+/**
+ * Collect metrics from runtime to put into user agent.
+ */
+export const defaultUserAgent = ({
+  serviceId,
+  clientVersion,
+}: DefaultUserAgentOptions): Provider<UserAgent> => async () => {
   // TODO: remove this post GA and version changed to 3.x.x
-  const version = packageVersion.replace(/^1\./, "3.");
+  clientVersion = clientVersion.replace(/^1\./, "3.");
   const sections: UserAgent = [
     // sdk-metadata
-    ["aws-sdk-js", version],
-    // api-metadata
-    // TODO: use api name instead of package name
-    [`api/${packageName}`, version],
+    ["aws-sdk-js", clientVersion],
     // os-metadata
     [`os/${platform()}`, release()],
     // language-metadata
     // ECMAScript edition doesn't matter in JS, so no version needed.
     ["lang/js"],
     ["md/nodejs", `${versions.node}`],
   ];
+
+  if (serviceId) {
+    // api-metadata
+    // service Id may not appear in non-AWS clients
+    sections.push([`api/${serviceId}`, clientVersion]);
+  }
+
   if (env.AWS_EXECUTION_ENV) {
     // env-metadata
     sections.push([`exec-env/${env.AWS_EXECUTION_ENV}`]);
   }
-  return async () => {
-    const appId = await loadConfig<string | undefined>({
-      environmentVariableSelector: (env) => env[UA_APP_ID_ENV_NAME],
-      configFileSelector: (profile) => profile[UA_APP_ID_INI_NAME],
-      default: undefined,
-    })();
-    if (appId) {
-      sections.push([`app/${appId}`]);
-    }
-    return sections;
-  };
+
+  const appId = await loadConfig<string | undefined>({
+    environmentVariableSelector: (env) => env[UA_APP_ID_ENV_NAME],
+    configFileSelector: (profile) => profile[UA_APP_ID_INI_NAME],
+    default: undefined,
+  })();
+  if (appId) {
+    sections.push([`app/${appId}`]);
+  }
+
+  return sections;
 };

yarn.lock

@@ -45,22 +45,19 @@
   dependencies:
     tslib "^1.11.1"
 
-"@aws-sdk/types@^1.0.0-rc.1":
-  version "1.0.0-rc.10"
-  resolved "https://registry.yarnpkg.com/@aws-sdk/types/-/types-1.0.0-rc.10.tgz#729127fbfac5da1a3368ffe6ec2e90acc9ad69c3"
-  integrity sha512-9gwhYnkTNuYZ+etCtM4T8gjpZ0SWSXbzQxY34UjSS+dt3C/UnbX0J22tMahp/9Z1yCa9pihtXrkD+nO2xn7nVQ==
-
-"@aws-sdk/util-locate-window@^1.0.0-rc.1":
+"@aws-sdk/[email protected]":
   version "1.0.0-rc.8"
-  resolved "https://registry.yarnpkg.com/@aws-sdk/util-locate-window/-/util-locate-window-1.0.0-rc.8.tgz#d28175aeb9c8ad3940242e615b1503632d3be33d"
-  integrity sha512-TvqeA4fgmZ0A0x3K+qVj/OSWEFHGZjzpVuyXlm1EYOf7NQ9VWRlokEn1MYKuL+t7al9ZeQyi16D8Dn7DW1eidw==
+  resolved "https://registry.yarnpkg.com/@aws-sdk/node-config-provider/-/node-config-provider-1.0.0-rc.8.tgz#be7959dd564d27e94ca7e7008eb184679f2b2e20"
+  integrity sha512-sRfbQpG8os3Kkecr/2q79UpekWyXhL7Kod04UnjIsAFJkQL1xHkyw7tSdW+7eiXoMCfRDa8VbE05tZK2YD9YuA==
   dependencies:
+    "@aws-sdk/property-provider" "1.0.0-rc.8"
+    "@aws-sdk/shared-ini-file-loader" "1.0.0-rc.8"
     tslib "^1.8.0"
 
-"@aws-sdk/util-utf8-browser@^1.0.0-rc.1":
+"@aws-sdk/shared-ini-file-loader@1.0.0-rc.8":
   version "1.0.0-rc.8"
-  resolved "https://registry.yarnpkg.com/@aws-sdk/util-utf8-browser/-/util-utf8-browser-1.0.0-rc.8.tgz#bf1f1cfed8c024f43a7c43b643fdf2b4523b5973"
-  integrity sha512-clncPMJ23rxCIkZ9LoUC8SowwZGxWyN2TwRb0XvW/Cv9EavkRgRCOrCpneGyC326lqtMKx36onnpaSRHxErUYw==
+  resolved "https://registry.yarnpkg.com/@aws-sdk/shared-ini-file-loader/-/shared-ini-file-loader-1.0.0-rc.8.tgz#36785c595480ad228da8ce81602c31fc909ca29c"
+  integrity sha512-5MmUwfFncn5fPMBD9K24ioLD/S1C4Jz8eEv8tcluEXo8Tb5JDKyY0sJGJjfaTBpWpjZ3rhNDBWM3sWYtMlWPqA==
   dependencies:
     tslib "^1.8.0"