feat(client-s3): use global endpoint if region is set to aws-global

Author: AllanZhengYP

packages/middleware-sdk-s3/src/use-regional-endpoint.spec.ts

@@ -8,8 +8,22 @@ describe("useRegionalEndpointMiddleware", () => {
     jest.clearAllMocks();
   });
 
+  it("should accept any endpoint if set by customer", async () => {
+    const config = { isCustomEndpoint: true, region: async () => "foo-region" };
+    const handler = useRegionalEndpointMiddleware(config)(mockNextHandler, {} as any);
+    await handler({
+      input: {},
+      request: new HttpRequest({
+        hostname: "s3.us-east-1.amazonaws.com",
+      }),
+    });
+    expect(mockNextHandler.mock.calls.length).toBe(1);
+    expect(mockNextHandler.mock.calls[0][0].request.hostname).toEqual("s3.us-east-1.amazonaws.com");
+  });
+
   it("should modify the hostname if it's global endpoint", async () => {
-    const handler = useRegionalEndpointMiddleware()(mockNextHandler, {} as any);
+    const config = { isCustomEndpoint: false, region: async () => "foo-region" };
+    const handler = useRegionalEndpointMiddleware(config)(mockNextHandler, {} as any);
     await handler({
       input: {},
       request: new HttpRequest({
@@ -21,7 +35,8 @@ describe("useRegionalEndpointMiddleware", () => {
   });
 
   it("should not modify the hostname if it's regional endpoint", async () => {
-    const handler = useRegionalEndpointMiddleware()(mockNextHandler, {} as any);
+    const config = { isCustomEndpoint: false, region: async () => "foo-region" };
+    const handler = useRegionalEndpointMiddleware(config)(mockNextHandler, {} as any);
     await handler({
       input: {},
       request: new HttpRequest({
@@ -31,4 +46,17 @@ describe("useRegionalEndpointMiddleware", () => {
     expect(mockNextHandler.mock.calls.length).toBe(1);
     expect(mockNextHandler.mock.calls[0][0].request.hostname).toEqual("s3.us-west-2.amazonaws.com");
   });
+
+  it("should use global endpoint if region is set to 'aws-global'", async () => {
+    const config = { isCustomEndpoint: false, region: async () => "aws-global" };
+    const handler = useRegionalEndpointMiddleware(config)(mockNextHandler, {} as any);
+    await handler({
+      input: {},
+      request: new HttpRequest({
+        hostname: "s3.aws-global.amazonaws.com",
+      }),
+    });
+    expect(mockNextHandler.mock.calls.length).toBe(1);
+    expect(mockNextHandler.mock.calls[0][0].request.hostname).toEqual("s3.amazonaws.com");
+  });
 });

packages/middleware-sdk-s3/src/use-regional-endpoint.ts

@@ -5,22 +5,26 @@ import {
   BuildHandlerOptions,
   BuildHandlerOutput,
   BuildMiddleware,
-  Endpoint,
   MetadataBearer,
   Pluggable,
   Provider,
 } from "@aws-sdk/types";
 
-export function useRegionalEndpointMiddleware(config: {
+type PreviouslyResolved = {
   region: Provider<string>;
-  endpoint: Provider<Endpoint>;
-}): BuildMiddleware<any, any> {
+  isCustomEndpoint: boolean;
+};
+
+export function useRegionalEndpointMiddleware(config: PreviouslyResolved): BuildMiddleware<any, any> {
   return <Output extends MetadataBearer>(next: BuildHandler<any, Output>): BuildHandler<any, Output> => async (
     args: BuildHandlerArguments<any>
   ): Promise<BuildHandlerOutput<Output>> => {
     const { request } = args;
-    if (HttpRequest.isInstance(request) && request.hostname === "s3.amazonaws.com") {
+    if (!HttpRequest.isInstance(request) || config.isCustomEndpoint) return next({ ...args });
+    if (request.hostname === "s3.amazonaws.com") {
       request.hostname = "s3.us-east-1.amazonaws.com";
+    } else if ("aws-global" === (await config.region())) {
+      request.hostname = "s3.amazonaws.com";
     }
     return next({ ...args });
   };
@@ -32,9 +36,8 @@ export const useRegionalEndpointMiddlewareOptions: BuildHandlerOptions = {
   name: "useRegionalEndpointMiddleware",
 };
 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export const getUseRegionalEndpointPlugin = (unused: any): Pluggable<any, any> => ({
+export const getUseRegionalEndpointPlugin = (config: PreviouslyResolved): Pluggable<any, any> => ({
   applyToStack: (clientStack) => {
-    clientStack.add(useRegionalEndpointMiddleware(), useRegionalEndpointMiddlewareOptions);
+    clientStack.add(useRegionalEndpointMiddleware(config), useRegionalEndpointMiddlewareOptions);
   },
 });