fix(client-s3): defer endpoint validations to ruleset

kuhe · kuhe · commit 4e0933e03df8 · 2025-06-12T16:46:29.000-04:00
diff --git a/Makefile b/Makefile
@@ -41,7 +41,7 @@ test-integration: bundles
 	make test-endpoints
 
 test-endpoints:
-	npx jest -c ./tests/endpoints-2.0/jest.config.js --bail --watch --verbose false
+	npx jest -c ./tests/endpoints-2.0/jest.config.js --bail --verbose false
 
 test-e2e: bundles
 	yarn g:vitest run -c vitest.config.e2e.ts --retry=4
diff --git a/clients/client-s3-control/src/endpoint/EndpointParameters.ts b/clients/client-s3-control/src/endpoint/EndpointParameters.ts
@@ -5,11 +5,11 @@ import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provi
  * @public
  */
 export interface ClientInputEndpointParameters {
-  region?: string | Provider<string>;
-  useFipsEndpoint?: boolean | Provider<boolean>;
-  useDualstackEndpoint?: boolean | Provider<boolean>;
+  region?: string | undefined | Provider<string | undefined>;
+  useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
+  useDualstackEndpoint?: boolean | undefined | Provider<boolean | undefined>;
   endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
-  useArnRegion?: boolean | Provider<boolean>;
+  useArnRegion?: boolean | undefined | Provider<boolean | undefined>;
 }
 
 export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
@@ -35,15 +35,15 @@ export const commonParams = {
 } as const;
 
 export interface EndpointParameters extends __EndpointParameters {
-  Region?: string;
-  UseFIPS?: boolean;
-  UseDualStack?: boolean;
-  Endpoint?: string;
-  AccountId?: string;
-  RequiresAccountId?: boolean;
-  OutpostId?: string;
-  Bucket?: string;
-  AccessPointName?: string;
-  UseArnRegion?: boolean;
-  UseS3ExpressControlEndpoint?: boolean;
+  Region?: string | undefined;
+  UseFIPS?: boolean | undefined;
+  UseDualStack?: boolean | undefined;
+  Endpoint?: string | undefined;
+  AccountId?: string | undefined;
+  RequiresAccountId?: boolean | undefined;
+  OutpostId?: string | undefined;
+  Bucket?: string | undefined;
+  AccessPointName?: string | undefined;
+  UseArnRegion?: boolean | undefined;
+  UseS3ExpressControlEndpoint?: boolean | undefined;
 }
diff --git a/clients/client-s3-control/src/models/models_1.ts b/clients/client-s3-control/src/models/models_1.ts
@@ -19,7 +19,6 @@ import {
   StorageLensTag,
   Tag,
 } from "./models_0";
-
 import { S3ControlServiceException as __BaseException } from "./S3ControlServiceException";
 
 /**
diff --git a/clients/client-s3/src/S3Client.ts b/clients/client-s3/src/S3Client.ts
@@ -755,9 +755,9 @@ export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHand
   signingEscapePath?: boolean;
 
   /**
-   * Whether to override the request region with the region inferred from requested resource's ARN. Defaults to false.
+   * Whether to override the request region with the region inferred from requested resource's ARN. Defaults to undefined.
    */
-  useArnRegion?: boolean | Provider<boolean>;
+  useArnRegion?: boolean | undefined | Provider<boolean | undefined>;
   /**
    * The internal function that inject utilities to runtime-specific stream to help users consume the data
    * @internal
diff --git a/clients/client-s3/src/endpoint/EndpointParameters.ts b/clients/client-s3/src/endpoint/EndpointParameters.ts
@@ -5,16 +5,16 @@ import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provi
  * @public
  */
 export interface ClientInputEndpointParameters {
-  region?: string | Provider<string>;
-  useFipsEndpoint?: boolean | Provider<boolean>;
-  useDualstackEndpoint?: boolean | Provider<boolean>;
+  region?: string | undefined | Provider<string | undefined>;
+  useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
+  useDualstackEndpoint?: boolean | undefined | Provider<boolean | undefined>;
   endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
-  forcePathStyle?: boolean | Provider<boolean>;
-  useAccelerateEndpoint?: boolean | Provider<boolean>;
-  useGlobalEndpoint?: boolean | Provider<boolean>;
-  disableMultiregionAccessPoints?: boolean | Provider<boolean>;
-  useArnRegion?: boolean | Provider<boolean>;
-  disableS3ExpressSessionAuth?: boolean | Provider<boolean>;
+  forcePathStyle?: boolean | undefined | Provider<boolean | undefined>;
+  useAccelerateEndpoint?: boolean | undefined | Provider<boolean | undefined>;
+  useGlobalEndpoint?: boolean | undefined | Provider<boolean | undefined>;
+  disableMultiregionAccessPoints?: boolean | undefined | Provider<boolean | undefined>;
+  useArnRegion?: boolean | undefined | Provider<boolean | undefined>;
+  disableS3ExpressSessionAuth?: boolean | undefined | Provider<boolean | undefined>;
 }
 
 export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
