fix(endpoint): test fixes for s3-control related to endpoints 2.0 (#4065)

Author: kuhe

clients/client-s3-control/test/S3Control.spec.ts

@@ -8,7 +8,7 @@ describe("S3Control Client", () => {
   // Middleware intercept request and return it before reaching the HTTP client. It records the request and context
   // and return them in the Metadata.
   const interceptionMiddleware: FinalizeRequestMiddleware<any, any> = (next, context) => (args) => {
-    return Promise.resolve({ output: { $metadata: { request: args.request } }, response: "" as any });
+    return Promise.resolve({ output: { $metadata: { request: args.request, context } }, response: "" as any });
   };
   const region = "us-east-1";
   const credentials = { accessKeyId: "AKID", secretAccessKey: "SECRET" };
@@ -30,14 +30,14 @@ describe("S3Control Client", () => {
       );
     });
 
-    // TODO(endpointsv2)
-    it.skip("should populate correct endpoint and signing region if OutpostId is supplied", async () => {
+    it("should populate correct endpoint and signing region if OutpostId is supplied", async () => {
       const OutpostId = "123456789012";
       const {
         // @ts-ignore request is set in $metadata by interception middleware.
         $metadata: { request },
       } = await s3Control.createBucket({ Bucket: "Bucket", OutpostId });
       expect(request.hostname).eql(`s3-outposts.${region}.amazonaws.com`);
+
       expect(request.headers[HEADER_OUTPOST_ID]).eql(OutpostId);
       expect(request.headers["authorization"]).contains(
         `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3-outposts/aws4_request`
@@ -58,14 +58,13 @@ describe("S3Control Client", () => {
       );
     });
 
-    // TODO(endpointsv2)
-    it.skip("should populate correct endpoint and signing region if OutpostId is supplied", async () => {
+    it("should populate correct endpoint and signing region if OutpostId is supplied", async () => {
       const OutpostId = "123456789012";
       const {
         // @ts-ignore request is set in $metadata by interception middleware.
         $metadata: { request },
       } = await s3Control.listRegionalBuckets({ AccountId, OutpostId });
-      expect(request.hostname).eql(`s3-outposts.${region}.amazonaws.com`);
+      expect(request.hostname).contains(`s3-outposts.${region}.amazonaws.com`);
       expect(request.headers[HEADER_OUTPOST_ID]).eql(OutpostId);
       expect(request.headers[HEADER_ACCOUNT_ID]).eql(AccountId);
       expect(request.headers["authorization"]).contains(
@@ -90,17 +89,17 @@ describe("S3Control Client", () => {
       );
     });
 
-    // TODO(endpointsv2)
-    it.skip("should populate correct endpoint and signing region if Access Point name is ARN", async () => {
+    it("should populate correct endpoint and signing region if Access Point name is ARN", async () => {
       const {
         // @ts-ignore request is set in $metadata by interception middleware.
         $metadata: { request },
-      } = await s3Control.getAccessPoint({ Name: accesspointArn });
+      } = await s3Control.getAccessPoint({ Name: accesspointArn, AccountId });
+
       expect(request.hostname).eql(`s3-outposts.${region}.amazonaws.com`);
       expect(request.headers[HEADER_OUTPOST_ID]).eql(OutpostId);
       expect(request.headers[HEADER_ACCOUNT_ID]).eql(AccountId);
       expect(request.headers["authorization"]).contains(
-        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3-outposts/aws4_request`
+        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3/aws4_request`
       );
     });
   });
@@ -121,17 +120,17 @@ describe("S3Control Client", () => {
       );
     });
 
-    // TODO(endpointsv2)
-    it.skip("should populate correct endpoint and signing region if Bucket name is ARN", async () => {
+    it("should populate correct endpoint and signing region if Bucket name is ARN", async () => {
       const {
         // @ts-ignore request is set in $metadata by interception middleware.
         $metadata: { request },
       } = await s3Control.getBucket({ Bucket: bucketArn });
+
       expect(request.hostname).eql(`s3-outposts.${region}.amazonaws.com`);
       expect(request.headers[HEADER_OUTPOST_ID]).eql(OutpostId);
       expect(request.headers[HEADER_ACCOUNT_ID]).eql(AccountId);
       expect(request.headers["authorization"]).contains(
-        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3-outposts/aws4_request`
+        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3/aws4_request`
       );
     });
   });

packages/middleware-endpoint/src/endpointMiddleware.ts

@@ -44,7 +44,7 @@ export const endpointMiddleware = <T extends EndpointParameters>({
       context.endpointV2 = endpoint;
       context.authSchemes = endpoint.properties?.authSchemes;
 
-      const authScheme: AuthScheme = context.authSchemes?.[0];
+      const authScheme: AuthScheme | undefined = context.authSchemes?.[0];
       if (authScheme) {
         context["signing_region"] = authScheme.signingRegion;
         context["signing_service"] = authScheme.signingName;

packages/middleware-sdk-s3-control/src/process-arnables-plugin/getOutpostEndpoint.ts

@@ -14,6 +14,13 @@ export const getOutpostEndpoint = (
     return hostname;
   }
 
+  const match = hostname.match(REGEX_S3CONTROL_HOSTNAME);
+
+  if (!match) {
+    // outposts hostname was already set by endpoints ruleset.
+    return hostname;
+  }
+
   const [matched, prefix, fips, region] = hostname.match(REGEX_S3CONTROL_HOSTNAME)!;
   // hostname prefix will be ignored even if it is present
   return [

packages/types/src/middleware.ts

@@ -1,3 +1,4 @@
+import { AuthScheme } from "./auth";
 import { EndpointV2 } from "./endpoint";
 import { Logger } from "./logger";
 import { UserAgent } from "./util";
@@ -401,6 +402,11 @@ export interface HandlerExecutionContext {
    */
   endpointV2?: EndpointV2;
 
+  /**
+   * Set at the same time as endpointV2.
+   */
+  authSchemes?: AuthScheme[];
+
   [key: string]: any;
 }
 

tests/endpoints-2.0/endpoints-integration.spec.ts

@@ -73,6 +73,14 @@ async function runTestCase(
 ) {
   const { documentation, params = {}, expect: expectation, operationInputs } = testCase;
 
+  for (const key of Object.keys(params)) {
+    // e.g. S3Control::UseArnRegion as a param key indicates
+    // an error with the test case, it will be ignored.
+    if (key.includes(":")) {
+      delete params[key];
+    }
+  }
+
   if (params.UseGlobalEndpoint || params.Region === "aws-global") {
     it.skip(documentation || "undocumented testcase", () => {});
     return;