fix(experimentalIdentityAndAuth): rename AWSSDKSigV4 to AwsSdkSigV4

Steven Yuan · Steven Yuan · commit e1e825632aac · 2024-01-10T23:43:35.000-08:00
diff --git a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/auth/http/integration/AwsSdkCustomizeSigV4Auth.java b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/auth/http/integration/AwsSdkCustomizeSigV4Auth.java
@@ -154,30 +154,30 @@ public void customizeSupportedHttpAuthSchemes(
                       }),""", s))
                 .addResolveConfigFunction(ResolveConfigFunction.builder()
                     .resolveConfigFunction(Symbol.builder()
-                        .name("resolveAWSSDKSigV4Config")
+                        .name("resolveAwsSdkSigV4Config")
                         .namespace(AwsDependency.AWS_SDK_CORE.getPackageName(), "/")
                         .addDependency(AwsDependency.AWS_SDK_CORE)
                         .build())
                     .inputConfig(Symbol.builder()
-                        .name("AWSSDKSigV4AuthInputConfig")
+                        .name("AwsSdkSigV4AuthInputConfig")
                         .namespace(AwsDependency.AWS_SDK_CORE.getPackageName(), "/")
                         .addDependency(AwsDependency.AWS_SDK_CORE)
                         .build())
                     .previouslyResolved(Symbol.builder()
-                        .name("AWSSDKSigV4PreviouslyResolved")
+                        .name("AwsSdkSigV4PreviouslyResolved")
                         .namespace(AwsDependency.AWS_SDK_CORE.getPackageName(), "/")
                         .addDependency(AwsDependency.AWS_SDK_CORE)
                         .build())
                     .resolvedConfig(Symbol.builder()
-                        .name("AWSSDKSigV4AuthResolvedConfig")
+                        .name("AwsSdkSigV4AuthResolvedConfig")
                         .namespace(AwsDependency.AWS_SDK_CORE.getPackageName(), "/")
                         .addDependency(AwsDependency.AWS_SDK_CORE)
                         .build())
                     .build())
                 .putDefaultSigner(LanguageTarget.SHARED, w -> w
                     .addDependency(AwsDependency.AWS_SDK_CORE)
-                    .addImport("AWSSDKSigV4Signer", null, AwsDependency.AWS_SDK_CORE)
-                    .write("new AWSSDKSigV4Signer()"))
+                    .addImport("AwsSdkSigV4Signer", null, AwsDependency.AWS_SDK_CORE)
+                    .write("new AwsSdkSigV4Signer()"))
                 .build();
             supportedHttpAuthSchemesIndex.putHttpAuthScheme(authScheme.getSchemeId(), authScheme);
         }
diff --git a/packages/core/src/httpAuthSchemes/aws_sdk/AwsSdkSigV4Signer.ts b/packages/core/src/httpAuthSchemes/aws_sdk/AwsSdkSigV4Signer.ts
@@ -11,21 +11,30 @@ import {
 } from "@smithy/types";
 
 import { getDateHeader, getSkewCorrectedDate, getUpdatedSystemClockOffset } from "../utils";
-import { throwAWSSDKSigningPropertyError } from "./throwAWSSDKSigningPropertyError";
 
 /**
  * @internal
  */
-interface AWSSDKSigV4Config {
+const throwSigningPropertyError = <T>(name: string, property: T | undefined): T | never => {
+  if (!property) {
+    throw new Error(`Property \`${name}\` is not resolved for AWS SDK SigV4Auth`);
+  }
+  return property;
+};
+
+/**
+ * @internal
+ */
+interface AwsSdkSigV4Config {
   systemClockOffset: number;
   signer: (authScheme?: AuthScheme) => Promise<RequestSigner>;
 }
 
 /**
  * @internal
  */
-interface AWSSDKSigV4AuthSigningProperties {
-  config: AWSSDKSigV4Config;
+interface AwsSdkSigV4AuthSigningProperties {
+  config: AwsSdkSigV4Config;
   signer: RequestSigner;
   signingRegion?: string;
   signingName?: string;
@@ -34,7 +43,7 @@ interface AWSSDKSigV4AuthSigningProperties {
 /**
  * @internal
  */
-interface AWSSDKSigV4Exception extends ServiceException {
+interface AwsSdkSigV4Exception extends ServiceException {
   ServerTime?: string;
 }
 
@@ -43,14 +52,14 @@ interface AWSSDKSigV4Exception extends ServiceException {
  */
 const validateSigningProperties = async (
   signingProperties: Record<string, unknown>
-): Promise<AWSSDKSigV4AuthSigningProperties> => {
-  const context = throwAWSSDKSigningPropertyError(
+): Promise<AwsSdkSigV4AuthSigningProperties> => {
+  const context = throwSigningPropertyError(
     "context",
     signingProperties.context as HandlerExecutionContext | undefined
   );
-  const config = throwAWSSDKSigningPropertyError("config", signingProperties.config as AWSSDKSigV4Config | undefined);
+  const config = throwSigningPropertyError("config", signingProperties.config as AwsSdkSigV4Config | undefined);
   const authScheme = context.endpointV2?.properties?.authSchemes?.[0];
-  const signerFunction = throwAWSSDKSigningPropertyError(
+  const signerFunction = throwSigningPropertyError(
     "signer",
     config.signer as ((authScheme?: AuthScheme) => Promise<RequestSigner>) | undefined
   );
@@ -68,7 +77,7 @@ const validateSigningProperties = async (
 /**
  * @internal
  */
-export class AWSSDKSigV4Signer implements HttpSigner {
+export class AwsSdkSigV4Signer implements HttpSigner {
   async sign(
     httpRequest: IHttpRequest,
     /**
@@ -93,11 +102,11 @@ export class AWSSDKSigV4Signer implements HttpSigner {
   errorHandler(signingProperties: Record<string, unknown>): (error: Error) => never {
     return (error: Error) => {
       const serverTime: string | undefined =
-        (error as AWSSDKSigV4Exception).ServerTime ?? getDateHeader((error as AWSSDKSigV4Exception).$response);
+        (error as AwsSdkSigV4Exception).ServerTime ?? getDateHeader((error as AwsSdkSigV4Exception).$response);
       if (serverTime) {
-        const config = throwAWSSDKSigningPropertyError(
+        const config = throwSigningPropertyError(
           "config",
-          signingProperties.config as AWSSDKSigV4Config | undefined
+          signingProperties.config as AwsSdkSigV4Config | undefined
         );
         config.systemClockOffset = getUpdatedSystemClockOffset(serverTime, config.systemClockOffset);
       }
@@ -108,11 +117,16 @@ export class AWSSDKSigV4Signer implements HttpSigner {
   successHandler(httpResponse: HttpResponse | unknown, signingProperties: Record<string, unknown>): void {
     const dateHeader = getDateHeader(httpResponse);
     if (dateHeader) {
-      const config = throwAWSSDKSigningPropertyError(
+      const config = throwSigningPropertyError(
         "config",
-        signingProperties.config as AWSSDKSigV4Config | undefined
+        signingProperties.config as AwsSdkSigV4Config | undefined
       );
       config.systemClockOffset = getUpdatedSystemClockOffset(dateHeader, config.systemClockOffset);
     }
   }
 }
+
+/**
+ * @deprecated renamed to {@link AwsSdkSigV4Signer}
+ */
+export const AWSSDKSigV4Signer = AwsSdkSigV4Signer;
diff --git a/packages/core/src/httpAuthSchemes/aws_sdk/index.ts b/packages/core/src/httpAuthSchemes/aws_sdk/index.ts
@@ -1,2 +1,2 @@
-export * from "./AWSSDKSigV4Signer";
-export * from "./resolveAWSSDKSigV4Config";
+export * from "./AwsSdkSigV4Signer";
+export * from "./resolveAwsSdkSigV4Config";
diff --git a/packages/core/src/httpAuthSchemes/aws_sdk/resolveAwsSdkSigV4Config.ts b/packages/core/src/httpAuthSchemes/aws_sdk/resolveAwsSdkSigV4Config.ts
@@ -21,7 +21,7 @@ import {
 /**
  * @internal
  */
-export interface AWSSDKSigV4AuthInputConfig {
+export interface AwsSdkSigV4AuthInputConfig {
   /**
    * The credentials used to sign requests.
    */
@@ -60,7 +60,7 @@ export interface AWSSDKSigV4AuthInputConfig {
 /**
  * @internal
  */
-export interface AWSSDKSigV4PreviouslyResolved {
+export interface AwsSdkSigV4PreviouslyResolved {
   credentialDefaultProvider?: (input: any) => MemoizedProvider<AwsCredentialIdentity>;
   region: string | Provider<string>;
   sha256: ChecksumConstructor | HashConstructor;
@@ -75,33 +75,33 @@ export interface AWSSDKSigV4PreviouslyResolved {
 /**
  * @internal
  */
-export interface AWSSDKSigV4AuthResolvedConfig {
+export interface AwsSdkSigV4AuthResolvedConfig {
   /**
-   * Resolved value for input config {@link AWSSDKSigV4AuthInputConfig.credentials}
+   * Resolved value for input config {@link AwsSdkSigV4AuthInputConfig.credentials}
    * This provider MAY memoize the loaded credentials for certain period.
    * See {@link MemoizedProvider} for more information.
    */
   credentials: AwsCredentialIdentityProvider;
   /**
-   * Resolved value for input config {@link AWSSDKSigV4AuthInputConfig.signer}
+   * Resolved value for input config {@link AwsSdkSigV4AuthInputConfig.signer}
    */
   signer: (authScheme?: AuthScheme) => Promise<RequestSigner>;
   /**
-   * Resolved value for input config {@link AWSSDKSigV4AuthInputConfig.signingEscapePath}
+   * Resolved value for input config {@link AwsSdkSigV4AuthInputConfig.signingEscapePath}
    */
   signingEscapePath: boolean;
   /**
-   * Resolved value for input config {@link AWSSDKSigV4AuthInputConfig.systemClockOffset}
+   * Resolved value for input config {@link AwsSdkSigV4AuthInputConfig.systemClockOffset}
    */
   systemClockOffset: number;
 }
 
 /**
  * @internal
  */
-export const resolveAWSSDKSigV4Config = <T>(
-  config: T & AWSSDKSigV4AuthInputConfig & AWSSDKSigV4PreviouslyResolved
-): T & AWSSDKSigV4AuthResolvedConfig => {
+export const resolveAwsSdkSigV4Config = <T>(
+  config: T & AwsSdkSigV4AuthInputConfig & AwsSdkSigV4PreviouslyResolved
+): T & AwsSdkSigV4AuthResolvedConfig => {
   // Normalize credentials
   let normalizedCreds: AwsCredentialIdentityProvider | undefined;
   if (config.credentials) {
@@ -214,3 +214,23 @@ export const resolveAWSSDKSigV4Config = <T>(
     signer,
   };
 };
+
+/**
+ * @deprecated renamed to {@link AwsSdkSigV4AuthInputConfig}
+ */
+export interface AWSSDKSigV4AuthInputConfig extends AwsSdkSigV4AuthInputConfig {}
+
+/**
+ * @deprecated renamed to {@link AwsSdkSigV4PreviouslyResolved}
+ */
+export interface AWSSDKSigV4PreviouslyResolved extends AwsSdkSigV4PreviouslyResolved {}
+
+/**
+ * @deprecated renamed to {@link AwsSdkSigV4AuthResolvedConfig}
+ */
+export interface AWSSDKSigV4AuthResolvedConfig extends AwsSdkSigV4AuthResolvedConfig {}
+
+/**
+ * @deprecated renamed to {@link resolveAwsSdkSigV4Config}
+ */
+export const resolveAWSSDKSigV4Config = resolveAwsSdkSigV4Config;
diff --git a/packages/core/src/httpAuthSchemes/aws_sdk/throwAWSSDKSigningPropertyError.ts b/packages/core/src/httpAuthSchemes/aws_sdk/throwAWSSDKSigningPropertyError.ts
diff --git a/packages/core/src/httpAuthSchemes/aws_sdk_copy/AwsSdkSigV4Signer.ts b/packages/core/src/httpAuthSchemes/aws_sdk_copy/AwsSdkSigV4Signer.ts
@@ -0,0 +1,132 @@
+import { HttpRequest } from "@smithy/protocol-http";
+import { ServiceException } from "@smithy/smithy-client";
+import {
+  AuthScheme,
+  AwsCredentialIdentity,
+  HandlerExecutionContext,
+  HttpRequest as IHttpRequest,
+  HttpResponse,
+  HttpSigner,
+  RequestSigner,
+} from "@smithy/types";
+
+import { getDateHeader, getSkewCorrectedDate, getUpdatedSystemClockOffset } from "../utils";
+
+/**
+ * @internal
+ */
+const throwSigningPropertyError = <T>(name: string, property: T | undefined): T | never => {
+  if (!property) {
+    throw new Error(`Property \`${name}\` is not resolved for AWS SDK SigV4Auth`);
+  }
+  return property;
+};
+
+/**
+ * @internal
+ */
+interface AwsSdkSigV4Config {
+  systemClockOffset: number;
+  signer: (authScheme?: AuthScheme) => Promise<RequestSigner>;
+}
+
+/**
+ * @internal
+ */
+interface AwsSdkSigV4AuthSigningProperties {
+  config: AwsSdkSigV4Config;
+  signer: RequestSigner;
+  signingRegion?: string;
+  signingName?: string;
+}
+
+/**
+ * @internal
+ */
+interface AwsSdkSigV4Exception extends ServiceException {
+  ServerTime?: string;
+}
+
+/**
+ * @internal
+ */
+const validateSigningProperties = async (
+  signingProperties: Record<string, unknown>
+): Promise<AwsSdkSigV4AuthSigningProperties> => {
+  const context = throwSigningPropertyError(
+    "context",
+    signingProperties.context as HandlerExecutionContext | undefined
+  );
+  const config = throwSigningPropertyError("config", signingProperties.config as AwsSdkSigV4Config | undefined);
+  const authScheme = context.endpointV2?.properties?.authSchemes?.[0];
+  const signerFunction = throwSigningPropertyError(
+    "signer",
+    config.signer as ((authScheme?: AuthScheme) => Promise<RequestSigner>) | undefined
+  );
+  const signer = await signerFunction(authScheme);
+  const signingRegion: string | undefined = signingProperties?.signingRegion as string | undefined;
+  const signingName = signingProperties?.signingName as string | undefined;
+  return {
+    config,
+    signer,
+    signingRegion,
+    signingName,
+  };
+};
+
+/**
+ * @internal
+ */
+export class AwsSdkSigV4Signer implements HttpSigner {
+  async sign(
+    httpRequest: IHttpRequest,
+    /**
+     * `identity` is bound in {@link resolveAWSSDKSigV4Config}
+     */
+    identity: AwsCredentialIdentity,
+    signingProperties: Record<string, unknown>
+  ): Promise<IHttpRequest> {
+    if (!HttpRequest.isInstance(httpRequest)) {
+      throw new Error("The request is not an instance of `HttpRequest` and cannot be signed");
+    }
+    const { config, signer, signingRegion, signingName } = await validateSigningProperties(signingProperties);
+
+    const signedRequest = await signer.sign(httpRequest, {
+      signingDate: getSkewCorrectedDate(config.systemClockOffset),
+      signingRegion: signingRegion,
+      signingService: signingName,
+    });
+    return signedRequest;
+  }
+
+  errorHandler(signingProperties: Record<string, unknown>): (error: Error) => never {
+    return (error: Error) => {
+      const serverTime: string | undefined =
+        (error as AwsSdkSigV4Exception).ServerTime ?? getDateHeader((error as AwsSdkSigV4Exception).$response);
+      if (serverTime) {
+        const config = throwSigningPropertyError(
+          "config",
+          signingProperties.config as AwsSdkSigV4Config | undefined
+        );
+        config.systemClockOffset = getUpdatedSystemClockOffset(serverTime, config.systemClockOffset);
+      }
+      throw error;
+    };
+  }
+
+  successHandler(httpResponse: HttpResponse | unknown, signingProperties: Record<string, unknown>): void {
+    const dateHeader = getDateHeader(httpResponse);
+    if (dateHeader) {
+      const config = throwSigningPropertyError(
+        "config",
+        signingProperties.config as AwsSdkSigV4Config | undefined
+      );
+      config.systemClockOffset = getUpdatedSystemClockOffset(dateHeader, config.systemClockOffset);
+    }
+  }
+}
+
+/**
+ * @deprecated renamed to {@link AwsSdkSigV4Signer}
+ */
+export const AWSSDKSigV4Signer = AwsSdkSigV4Signer;
diff --git a/packages/core/src/httpAuthSchemes/aws_sdk_copy/index.ts b/packages/core/src/httpAuthSchemes/aws_sdk_copy/index.ts
@@ -0,0 +1,2 @@
+export * from "./AwsSdkSigV4Signer";
+export * from "./resolveAwsSdkSigV4Config";
diff --git a/packages/core/src/httpAuthSchemes/aws_sdk_copy/resolveAwsSdkSigV4Config.ts b/packages/core/src/httpAuthSchemes/aws_sdk_copy/resolveAwsSdkSigV4Config.ts

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export * from "./AwsSdkSigV4Signer";`
	`2`	`+export * from "./resolveAwsSdkSigV4Config";`