@@ -49,21 +49,21 @@ export const commonParams = {
 } as const;
 
 export interface EndpointParameters extends __EndpointParameters {
-  Bucket?: string;
-  Region?: string;
-  UseFIPS?: boolean;
-  UseDualStack?: boolean;
-  Endpoint?: string;
-  ForcePathStyle?: boolean;
-  Accelerate?: boolean;
-  UseGlobalEndpoint?: boolean;
-  UseObjectLambdaEndpoint?: boolean;
-  Key?: string;
-  Prefix?: string;
-  CopySource?: string;
-  DisableAccessPoints?: boolean;
-  DisableMultiRegionAccessPoints?: boolean;
-  UseArnRegion?: boolean;
-  UseS3ExpressControlEndpoint?: boolean;
-  DisableS3ExpressSessionAuth?: boolean;
+  Bucket?: string | undefined;
+  Region?: string | undefined;
+  UseFIPS?: boolean | undefined;
+  UseDualStack?: boolean | undefined;
+  Endpoint?: string | undefined;
+  ForcePathStyle?: boolean | undefined;
+  Accelerate?: boolean | undefined;
+  UseGlobalEndpoint?: boolean | undefined;
+  UseObjectLambdaEndpoint?: boolean | undefined;
+  Key?: string | undefined;
+  Prefix?: string | undefined;
+  CopySource?: string | undefined;
+  DisableAccessPoints?: boolean | undefined;
+  DisableMultiRegionAccessPoints?: boolean | undefined;
+  UseArnRegion?: boolean | undefined;
+  UseS3ExpressControlEndpoint?: boolean | undefined;
+  DisableS3ExpressSessionAuth?: boolean | undefined;
 }
diff --git a/clients/client-s3/src/models/models_0.ts b/clients/client-s3/src/models/models_0.ts
@@ -1,6 +1,5 @@
 // smithy-typescript generated code
 import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client";
-
 import { StreamingBlobTypes } from "@smithy/types";
 
 import { S3ServiceException as __BaseException } from "./S3ServiceException";
diff --git a/clients/client-s3/src/models/models_1.ts b/clients/client-s3/src/models/models_1.ts
@@ -1,6 +1,5 @@
 // smithy-typescript generated code
 import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client";
