fix(client-s3): address PR feedbacks

Author: AllanZhengYP

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

@@ -69,9 +69,9 @@ public final class AddS3Config implements TypeScriptIntegration {
         "CompleteMultipartUpload"
     );
 
-    private static final String CRT_NOTIFICATION = "<p>Note: To supply the Multi-region Access Point(MRAP) to Bucket,"
-            + " you need to install the \"aws-crt\" package sparately. For more information, please go to "
-            + "https://github.com/aws/aws-sdk-js-v3#known-issues</p>";
+    private static final String CRT_NOTIFICATION = "<p>Note: To supply the Multi-region Access Point (MRAP) to Bucket,"
+            + " you need to install the \"@aws-sdk/signature-v4-crt\" package to your project dependencies. \n"
+            + "For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>";
 
     @Override
     public Model preprocessModel(PluginContext context, TypeScriptSettings settings) {

packages/middleware-sdk-s3/src/S3SignatureV4.ts

@@ -23,7 +23,7 @@ export type S3SignerV4Init = SignatureV4Init &
  */
 export class S3SignatureV4 implements RequestPresigner, RequestSigner {
   private readonly sigv4Signer: SignatureV4;
-  private sigv4aSigner?: RequestSigner & RequestPresigner;
+  private sigv4aSigner?: CrtSignerV4;
   private readonly signerOptions: S3SignerV4Init;
 
   constructor(options: S3SignerV4Init) {
@@ -35,14 +35,7 @@ export class S3SignatureV4 implements RequestPresigner, RequestSigner {
     if (options.signingRegion === "*") {
       if (this.signerOptions.runtime !== "node")
         throw new Error("This request requires signing with SigV4Asymmetric algorithm. It's only available in Node.js");
-      if (!this.sigv4aSigner) {
-        const CrtSignerV4 = await expectSigv4aSigner();
-        this.sigv4aSigner = new CrtSignerV4({
-          ...this.signerOptions,
-          signingAlgorithm: 1,
-        });
-      }
-      return this.sigv4aSigner.sign(requestToSign, options);
+      return (await this.getSigv4aSigner()).sign(requestToSign, options);
     }
     return this.sigv4Signer.sign(requestToSign, options);
   }
@@ -51,26 +44,27 @@ export class S3SignatureV4 implements RequestPresigner, RequestSigner {
     if (options.signingRegion === "*") {
       if (this.signerOptions.runtime !== "node")
         throw new Error("This request requires signing with SigV4Asymmetric algorithm. It's only available in Node.js");
-      if (!this.sigv4aSigner) {
-        const CrtSignerV4 = await expectSigv4aSigner();
-        this.sigv4aSigner = new CrtSignerV4({
-          ...this.signerOptions,
-          signingAlgorithm: 1,
-        });
-      }
-      return this.sigv4aSigner.presign(originalRequest, options);
+      return (await this.getSigv4aSigner()).presign(originalRequest, options);
     }
     return this.sigv4Signer.presign(originalRequest, options);
   }
-}
 
-const expectSigv4aSigner = async (): Promise<new (options: CrtSignerV4Init & SignatureV4CryptoInit) => CrtSignerV4> => {
-  try {
-    return (await import("@aws-sdk/signature-v4-crt")).CrtSignerV4;
-  } catch (e) {
-    e.message =
-      `${e.message}\nPlease check if you have installed "@aws-sdk/signature-v4-crt" package explicitly. ` +
-      "For more information please go to https://github.com/aws/aws-sdk-js-v3#known-issues";
-    throw e;
+  private async getSigv4aSigner(): Promise<CrtSignerV4> {
+    if (!this.sigv4aSigner) {
+      let CrtSignerV4: new (options: CrtSignerV4Init & SignatureV4CryptoInit) => CrtSignerV4;
+      try {
+        CrtSignerV4 = (await import("@aws-sdk/signature-v4-crt")).CrtSignerV4;
+      } catch (e) {
+        e.message =
+          `${e.message}\nPlease check if you have installed "@aws-sdk/signature-v4-crt" package explicitly. \n` +
+          "For more information please go to https://github.com/aws/aws-sdk-js-v3#known-issues";
+        throw e;
+      }
+      this.sigv4aSigner = new CrtSignerV4({
+        ...this.signerOptions,
+        signingAlgorithm: 1,
+      });
+    }
+    return this.sigv4aSigner;
   }
-};
+}

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

@@ -31,39 +31,38 @@ export const userAgentMiddleware =
   <Output extends MetadataBearer>(
     next: BuildHandler<any, any>,
     context: HandlerExecutionContext
-  ): BuildHandler<any, any> => {
-    return async (args: BuildHandlerArguments<any>): Promise<BuildHandlerOutput<Output>> => {
-      const { request } = args;
-      if (!HttpRequest.isInstance(request)) return next(args);
-      const { headers } = request;
-      const userAgent = context?.userAgent?.map(escapeUserAgent) || [];
-      const defaultUserAgent = (await options.defaultUserAgentProvider()).map(escapeUserAgent);
-      const customUserAgent = options?.customUserAgent?.map(escapeUserAgent) || [];
+  ): BuildHandler<any, any> =>
+  async (args: BuildHandlerArguments<any>): Promise<BuildHandlerOutput<Output>> => {
+    const { request } = args;
+    if (!HttpRequest.isInstance(request)) return next(args);
+    const { headers } = request;
+    const userAgent = context?.userAgent?.map(escapeUserAgent) || [];
+    const defaultUserAgent = (await options.defaultUserAgentProvider()).map(escapeUserAgent);
+    const customUserAgent = options?.customUserAgent?.map(escapeUserAgent) || [];
 
-      // Set value to AWS-specific user agent header
-      const sdkUserAgentValue = [...defaultUserAgent, ...userAgent, ...customUserAgent].join(SPACE);
-      // Get value to be sent with non-AWS-specific user agent header.
-      const normalUAValue = [
-        ...defaultUserAgent.filter((section) => section.startsWith("aws-sdk-")),
-        ...customUserAgent,
-      ].join(SPACE);
+    // Set value to AWS-specific user agent header
+    const sdkUserAgentValue = [...defaultUserAgent, ...userAgent, ...customUserAgent].join(SPACE);
+    // Get value to be sent with non-AWS-specific user agent header.
+    const normalUAValue = [
+      ...defaultUserAgent.filter((section) => section.startsWith("aws-sdk-")),
+      ...customUserAgent,
+    ].join(SPACE);
 
-      if (options.runtime !== "browser") {
-        if (normalUAValue) {
-          headers[X_AMZ_USER_AGENT] = headers[X_AMZ_USER_AGENT]
-            ? `${headers[USER_AGENT]} ${normalUAValue}`
-            : normalUAValue;
-        }
-        headers[USER_AGENT] = sdkUserAgentValue;
-      } else {
-        headers[X_AMZ_USER_AGENT] = sdkUserAgentValue;
+    if (options.runtime !== "browser") {
+      if (normalUAValue) {
+        headers[X_AMZ_USER_AGENT] = headers[X_AMZ_USER_AGENT]
+          ? `${headers[USER_AGENT]} ${normalUAValue}`
+          : normalUAValue;
       }
+      headers[USER_AGENT] = sdkUserAgentValue;
+    } else {
+      headers[X_AMZ_USER_AGENT] = sdkUserAgentValue;
+    }
 
-      return next({
-        ...args,
-        request,
-      });
-    };
+    return next({
+      ...args,
+      request,
+    });
   };
 
 /**

packages/util-user-agent-node/src/is-crt-available.ts

@@ -13,7 +13,6 @@ export const isCrtAvailable = (): UserAgentPair | null => {
     }
     return null;
   } catch (e) {
-    console.log("||||||", process.versions, e);
     // No aws-crt package available in the runtime.
     return null;
   }