fix(endpoint): misc endpoints 2.0 fixes for s3 (#4031)

aws · Oct 12, 2022 · f8926a5 · f8926a5
1 parent f23158a
commit f8926a5
Show file tree

Hide file tree

Showing 9 changed files with 106 additions and 7 deletions.
diff --git a/packages/middleware-endpoint/src/adaptors/getEndpointFromInstructions.ts b/packages/middleware-endpoint/src/adaptors/getEndpointFromInstructions.ts
@@ -77,7 +77,7 @@ export const resolveParams = async <
   }
 
   if (String(clientConfig.serviceId).toLowerCase() === "s3") {
-    resolveParamsForS3(endpointParams);
+    await resolveParamsForS3(endpointParams);
   }
 
   return endpointParams;

diff --git a/packages/middleware-endpoint/src/integration-tests/integration.spec.ts b/packages/middleware-endpoint/src/integration-tests/integration.spec.ts
@@ -3,15 +3,40 @@ import { EndpointV2 } from "@aws-sdk/types";
 
 // import { defaultEndpointResolver } from "../../../../clients/client-s3/src/endpoint/endpointResolver";
 const defaultEndpointResolver = (...args: any): any => {};
-
 import { resolveParams } from "../adaptors";
 import { EndpointExpectation, EndpointTestCase, ErrorExpectation, ServiceNamespace } from "./integration-test-types";
 import customTests from "./s3/custom-tests.json";
+import generatedTests from "./s3/generated-tests.json";
+import o from "./s3/o.json";
+import oa from "./s3/oa.json";
+import ol from "./s3/ol.json";
+import s from "./s3/s.json";
 
 describe("endpoints 2.0 service integration", () => {
   describe("s3", () => {
     it("placeholder", () => {});
-    runTestCases(customTests, S3Namespace as ServiceNamespace);
+
+    if (customTests.testCases?.length) {
+      describe("custom", () => {
+        runTestCases(customTests, S3Namespace as ServiceNamespace);
+      });
+    }
+
+    if (generatedTests.testCases?.length) {
+      describe("generated", () => {
+        runTestCases(generatedTests, S3Namespace as ServiceNamespace);
+      });
+    }
+
+    return; // skipping additional tests for now.
+
+    for (const group of [o, oa, ol, s]) {
+      if (group.testCases?.length) {
+        describe("additional test group", () => {
+          runTestCases(group, S3Namespace as ServiceNamespace);
+        });
+      }
+    }
   });
 });
 