-
 import { StreamingBlobTypes } from "@smithy/types";
 
 import {
@@ -41,7 +40,6 @@ import {
   Tag,
   TransitionDefaultMinimumObjectSize,
 } from "./models_0";
-
 import { S3ServiceException as __BaseException } from "./S3ServiceException";
 
 /**
diff --git a/clients/client-s3/src/runtimeConfig.shared.ts b/clients/client-s3/src/runtimeConfig.shared.ts
@@ -43,7 +43,7 @@ export const getRuntimeConfig = (config: S3ClientConfig) => {
     signerConstructor: config?.signerConstructor ?? SignatureV4MultiRegion,
     signingEscapePath: config?.signingEscapePath ?? false,
     urlParser: config?.urlParser ?? parseUrl,
-    useArnRegion: config?.useArnRegion ?? false,
+    useArnRegion: config?.useArnRegion ?? undefined,
     utf8Decoder: config?.utf8Decoder ?? fromUtf8,
     utf8Encoder: config?.utf8Encoder ?? toUtf8,
   };
diff --git a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddS3Config.java b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddS3Config.java
@@ -33,6 +33,7 @@
 import software.amazon.smithy.model.Model;
 import software.amazon.smithy.model.knowledge.OperationIndex;
 import software.amazon.smithy.model.knowledge.TopDownIndex;
+import software.amazon.smithy.model.pattern.SmithyPattern;
 import software.amazon.smithy.model.shapes.MemberShape;
 import software.amazon.smithy.model.shapes.OperationShape;
 import software.amazon.smithy.model.shapes.ServiceShape;
@@ -47,6 +48,7 @@
 import software.amazon.smithy.model.traits.HttpHeaderTrait;
 import software.amazon.smithy.model.traits.HttpPayloadTrait;
 import software.amazon.smithy.model.traits.StreamingTrait;
+import software.amazon.smithy.model.traits.Trait;
 import software.amazon.smithy.model.transform.ModelTransformer;
 import software.amazon.smithy.rulesengine.traits.EndpointRuleSetTrait;
 import software.amazon.smithy.typescript.codegen.LanguageTarget;
@@ -89,7 +91,23 @@ public final class AddS3Config implements TypeScriptIntegration {
     public static Shape removeHostPrefixTrait(Shape shape) {
         return shape.asOperationShape()
             .map(OperationShape::shapeToBuilder)
-            .map(builder -> ((OperationShape.Builder) builder).removeTrait(EndpointTrait.ID))
+            .map((Object object) -> {
+                OperationShape.Builder builder = (OperationShape.Builder) object;
+                Trait trait = builder.getAllTraits().get(EndpointTrait.ID);
+                if (trait instanceof EndpointTrait endpointTrait) {
+                    if (
+                        endpointTrait.getHostPrefix().equals(
+                            SmithyPattern.builder()
+                                .segments(List.of())
+                                .pattern("{AccountId}.")
+                                .build()
+                        )
+                    ) {
+                        builder.removeTrait(EndpointTrait.ID);
+                    }
+                }
+                return builder;
+            })
             .map(OperationShape.Builder::build)
             .map(s -> (Shape) s)
             .orElse(shape);
@@ -224,7 +242,7 @@ public Model preprocessModel(Model model, TypeScriptSettings settings) {
 
         Model builtModel = modelBuilder.addShapes(inputShapes).build();
         if (hasRuleset) {
-            ModelTransformer.create().mapShapes(
+            return ModelTransformer.create().mapShapes(
                 builtModel, AddS3Config::removeHostPrefixTrait
             );
         }
@@ -246,9 +264,9 @@ public void addConfigInterfaceFields(
             .write("signingEscapePath?: boolean;\n");
         writer.writeDocs(
                 "Whether to override the request region with the region inferred from requested resource's ARN."
-                    + " Defaults to false.")
+                    + " Defaults to undefined.")
             .addImport("Provider", "Provider", TypeScriptDependency.SMITHY_TYPES)
-            .write("useArnRegion?: boolean | Provider<boolean>;");
+            .write("useArnRegion?: boolean | undefined | Provider<boolean | undefined>;");
     }
 
     @Override
@@ -266,7 +284,7 @@ public Map<String, Consumer<TypeScriptWriter>> getRuntimeConfigWriters(
                         writer.write("false");
                     },
                     "useArnRegion", writer -> {
-                        writer.write("false");
+                        writer.write("undefined");
                     }
                 );
             case NODE:
diff --git a/packages/middleware-bucket-endpoint/src/NodeUseArnRegionConfigOptions.spec.ts b/packages/middleware-bucket-endpoint/src/NodeUseArnRegionConfigOptions.spec.ts
@@ -44,8 +44,8 @@ describe("NODE_USE_ARN_REGION_CONFIG_OPTIONS", () => {
     test(configFileSelector, profileContent, NODE_USE_ARN_REGION_INI_NAME, SelectorType.CONFIG);
   });
 
-  it("returns false for default", () => {
+  it("returns undefined for default", () => {
     const { default: defaultValue } = NODE_USE_ARN_REGION_CONFIG_OPTIONS;
-    expect(defaultValue).toEqual(false);
+    expect(defaultValue).toEqual(undefined);
   });
 });
diff --git a/packages/middleware-bucket-endpoint/src/NodeUseArnRegionConfigOptions.ts b/packages/middleware-bucket-endpoint/src/NodeUseArnRegionConfigOptions.ts
@@ -7,11 +7,15 @@ export const NODE_USE_ARN_REGION_INI_NAME = "s3_use_arn_region";
 /**
  * Config to load useArnRegion from environment variables and shared INI files
  *
- * @api private
+ * @internal
  */
-export const NODE_USE_ARN_REGION_CONFIG_OPTIONS: LoadedConfigSelectors<boolean> = {
+export const NODE_USE_ARN_REGION_CONFIG_OPTIONS: LoadedConfigSelectors<boolean | undefined> = {
   environmentVariableSelector: (env: NodeJS.ProcessEnv) =>
     booleanSelector(env, NODE_USE_ARN_REGION_ENV_NAME, SelectorType.ENV),
   configFileSelector: (profile) => booleanSelector(profile, NODE_USE_ARN_REGION_INI_NAME, SelectorType.CONFIG),
-  default: false,
+  /**
+   * useArnRegion has specific behavior when undefined instead of false.
+   * We therefore use undefined as the default value instead of false.
+   */
+  default: undefined,
 };
diff --git a/packages/middleware-bucket-endpoint/src/bucketEndpointMiddleware.spec.ts b/packages/middleware-bucket-endpoint/src/bucketEndpointMiddleware.spec.ts
@@ -19,7 +19,10 @@ import { parse, validate } from "@aws-sdk/util-arn-parser";
 import { bucketEndpointMiddleware } from "./bucketEndpointMiddleware";
 import { bucketHostname } from "./bucketHostname";
 
-describe("bucketEndpointMiddleware", () => {
+/**
+ * @deprecated unused as of EndpointsV2.
+ */
+describe.skip("bucketEndpointMiddleware", () => {
   const input = { Bucket: "bucket" };
   const mockRegion = "us-foo-1";
   const requestInput = {
diff --git a/packages/middleware-bucket-endpoint/src/bucketEndpointMiddleware.ts b/packages/middleware-bucket-endpoint/src/bucketEndpointMiddleware.ts
@@ -14,6 +14,10 @@ import {
 import { bucketHostname } from "./bucketHostname";
 import { BucketEndpointResolvedConfig } from "./configurations";
 
+/**
+ * @deprecated unused as of EndpointsV2.
+ * @internal
+ */
 export const bucketEndpointMiddleware =
   (options: BucketEndpointResolvedConfig): BuildMiddleware<any, any> =>
   <Output extends MetadataBearer>(
@@ -98,6 +102,10 @@ export const bucketEndpointMiddleware =
     return next({ ...args, request });
   };
 
+/**
+ * @deprecated unused as of EndpointsV2.
+ * @internal
+ */
 export const bucketEndpointMiddlewareOptions: RelativeMiddlewareOptions = {
   tags: ["BUCKET_ENDPOINT"],
   name: "bucketEndpointMiddleware",
@@ -106,6 +114,10 @@ export const bucketEndpointMiddlewareOptions: RelativeMiddlewareOptions = {
   override: true,
 };
 
+/**
+ * @deprecated unused as of EndpointsV2.
+ * @internal
+ */
 export const getBucketEndpointPlugin = (options: BucketEndpointResolvedConfig): Pluggable<any, any> => ({
   applyToStack: (clientStack) => {
     clientStack.addRelativeTo(bucketEndpointMiddleware(options), bucketEndpointMiddlewareOptions);
diff --git a/packages/middleware-bucket-endpoint/src/bucketHostname.spec.ts b/packages/middleware-bucket-endpoint/src/bucketHostname.spec.ts
@@ -3,7 +3,10 @@ import { describe, expect, test as it } from "vitest";
 
 import { bucketHostname } from "./bucketHostname";
 
-describe("bucketHostname", () => {
+/**
+ * @deprecated unused as of EndpointsV2.
+ */
+describe.skip("bucketHostname", () => {
   const region = "us-west-2";
   describe("from bucket name", () => {
     [
diff --git a/packages/middleware-bucket-endpoint/src/bucketHostname.ts b/packages/middleware-bucket-endpoint/src/bucketHostname.ts
diff --git a/packages/middleware-bucket-endpoint/src/bucketHostnameUtils.ts b/packages/middleware-bucket-endpoint/src/bucketHostnameUtils.ts
diff --git a/packages/middleware-bucket-endpoint/src/configurations.ts b/packages/middleware-bucket-endpoint/src/configurations.ts
diff --git a/packages/middleware-sdk-s3-control/src/configurations.ts b/packages/middleware-sdk-s3-control/src/configurations.ts
diff --git a/packages/middleware-sdk-s3-control/src/middleware-sdk-s3-control.integ.spec.ts b/packages/middleware-sdk-s3-control/src/middleware-sdk-s3-control.integ.spec.ts
diff --git a/packages/middleware-sdk-s3-control/src/process-arnables-plugin/parse-outpost-arnables.ts b/packages/middleware-sdk-s3-control/src/process-arnables-plugin/parse-outpost-arnables.ts
diff --git a/tests/endpoints-2.0/endpoints-integration.spec.ts b/tests/endpoints-2.0/endpoints-integration.spec.ts
