feat: rename defaultUserAgent config to defaultUserAgentProvider

Author: AllanZhengYP

.vscode/settings.json

@@ -3,5 +3,11 @@
   "editor.formatOnSave": true,
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.rulers": [80, 120],
-  "typescript.tsdk": "node_modules/typescript/lib"
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "java.project.referencedLibraries": [
+    "lib/**/*.jar",
+    "/home/ec2-user/workspace/smithy-typescript/**/*.jar",
+    "/home/ec2-user/workspace/smithy/**/*.jar"
+  ],
+  "java.configuration.updateBuildConfiguration": "automatic"
 }

codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddUserAgentDependency.java

@@ -52,8 +52,8 @@ public void addConfigInterfaceFields(
         writer.addImport("Provider", "Provider", TypeScriptDependency.AWS_SDK_TYPES.packageName);
         writer.addImport("UserAgent", "__UserAgent", TypeScriptDependency.AWS_SDK_TYPES.packageName);
         writer.writeDocs("The provider populating default tracking information to be sent with `user-agent`, "
-                + "`x-amz-user-agent` header");
-        writer.write("defaultUserAgent?: Provider<__UserAgent>;\n");
+                + "`x-amz-user-agent` header\n@internal");
+        writer.write("defaultUserAgentProvider?: Provider<__UserAgent>;\n");
     }
 
     @Override
@@ -66,23 +66,23 @@ public Map<String, Consumer<TypeScriptWriter>> getRuntimeConfigWriters(
         switch (target) {
             case NODE:
                 return MapUtils.of(
-                        "defaultUserAgent", writer -> {
+                        "defaultUserAgentProvider", writer -> {
                             writer.addDependency(AwsDependency.AWS_SDK_UTIL_USER_AGENT_NODE.dependency);
                             writer.addImport("defaultUserAgent", "defaultUserAgent",
                                     AwsDependency.AWS_SDK_UTIL_USER_AGENT_NODE.packageName);
                             writer.addDefaultImport("packageInfo", "./package.json");
-                            writer.write("defaultUserAgent: defaultUserAgent({serviceId: ClientSharedValues.serviceId,"
+                            writer.write("defaultUserAgentProvider: defaultUserAgent({serviceId: ClientSharedValues.serviceId,"
                                     + " clientVersion: packageInfo.version}),");
                         }
                 );
             case BROWSER:
                 return MapUtils.of(
-                        "defaultUserAgent", writer -> {
+                        "defaultUserAgentProvider", writer -> {
                             writer.addDependency(AwsDependency.AWS_SDK_UTIL_USER_AGENT_BROWSER.dependency);
                             writer.addImport("defaultUserAgent", "defaultUserAgent",
                                     AwsDependency.AWS_SDK_UTIL_USER_AGENT_BROWSER.packageName);
                             writer.addDefaultImport("packageInfo", "./package.json");
-                            writer.write("defaultUserAgent: defaultUserAgent({serviceId: ClientSharedValues.serviceId,"
+                            writer.write("defaultUserAgentProvider: defaultUserAgent({serviceId: ClientSharedValues.serviceId,"
                                     + " clientVersion: packageInfo.version}),");
                         }
                 );

packages/middleware-user-agent/src/configurations.ts

@@ -6,11 +6,11 @@ export interface UserAgentInputConfig {
   customUserAgent?: string | UserAgent;
 }
 interface PreviouslyResolved {
-  defaultUserAgent: Provider<UserAgent>;
+  defaultUserAgentProvider: Provider<UserAgent>;
   runtime: string;
 }
 export interface UserAgentResolvedConfig {
-  defaultUserAgent: Provider<UserAgent>;
+  defaultUserAgentProvider: Provider<UserAgent>;
   customUserAgent?: UserAgent;
   runtime: string;
 }

packages/middleware-user-agent/src/user-agent-middleware.spec.ts

@@ -13,7 +13,7 @@ describe("userAgentMiddleware", () => {
 
   it("should collect user agent pair from default, custom-supplied, and handler context", async () => {
     const middleware = userAgentMiddleware({
-      defaultUserAgent: async () => [
+      defaultUserAgentProvider: async () => [
         ["default_agent", "1.0.0"],
         ["aws-sdk-js", "1.0.0"],
       ],
@@ -35,7 +35,7 @@ describe("userAgentMiddleware", () => {
 
   it(`should not set ${USER_AGENT} header in browser`, async () => {
     const middleware = userAgentMiddleware({
-      defaultUserAgent: async () => [["aws-sdk-js", "1.0.0"]],
+      defaultUserAgentProvider: async () => [["aws-sdk-js", "1.0.0"]],
       runtime: "browser",
     });
     const handler = middleware(mockNextHandler, {});
@@ -57,7 +57,7 @@ describe("userAgentMiddleware", () => {
     for (const { ua, expected } of cases) {
       it(`should sanitize user agent ${ua} to ${expected}`, async () => {
         const middleware = userAgentMiddleware({
-          defaultUserAgent: async () => [ua],
+          defaultUserAgentProvider: async () => [ua],
           runtime: "browser",
         });
         const handler = middleware(mockNextHandler, {});

packages/middleware-user-agent/src/user-agent-middleware.ts

@@ -33,7 +33,7 @@ export const userAgentMiddleware = (options: UserAgentResolvedConfig) => <Output
   if (!HttpRequest.isInstance(request)) return next(args);
   const { headers } = request;
   const userAgent = context?.userAgent?.map(escapeUserAgent) || [];
-  const defaultUserAgent = (await options.defaultUserAgent()).map(escapeUserAgent);
+  const defaultUserAgent = (await options.defaultUserAgentProvider()).map(escapeUserAgent);
   const customUserAgent = options?.customUserAgent?.map(escapeUserAgent) || [];
   // Set value to AWS-specific user agent header
   headers[X_AMZ_USER_AGENT] = [...defaultUserAgent, ...userAgent, ...customUserAgent].join(SPACE);

scripts/generate-clients/copy-to-clients.js

@@ -17,6 +17,7 @@ const getOverwritablePredicate = (packageName) => (pathName) => {
     "runtimeConfig.native.ts",
     "index.ts",
     "endpoints.ts",
+    "tsconfig.json",
   ];
   return (
     pathName
@@ -56,9 +57,13 @@ const mergeManifest = (fromContent = {}, toContent = {}) => {
       // present in package.json
       merged[name] = toContent[name] || getInternalDepVersion(name);
     } else {
-      // If key (say dependency) is present in both codegen and
-      // package.json, we prefer latter
-      merged[name] = toContent[name] || fromContent[name];
+      if (name === "typedoc" || name === "clean" || name === "build-documentation") {
+        merged[name] = fromContent[name];
+      } else {
+        // If key (say dependency) is present in both codegen and
+        // package.json, we prefer latter
+        merged[name] = toContent[name] || fromContent[name];
+      }
     }
   }
   return merged;