fix(codegen): generate default endpoint provider for default regional AWS endpoints

Author: kuhe

codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddDefaultAwsEndpointRuleSet.java

@@ -5,7 +5,6 @@
 
 package software.amazon.smithy.aws.typescript.codegen;
 
-import java.util.Collections;
 import java.util.List;
 import software.amazon.smithy.aws.traits.ServiceTrait;
 import software.amazon.smithy.model.Model;
@@ -17,8 +16,6 @@
 import software.amazon.smithy.typescript.codegen.integration.RuntimeClientPlugin;
 import software.amazon.smithy.typescript.codegen.integration.TypeScriptIntegration;
 
-import static software.amazon.smithy.typescript.codegen.integration.RuntimeClientPlugin.Convention.HAS_CONFIG;
-
 
 /**
  * This replaces behavior from {@link EndpointGenerator}.
@@ -37,25 +34,37 @@ public List<String> runBefore() {
         return List.of(AddDefaultEndpointRuleSet.class.getCanonicalName());
     }
 
+    /**
+     * Inserts this resolver after the `resolveEndpointConfig` function.
+     */
     @Override
-    public List<RuntimeClientPlugin> getClientPlugins() {
-        if (usesDefaultAwsRegionalEndpoints) {
-            /*
-            This resolver supports the behavior of endpoints.json-based endpoint provider
-            for default regional services: it makes client.config.endpoint optional on the input side,
-            but guaranteed on the resolved side.
-             */
-            return List.of(
-                RuntimeClientPlugin.builder()
-                    .withConventions(
-                        AwsDependency.UTIL_ENDPOINTS.dependency,
-                        "DefaultAwsRegionalEndpoints",
-                        HAS_CONFIG
-                    )
-                    .build()
-            );
+    public void mutateClientPlugins(List<RuntimeClientPlugin> plugins) {
+        if (!usesDefaultAwsRegionalEndpoints) {
+            return;
         }
-        return Collections.emptyList();
+
+        /*
+        This resolver supports the behavior of endpoints.json-based endpoint provider
+        for default regional services: it makes client.config.endpoint optional on the input side,
+        but guaranteed on the resolved side.
+        */
+        RuntimeClientPlugin defaultAwsRegionalEndpoints = RuntimeClientPlugin.builder()
+            .withConventions(
+                AwsDependency.UTIL_ENDPOINTS.dependency,
+                "DefaultAwsRegionalEndpoints",
+                RuntimeClientPlugin.Convention.HAS_CONFIG
+            )
+            .build();
+
+        RuntimeClientPlugin endpointPlugin = plugins.stream()
+            .filter(p -> p.getResolveFunction()
+                .map(r -> r.getAlias().equals("resolveEndpointConfig"))
+                .orElse(false))
+            .findAny()
+            .orElseThrow(() -> new IllegalStateException("Expected resolveEndpointConfig function in plugins."));
+
+        int index = plugins.indexOf(endpointPlugin);
+        plugins.add(index + 1, defaultAwsRegionalEndpoints);
     }
 
     @Override

packages/util-endpoints/src/index.ts

@@ -1,5 +1,6 @@
 export * from "./aws";
 export * from "./lib/aws/partition";
 export * from "./lib/isIpAddress";
+export * from "./resolveDefaultAwsRegionalEndpointsConfig";
 export * from "./resolveEndpoint";
 export * from "./types";

packages/util-endpoints/src/resolveDefaultAwsRegionalEndpointsConfig.ts

@@ -21,17 +21,17 @@ import { parseUrl } from "@smithy/url-parser";
  */
 export type DefaultAwsRegionalEndpointsInputConfig = {
   endpoint?: unknown;
-  endpointProvider: (
-    endpointParams: EndpointParameters | DefaultRegionalEndpointParameters,
-    context?: { logger?: Logger }
-  ) => EndpointV2;
 };
 
 type PreviouslyResolved = {
   logger?: Logger;
   region?: undefined | string | Provider<string | undefined>;
   useFipsEndpoint?: undefined | boolean | Provider<string | boolean>;
   useDualstackEndpoint?: undefined | boolean | Provider<string | boolean>;
+  endpointProvider: (
+    endpointParams: EndpointParameters | DefaultRegionalEndpointParameters,
+    context?: { logger?: Logger }
+  ) => EndpointV2;
 };
 
 /**
@@ -75,13 +75,14 @@ export const resolveDefaultAwsRegionalEndpointsConfig = <T>(
                 : input.useDualstackEndpoint,
             UseFIPS:
               typeof input.useFipsEndpoint === "function" ? await input.useFipsEndpoint() : input.useFipsEndpoint,
+            Endpoint: undefined,
           },
           { logger: input.logger }
         )
       );
     };
   }
-  return input as T & DefaultEndpointResolvedConfig;
+  return input as T & DefaultAwsRegionalEndpointsResolvedConfig;
 };
 
 /**

private/aws-protocoltests-ec2-schema/src/EC2ProtocolClient.ts

@@ -13,6 +13,11 @@ import {
   UserAgentInputConfig,
   UserAgentResolvedConfig,
 } from "@aws-sdk/middleware-user-agent";
+import {
+  DefaultAwsRegionalEndpointsInputConfig,
+  DefaultAwsRegionalEndpointsResolvedConfig,
+  resolveDefaultAwsRegionalEndpointsConfig,
+} from "@aws-sdk/util-endpoints";
 import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@smithy/config-resolver";
 import {
   DefaultIdentityProviderConfig,
@@ -350,6 +355,7 @@ export type EC2ProtocolClientConfigType = Partial<__SmithyConfiguration<__HttpHa
   RegionInputConfig &
   HostHeaderInputConfig &
   EndpointInputConfig<EndpointParameters> &
+  DefaultAwsRegionalEndpointsInputConfig &
   HttpAuthSchemeInputConfig &
   CompressionInputConfig &
   ClientInputEndpointParameters;
@@ -371,6 +377,7 @@ export type EC2ProtocolClientResolvedConfigType = __SmithyResolvedConfiguration<
   RegionResolvedConfig &
   HostHeaderResolvedConfig &
   EndpointResolvedConfig<EndpointParameters> &
+  DefaultAwsRegionalEndpointsResolvedConfig &
   HttpAuthSchemeResolvedConfig &
   CompressionResolvedConfig &
   ClientResolvedEndpointParameters;
@@ -406,10 +413,11 @@ export class EC2ProtocolClient extends __Client<
     const _config_4 = resolveRegionConfig(_config_3);
     const _config_5 = resolveHostHeaderConfig(_config_4);
     const _config_6 = resolveEndpointConfig(_config_5);
-    const _config_7 = resolveHttpAuthSchemeConfig(_config_6);
-    const _config_8 = resolveCompressionConfig(_config_7);
-    const _config_9 = resolveRuntimeExtensions(_config_8, configuration?.extensions || []);
-    this.config = _config_9;
+    const _config_7 = resolveDefaultAwsRegionalEndpointsConfig(_config_6);
+    const _config_8 = resolveHttpAuthSchemeConfig(_config_7);
+    const _config_9 = resolveCompressionConfig(_config_8);
+    const _config_10 = resolveRuntimeExtensions(_config_9, configuration?.extensions || []);
+    this.config = _config_10;
     this.middlewareStack.use(getSchemaSerdePlugin(this.config));
     this.middlewareStack.use(getUserAgentPlugin(this.config));
     this.middlewareStack.use(getRetryPlugin(this.config));

private/aws-protocoltests-ec2/src/EC2ProtocolClient.ts

@@ -13,6 +13,11 @@ import {
   UserAgentInputConfig,
   UserAgentResolvedConfig,
 } from "@aws-sdk/middleware-user-agent";
+import {
+  DefaultAwsRegionalEndpointsInputConfig,
+  DefaultAwsRegionalEndpointsResolvedConfig,
+  resolveDefaultAwsRegionalEndpointsConfig,
+} from "@aws-sdk/util-endpoints";
 import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@smithy/config-resolver";
 import {
   DefaultIdentityProviderConfig,
@@ -26,7 +31,7 @@ import {
 } from "@smithy/middleware-compression";
 import { getContentLengthPlugin } from "@smithy/middleware-content-length";
 import { EndpointInputConfig, EndpointResolvedConfig, resolveEndpointConfig } from "@smithy/middleware-endpoint";
-import { getRetryPlugin, resolveRetryConfig, RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry";
+import { getRetryPlugin, RetryInputConfig, RetryResolvedConfig, resolveRetryConfig } from "@smithy/middleware-retry";
 import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol-http";
 import {
   Client as __Client,
@@ -35,7 +40,6 @@ import {
   SmithyResolvedConfiguration as __SmithyResolvedConfiguration,
 } from "@smithy/smithy-client";
 import {
-  AwsCredentialIdentityProvider,
   BodyLengthCalculator as __BodyLengthCalculator,
   CheckOptionalClientConfig as __CheckOptionalClientConfig,
   ChecksumConstructor as __ChecksumConstructor,
@@ -46,10 +50,11 @@ import {
   HttpHandlerOptions as __HttpHandlerOptions,
   Logger as __Logger,
   Provider as __Provider,
-  Provider,
   StreamCollector as __StreamCollector,
   UrlParser as __UrlParser,
   UserAgent as __UserAgent,
+  AwsCredentialIdentityProvider,
+  Provider,
 } from "@smithy/types";
 
 import {
@@ -111,7 +116,7 @@ import {
   resolveClientEndpointParameters,
 } from "./endpoint/EndpointParameters";
 import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig";
-import { resolveRuntimeExtensions, RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
+import { RuntimeExtension, RuntimeExtensionsConfig, resolveRuntimeExtensions } from "./runtimeExtensions";
 
 export { __Client };
 
@@ -336,6 +341,7 @@ export type EC2ProtocolClientConfigType = Partial<__SmithyConfiguration<__HttpHa
   RegionInputConfig &
   HostHeaderInputConfig &
   EndpointInputConfig<EndpointParameters> &
+  DefaultAwsRegionalEndpointsInputConfig &
   HttpAuthSchemeInputConfig &
   CompressionInputConfig &
   ClientInputEndpointParameters;
@@ -357,6 +363,7 @@ export type EC2ProtocolClientResolvedConfigType = __SmithyResolvedConfiguration<
   RegionResolvedConfig &
   HostHeaderResolvedConfig &
   EndpointResolvedConfig<EndpointParameters> &
+  DefaultAwsRegionalEndpointsResolvedConfig &
   HttpAuthSchemeResolvedConfig &
   CompressionResolvedConfig &
   ClientResolvedEndpointParameters;
@@ -392,10 +399,11 @@ export class EC2ProtocolClient extends __Client<
     const _config_4 = resolveRegionConfig(_config_3);
     const _config_5 = resolveHostHeaderConfig(_config_4);
     const _config_6 = resolveEndpointConfig(_config_5);
-    const _config_7 = resolveHttpAuthSchemeConfig(_config_6);
-    const _config_8 = resolveCompressionConfig(_config_7);
-    const _config_9 = resolveRuntimeExtensions(_config_8, configuration?.extensions || []);
-    this.config = _config_9;
+    const _config_7 = resolveDefaultAwsRegionalEndpointsConfig(_config_6);
+    const _config_8 = resolveHttpAuthSchemeConfig(_config_7);
+    const _config_9 = resolveCompressionConfig(_config_8);
+    const _config_10 = resolveRuntimeExtensions(_config_9, configuration?.extensions || []);
+    this.config = _config_10;
     this.middlewareStack.use(getUserAgentPlugin(this.config));
     this.middlewareStack.use(getRetryPlugin(this.config));
     this.middlewareStack.use(getContentLengthPlugin(this.config));

private/aws-protocoltests-json-10-schema/src/JSONRPC10Client.ts

@@ -13,6 +13,11 @@ import {
   UserAgentInputConfig,
   UserAgentResolvedConfig,
 } from "@aws-sdk/middleware-user-agent";
+import {
+  DefaultAwsRegionalEndpointsInputConfig,
+  DefaultAwsRegionalEndpointsResolvedConfig,
+  resolveDefaultAwsRegionalEndpointsConfig,
+} from "@aws-sdk/util-endpoints";
 import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@smithy/config-resolver";
 import {
   DefaultIdentityProviderConfig,
@@ -335,6 +340,7 @@ export type JSONRPC10ClientConfigType = Partial<__SmithyConfiguration<__HttpHand
   RegionInputConfig &
   HostHeaderInputConfig &
   EndpointInputConfig<EndpointParameters> &
+  DefaultAwsRegionalEndpointsInputConfig &
   HttpAuthSchemeInputConfig &
   CompressionInputConfig &
   ClientInputEndpointParameters;
@@ -356,6 +362,7 @@ export type JSONRPC10ClientResolvedConfigType = __SmithyResolvedConfiguration<__
   RegionResolvedConfig &
   HostHeaderResolvedConfig &
   EndpointResolvedConfig<EndpointParameters> &
+  DefaultAwsRegionalEndpointsResolvedConfig &
   HttpAuthSchemeResolvedConfig &
   CompressionResolvedConfig &
   ClientResolvedEndpointParameters;
@@ -390,10 +397,11 @@ export class JSONRPC10Client extends __Client<
     const _config_4 = resolveRegionConfig(_config_3);
     const _config_5 = resolveHostHeaderConfig(_config_4);
     const _config_6 = resolveEndpointConfig(_config_5);
-    const _config_7 = resolveHttpAuthSchemeConfig(_config_6);
-    const _config_8 = resolveCompressionConfig(_config_7);
-    const _config_9 = resolveRuntimeExtensions(_config_8, configuration?.extensions || []);
-    this.config = _config_9;
+    const _config_7 = resolveDefaultAwsRegionalEndpointsConfig(_config_6);
+    const _config_8 = resolveHttpAuthSchemeConfig(_config_7);
+    const _config_9 = resolveCompressionConfig(_config_8);
+    const _config_10 = resolveRuntimeExtensions(_config_9, configuration?.extensions || []);
+    this.config = _config_10;
     this.middlewareStack.use(getSchemaSerdePlugin(this.config));
     this.middlewareStack.use(getUserAgentPlugin(this.config));
     this.middlewareStack.use(getRetryPlugin(this.config));

private/aws-protocoltests-json-10/src/JSONRPC10Client.ts

@@ -13,6 +13,11 @@ import {
   UserAgentInputConfig,
   UserAgentResolvedConfig,
 } from "@aws-sdk/middleware-user-agent";
+import {
+  DefaultAwsRegionalEndpointsInputConfig,
+  DefaultAwsRegionalEndpointsResolvedConfig,
+  resolveDefaultAwsRegionalEndpointsConfig,
+} from "@aws-sdk/util-endpoints";
 import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@smithy/config-resolver";
 import {
   DefaultIdentityProviderConfig,
@@ -321,6 +326,7 @@ export type JSONRPC10ClientConfigType = Partial<__SmithyConfiguration<__HttpHand
   RegionInputConfig &
   HostHeaderInputConfig &
   EndpointInputConfig<EndpointParameters> &
+  DefaultAwsRegionalEndpointsInputConfig &
   HttpAuthSchemeInputConfig &
   CompressionInputConfig &
   ClientInputEndpointParameters;
@@ -342,6 +348,7 @@ export type JSONRPC10ClientResolvedConfigType = __SmithyResolvedConfiguration<__
   RegionResolvedConfig &
   HostHeaderResolvedConfig &
   EndpointResolvedConfig<EndpointParameters> &
+  DefaultAwsRegionalEndpointsResolvedConfig &
   HttpAuthSchemeResolvedConfig &
   CompressionResolvedConfig &
   ClientResolvedEndpointParameters;
@@ -376,10 +383,11 @@ export class JSONRPC10Client extends __Client<
     const _config_4 = resolveRegionConfig(_config_3);
     const _config_5 = resolveHostHeaderConfig(_config_4);
     const _config_6 = resolveEndpointConfig(_config_5);
-    const _config_7 = resolveHttpAuthSchemeConfig(_config_6);
-    const _config_8 = resolveCompressionConfig(_config_7);
-    const _config_9 = resolveRuntimeExtensions(_config_8, configuration?.extensions || []);
-    this.config = _config_9;
+    const _config_7 = resolveDefaultAwsRegionalEndpointsConfig(_config_6);
+    const _config_8 = resolveHttpAuthSchemeConfig(_config_7);
+    const _config_9 = resolveCompressionConfig(_config_8);
+    const _config_10 = resolveRuntimeExtensions(_config_9, configuration?.extensions || []);
+    this.config = _config_10;
     this.middlewareStack.use(getUserAgentPlugin(this.config));
     this.middlewareStack.use(getRetryPlugin(this.config));
     this.middlewareStack.use(getContentLengthPlugin(this.config));

private/aws-protocoltests-json-machinelearning/src/MachineLearningClient.ts

@@ -13,6 +13,11 @@ import {
   UserAgentInputConfig,
   UserAgentResolvedConfig,
 } from "@aws-sdk/middleware-user-agent";
+import {
+  DefaultAwsRegionalEndpointsInputConfig,
+  DefaultAwsRegionalEndpointsResolvedConfig,
+  resolveDefaultAwsRegionalEndpointsConfig,
+} from "@aws-sdk/util-endpoints";
 import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@smithy/config-resolver";
 import {
   DefaultIdentityProviderConfig,
@@ -236,6 +241,7 @@ export type MachineLearningClientConfigType = Partial<__SmithyConfiguration<__Ht
   RegionInputConfig &
   HostHeaderInputConfig &
   EndpointInputConfig<EndpointParameters> &
+  DefaultAwsRegionalEndpointsInputConfig &
   HttpAuthSchemeInputConfig &
   ClientInputEndpointParameters;
 /**
@@ -256,6 +262,7 @@ export type MachineLearningClientResolvedConfigType = __SmithyResolvedConfigurat
   RegionResolvedConfig &
   HostHeaderResolvedConfig &
   EndpointResolvedConfig<EndpointParameters> &
+  DefaultAwsRegionalEndpointsResolvedConfig &
   HttpAuthSchemeResolvedConfig &
   ClientResolvedEndpointParameters;
 /**
@@ -289,9 +296,10 @@ export class MachineLearningClient extends __Client<
     const _config_4 = resolveRegionConfig(_config_3);
     const _config_5 = resolveHostHeaderConfig(_config_4);
     const _config_6 = resolveEndpointConfig(_config_5);
-    const _config_7 = resolveHttpAuthSchemeConfig(_config_6);
-    const _config_8 = resolveRuntimeExtensions(_config_7, configuration?.extensions || []);
-    this.config = _config_8;
+    const _config_7 = resolveDefaultAwsRegionalEndpointsConfig(_config_6);
+    const _config_8 = resolveHttpAuthSchemeConfig(_config_7);
+    const _config_9 = resolveRuntimeExtensions(_config_8, configuration?.extensions || []);
+    this.config = _config_9;
     this.middlewareStack.use(getUserAgentPlugin(this.config));
     this.middlewareStack.use(getRetryPlugin(this.config));
     this.middlewareStack.use(getContentLengthPlugin(this.config));