feat(endpoint): address PR style comments

Author: kuhe

lib/lib-storage/src/Upload.ts

@@ -13,7 +13,7 @@ import {
   Tag,
   UploadPartCommand,
 } from "@aws-sdk/client-s3";
-import { EndpointResolvedConfig, getEndpointFromInstructions, toEndpointV1 } from "@aws-sdk/middleware-endpoint";
+import { getEndpointFromInstructions, toEndpointV1 } from "@aws-sdk/middleware-endpoint";
 import { HttpRequest } from "@aws-sdk/protocol-http";
 import { extendedEncodeURIComponent } from "@aws-sdk/smithy-client";
 import { Endpoint } from "@aws-sdk/types";

packages/middleware-endpoint/src/adaptors/getEndpointFromConfig.ts renamed to packages/middleware-endpoint/src/adaptors/getEndpointFromInstructions.ts

@@ -4,24 +4,23 @@ import { EndpointResolvedConfig } from "../resolveEndpointConfig";
 import { EndpointParameterInstructions } from "../types";
 
 /**
- *
  * This step in the endpoint resolution process is exposed as a function
  * to allow certain packages such as s3 signer, lib-upload to get
  * the V2 Endpoint associated to an instance of some (operation) command.
  *
  * @private
- *
  */
 export const getEndpointFromInstructions = async (
   commandInput: any,
   instructionsSupplier: Partial<{
-    instructions(): EndpointParameterInstructions;
+    getEndpointParameterInstructions(): EndpointParameterInstructions;
   }>,
   clientConfig: Partial<EndpointResolvedConfig>,
   context?: HandlerExecutionContext
 ): Promise<EndpointV2> => {
   const endpointParams: EndpointParameters = {};
-  const instructions: EndpointParameterInstructions = (instructionsSupplier.instructions || (() => null))() || {};
+  const instructions: EndpointParameterInstructions =
+    (instructionsSupplier.getEndpointParameterInstructions || (() => null))() || {};
 
   if (typeof clientConfig.endpointProvider !== "function") {
     throw new Error("config.endpointProvider is not set.");
@@ -52,7 +51,7 @@ export const getEndpointFromInstructions = async (
  * @private
  */
 const createConfigProvider = (configKey: string, config: EndpointResolvedConfig & any) => {
-  return async function configProvider() {
+  const configProvider = async () => {
     if (!(configKey in config)) {
       throw new Error(`The config key ${configKey} was not found in the config object.`);
     }
@@ -62,4 +61,5 @@ const createConfigProvider = (configKey: string, config: EndpointResolvedConfig
     }
     return configValue;
   };
+  return configProvider;
 };

packages/middleware-endpoint/src/adaptors/index.ts

@@ -0,0 +1,2 @@
+export * from "./getEndpointFromInstructions";
+export * from "./toEndpointV1";

packages/middleware-endpoint/src/endpointMiddleware.ts

@@ -10,7 +10,7 @@ import {
   SerializeMiddleware,
 } from "@aws-sdk/types";
 
-import { getEndpointFromInstructions } from "./adaptors/getEndpointFromConfig";
+import { getEndpointFromInstructions } from "./adaptors/getEndpointFromInstructions";
 import { EndpointResolvedConfig } from "./resolveEndpointConfig";
 import { EndpointParameterInstructions } from "./types";
 
@@ -29,24 +29,29 @@ export const endpointMiddleware = ({
       context: HandlerExecutionContext
     ): SerializeHandler<any, Output> =>
     async (args: SerializeHandlerArguments<any>): Promise<SerializeHandlerOutput<Output>> => {
-      if (HttpRequest.isInstance(args.request)) {
-        const { request } = args;
+      if (!HttpRequest.isInstance(args.request)) {
+        return next(args);
+      }
+      const { request } = args;
 
-        const endpoint: EndpointV2 = await getEndpointFromInstructions(args.input, instructions, config, context);
+      const endpoint: EndpointV2 = await getEndpointFromInstructions(args.input, instructions, config, context);
 
-        context.endpointV2 = endpoint;
-        context.authSchemes = endpoint.properties?.authSchemes;
+      context.endpointV2 = endpoint;
+      context.authSchemes = endpoint.properties?.authSchemes;
+
+      request.headers = Object.entries(endpoint.headers || {}).reduce(
+        (headers, [name, values]) => ({
+          ...headers,
+          [name]: values.join(","),
+        }),
+        {} as Record<string, string>
+      );
+      request.hostname = endpoint.url.hostname;
+      request.path = endpoint.url.pathname;
+      request.port = parseInt(endpoint.url.port);
+      request.protocol = endpoint.url.protocol;
+      request.query = parseQueryString(endpoint.url.search);
 
-        request.headers = Object.entries(endpoint.headers || {}).reduce((headers, [name, values]) => {
-          headers[name] = values.join(",");
-          return headers;
-        }, {} as Record<string, string>);
-        request.hostname = endpoint.url.hostname;
-        request.path = endpoint.url.pathname;
-        request.port = parseInt(endpoint.url.port);
-        request.protocol = endpoint.url.protocol;
-        request.query = parseQueryString(endpoint.url.search);
-      }
       return next({
         ...args,
       });

packages/middleware-endpoint/src/getEndpointPlugin.ts

@@ -7,7 +7,7 @@ import { EndpointParameterInstructions } from "./types";
 export const endpointMiddlewareOptions: SerializeHandlerOptions = {
   step: "serialize",
   tags: ["ENDPOINT_PARAMETERS", "ENDPOINT_V2", "ENDPOINT"],
-  name: "endpointsV2Middleware",
+  name: "endpointV2Middleware",
   override: true,
 };
 

packages/middleware-endpoint/src/index.ts

@@ -1,5 +1,4 @@
-export * from "./adaptors/getEndpointFromConfig";
-export * from "./adaptors/toEndpointV1";
+export * from "./adaptors";
 export * from "./endpointMiddleware";
 export * from "./getEndpointPlugin";
 export * from "./resolveEndpointConfig";

packages/middleware-endpoint/src/resolveEndpointConfig.ts

@@ -4,8 +4,8 @@ import { normalizeProvider } from "@aws-sdk/util-middleware";
 import { toEndpointV1 } from "./adaptors/toEndpointV1";
 
 /**
- * Endpoint config interfaces and resolver for Endpoints v2. They live in separate package to allow per-service onboarding.
- * When all services onboard the Endpoints v2, the resolver in config-resolver package can be removed.
+ * Endpoint config interfaces and resolver for Endpoint v2. They live in separate package to allow per-service onboarding.
+ * When all services onboard Endpoint v2, the resolver in config-resolver package can be removed.
  * This interface includes all the endpoint parameters with built-in bindings of "AWS::*" and "SDK::*"
  */
 export interface EndpointInputConfig<T extends EndpointParameters = EndpointParameters> {

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

@@ -3,7 +3,8 @@
  */
 export interface S3InputConfig {
   /**
-   * Whether to force path style URLs for S3 objects (e.g., https://s3.amazonaws.com/<bucketName>/<key> instead of https://<bucketName>.s3.amazonaws.com/<key>
+   * Whether to force path style URLs for S3 objects
+   * (e.g., https://s3.amazonaws.com/<bucketName>/<key> instead of https://<bucketName>.s3.amazonaws.com/<key>
    */
   forcePathStyle?: boolean;
   /**
@@ -17,10 +18,8 @@ export interface S3ResolvedConfig {
   useAccelerateEndpoint: boolean;
 }
 
-export function resolveS3Config<T>(input: T & S3InputConfig): T & S3ResolvedConfig {
-  return {
-    ...input,
-    forcePathStyle: input.forcePathStyle ?? false,
-    useAccelerateEndpoint: input.useAccelerateEndpoint ?? false,
-  };
-}
+export const resolveS3Config = <T>(input: T & S3InputConfig): T & S3ResolvedConfig => ({
+  ...input,
+  forcePathStyle: input.forcePathStyle ?? false,
+  useAccelerateEndpoint: input.useAccelerateEndpoint ?? false,
+});