@@ -26,6 +51,15 @@ function runTestCases({ testCases }: { testCases: EndpointTestCase[] }, service:
 async function runTestCase(testCase: EndpointTestCase, service: ServiceNamespace) {
   const { documentation, params = {}, expect: expectation, operationInputs } = testCase;
 
+  if (params.UseGlobalEndpoint || params.Region === "aws-global") {
+    it.skip(documentation || "undocumented testcase", () => {});
+    return;
+  }
+
+  if (service === S3Namespace) {
+    params.serviceId = "s3";
+  }
+
   it(documentation || "undocumented testcase", async () => {
     if (isEndpointExpectation(expectation)) {
       const { endpoint } = expectation;
@@ -54,16 +88,18 @@ async function runTestCase(testCase: EndpointTestCase, service: ServiceNamespace
           const endpointParams = await resolveParams(operationParams, service[`${operationName}Command`], {
             ...params,
             endpointProvider: defaultEndpointResolver,
-          });
+          }).catch(pass);
           const observedError = await (async () => defaultEndpointResolver(endpointParams as any))().catch(pass);
           expect(observedError).not.toBeUndefined();
+          expect(observedError?.url).toBeUndefined();
           // expect(normalizeQuotes(String(observedError))).toContain(normalizeQuotes(error));
         }
       } else {
-        const endpointParams = await resolveParams({}, {}, params);
+        const endpointParams = await resolveParams({}, {}, params).catch(pass);
         const observedError = await (async () => defaultEndpointResolver(endpointParams as any))().catch(pass);
         console.error(observedError);
         expect(observedError).not.toBeUndefined();
+        expect(observedError?.url).toBeUndefined();
         // expect(normalizeQuotes(String(observedError))).toContain(normalizeQuotes(error));
       }
     }

diff --git a/packages/middleware-endpoint/src/integration-tests/s3/generated-tests.json b/packages/middleware-endpoint/src/integration-tests/s3/generated-tests.json
@@ -0,0 +1,4 @@
+{
+  "testCases": [],
+  "version": "1.0"
+}
diff --git a/packages/middleware-endpoint/src/integration-tests/s3/o.json b/packages/middleware-endpoint/src/integration-tests/s3/o.json
@@ -0,0 +1,4 @@
+{
+  "testCases": [],
+  "version": "1.0"
+}
diff --git a/packages/middleware-endpoint/src/integration-tests/s3/oa.json b/packages/middleware-endpoint/src/integration-tests/s3/oa.json
@@ -0,0 +1,4 @@
+{
+  "testCases": [],
+  "version": "1.0"
+}
diff --git a/packages/middleware-endpoint/src/integration-tests/s3/ol.json b/packages/middleware-endpoint/src/integration-tests/s3/ol.json
@@ -0,0 +1,4 @@
+{
+  "testCases": [],
+  "version": "1.0"
+}
diff --git a/packages/middleware-endpoint/src/integration-tests/s3/s.json b/packages/middleware-endpoint/src/integration-tests/s3/s.json
@@ -0,0 +1,4 @@
+{
+  "testCases": [],
+  "version": "1.0"
+}
diff --git a/packages/middleware-endpoint/src/service-customizations/s3.ts b/packages/middleware-endpoint/src/service-customizations/s3.ts
@@ -3,10 +3,29 @@ import { EndpointParameters } from "@aws-sdk/types";
 export const resolveParamsForS3 = async (endpointParams: EndpointParameters) => {
   const bucket = (endpointParams?.Bucket as string) || "";
 
-  if (!isDnsCompatibleBucketName(bucket) || bucket.indexOf(".") !== -1) {
+  if (typeof endpointParams.Bucket === "string") {
+    endpointParams.Bucket = bucket.replace(/#/g, encodeURIComponent("#")).replace(/\?/g, encodeURIComponent("?"));
+  }
+
+  if (isArnBucketName(bucket)) {
+    if (endpointParams.ForcePathStyle === true) {
+      throw new Error("Path-style addressing cannot be used with ARN buckets");
+    }
+  } else if (
+    !isDnsCompatibleBucketName(bucket) ||
+    (bucket.indexOf(".") !== -1 && !String(endpointParams.Endpoint).startsWith("http:")) ||
+    bucket.toLowerCase() !== bucket ||
+    bucket.length < 3
+  ) {
     endpointParams.ForcePathStyle = true;
   }
 
+  if (endpointParams.DisableMultiRegionAccessPoints) {
+    // inconsistent naming
+    endpointParams.disableMultiRegionAccessPoints = true;
+    endpointParams.DisableMRAP = true;
+  }
+
   return endpointParams;
 };
 
@@ -26,3 +45,13 @@ export const S3_HOSTNAME_PATTERN = /^(.+\.)?s3(-fips)?(\.dualstack)?[.-]([a-z0-9
  */
 export const isDnsCompatibleBucketName = (bucketName: string): boolean =>
   DOMAIN_PATTERN.test(bucketName) && !IP_ADDRESS_PATTERN.test(bucketName) && !DOTS_PATTERN.test(bucketName);
+
+export const isArnBucketName = (bucketName: string): boolean => {
+  const [arn, partition, service, region, account, typeOrId] = bucketName.split(":");
+  const isArn = arn === "arn" && bucketName.split(":").length >= 6;
+  const isValidArn = [arn, partition, service, account, typeOrId].filter(Boolean).length === 5;
+  if (isArn && !isValidArn) {
+    throw new Error(`Invalid ARN: ${bucketName} was an invalid ARN.`);
+  }
+  return arn === "arn" && !!partition && !!service && !!account && !!typeOrId;
+};
diff --git a/packages/util-endpoints/src/resolveEndpoint.ts b/packages/util-endpoints/src/resolveEndpoint.ts
@@ -31,5 +31,19 @@ export const resolveEndpoint = (ruleSetObject: RuleSetObject, options: EndpointR
     }
   }
 
-  return evaluateRules(rules, { endpointParams, logger, referenceRecord: {} });
+  const endpoint = evaluateRules(rules, { endpointParams, logger, referenceRecord: {} });
+
+  if (options.endpointParams?.Endpoint) {
+    // take protocol and port from custom Endpoint if present.
+    try {
+      const givenEndpoint = new URL(options.endpointParams.Endpoint as string);
+      const { protocol, port } = givenEndpoint;
+      endpoint.url.protocol = protocol;
+      endpoint.url.port = port;
+    } catch (e) {
+      // ignored
+    }
+  }
+
+  return endpoint;
 };