fix: handle clientContextParam collisions with builtin config keys #1788

smilkuri · 2025-11-24T16:07:30Z

Issue #, if available:

#1779
codegen v3: aws/aws-sdk-js-v3#7527

Description of changes:

--

packages/middleware-endpoint/src/adaptors/getEndpointFromInstructions.ts

packages/middleware-endpoint/src/adaptors/createConfigValueProvider.ts

...est/java/software/amazon/smithy/typescript/codegen/endpointsV2/EndpointsV2GeneratorTest.java

.changeset/stale-phones-behave.md

...rc/main/java/software/amazon/smithy/typescript/codegen/endpointsV2/EndpointsV2Generator.java

kuhe · 2025-12-01T21:01:35Z

...rc/main/java/software/amazon/smithy/typescript/codegen/endpointsV2/EndpointsV2Generator.java

+                Map<String, String> builtInParams = ruleSetParameterFinder.getBuiltInParams();
+                builtInParams.keySet().removeIf(OmitEndpointParams::isOmitted);
+                Set<String> knownConfigKeys = Set.of(
+                    "apiKey", "retryStrategy", "requestHandler");


make this static final on the class

on second thought this should be handled by a separate class.

seed the class with the config keys seen in https://github.com/aws/aws-sdk-js-v3/blob/f806a2b9eded9f82d488f3d81db36b9cba9da220/private/aws-client-api-test/src/client-interface-tests/client-s3/impl/initializeWithMaximalConfiguration.ts except those specific to S3, then create a public Java static method to add keys to the list.

private/my-local-model-schema/src/endpoint/EndpointParameters.ts

kuhe · 2025-12-02T16:36:54Z

packages/middleware-endpoint/src/adaptors/createConfigValueProvider.ts

+      const nestedValue: unknown = clientContextParams?.[configKey] ?? clientContextParams?.[canonicalEndpointParamKey];
+      configValue = nestedValue ?? config[configKey] ?? config[canonicalEndpointParamKey];
+    } else {
+      // For built-in parameters, only check direct config properties


not just for built-ins, for anything other than client context params

kuhe · 2025-12-02T16:38:09Z

packages/middleware-endpoint/src/adaptors/createConfigValueProvider.ts

+    if (isClientContextParam) {
+      // For client context parameters, check clientContextParams first
+      const clientContextParams = config.clientContextParams as Record<string, unknown> | undefined;
+      const nestedValue: unknown = clientContextParams?.[configKey] ?? clientContextParams?.[canonicalEndpointParamKey];


is there any case where the nested object does not use the canonical parameter key?

If not, there's no reason to check the configKey entry for the nested object.

I don't think so

kuhe · 2025-12-02T16:42:24Z

packages/middleware-endpoint/src/adaptors/getEndpointFromInstructions.ts

+        break;
      case "builtInParams":
-        endpointParams[name] = await createConfigValueProvider<Config>(instruction.name, name, clientConfig)();
+        endpointParams[name] = await createConfigValueProvider<Config>(instruction.name, name, clientConfig, false)();


case "clientContextParams": case "builtInParams": endpointParams[name] = await createConfigValueProvider<Config>( instruction.name, name, clientConfig, instruction.type !== "builtInParams" )();

kuhe · 2025-12-02T16:46:06Z

private/my-local-model/src/endpoint/EndpointParameters.ts

  options: T & ClientInputEndpointParameters
 ): T & ClientResolvedEndpointParameters => {
  return Object.assign(options, {
+    apiKey: options.apiKey ?? "default-api-key",


This is the main point of the fix, but this shouldn't appear here, since it will conflict with the same key potentially be added by the api key auth scheme.

This is generated because the parameter has a default value set defined in @endpointRuleSet. If a default value is not defined it doesn't generate this.

kuhe · 2025-12-02T16:47:02Z

private/my-local-model/src/endpoint/ruleset.ts

+      type: "String",
+      required: true,
+      default: "default-custom-value",
+      documentation: "Custom parameter for testing",


add a few more client context params like boolean and I believe there is one more type which is string[], right?

add a conflicting and non-conflicting param for each type

and add some that don't have default values (or are they required?)

kuhe · 2025-12-02T17:11:16Z

...rc/main/java/software/amazon/smithy/typescript/codegen/endpointsV2/EndpointsV2Generator.java

                    "};",
                    () -> {
                        writer.write("defaultSigningName: string;");
+                        if (!customContextParams.isEmpty()) {


Suggested change

if (!customContextParams.isEmpty()) {

if (ruleSetParameterFinder.hasCustomClientContextParams()) {

kuhe · 2025-12-02T17:13:38Z

...rc/main/java/software/amazon/smithy/typescript/codegen/endpointsV2/EndpointsV2Generator.java

+                                parameters.accept(new RuleSetParametersVisitor(
+                                    writer, customContextParams, true));
+                            });
+                            writer.dedent();


writer.indent(); ruleSetParameterFinder.writeResolvedConfigCustomClientContextParams(writer); writer.dedent();

kuhe · 2025-12-02T17:14:50Z

...rc/main/java/software/amazon/smithy/typescript/codegen/endpointsV2/EndpointsV2Generator.java

                    }
                );
+                // Generate clientContextParamDefaults only if there are customer context params
+                if (!customContextParams.isEmpty()) {


if (ruleSetParameterFinder.hasCustomClientContextParams()) { ruleSetParameterFinder.writeNestedClientContextParamDefaults(writer); }

kuhe · 2025-12-02T17:17:01Z

...rc/main/java/software/amazon/smithy/typescript/codegen/endpointsV2/EndpointsV2Generator.java

                                settings.getDefaultSigningName()
                            );
+                            // Only generate clientContextParams if there are customer context params
+                            if (!customContextParams.isEmpty()) {


ruleSetParameterFinder.writeConfigResolverNestedClientContextParams(writer);

kuhe · 2025-12-02T17:19:17Z

smithy-typescript-protocol-test-codegen/model/my-local-model/main.smithy

 @documentation("xyz interfaces")
+@clientContextParams(
+    apiKey: { type: "string", documentation: "API key for authentication" }
+    customParam: { type: "string", documentation: "Custom parameter" }


going to comment again here since this is the source file and ruleset.ts is generated:

add some more client context params with varying permutations:

conflicting / non-conflicting

string / string[] / boolean

has default + required / no default + optional

smilkuri force-pushed the resolve-conflict-params branch from 4a0b1ea to c0cc0c7 Compare November 26, 2025 16:57

smilkuri mentioned this pull request Nov 26, 2025

chore(codegen): generate corresponding clients for conflict params aws/aws-sdk-js-v3#7527

Draft

smilkuri added 2 commits December 1, 2025 16:13

fix: nest conflicting endpoint parameters

ebb79d0

fix: add fallback resolution

13fd0f0

smilkuri force-pushed the resolve-conflict-params branch from f3ea1fe to 13fd0f0 Compare December 1, 2025 16:16

smilkuri marked this pull request as ready for review December 1, 2025 16:57

smilkuri requested a review from a team as a code owner December 1, 2025 16:57

smilkuri force-pushed the resolve-conflict-params branch from cfaa5d4 to 9117008 Compare December 1, 2025 17:00

chore: fix formatting and add changeset

1fc37f8

smilkuri force-pushed the resolve-conflict-params branch from 9117008 to 1fc37f8 Compare December 1, 2025 17:01

smilkuri changed the title ~~fix: nest conflicting endpoint parameters~~ fix: handle clientContextParam collisions with builtin config keys Dec 1, 2025

kuhe requested changes Dec 1, 2025

View reviewed changes

chore: address comments and add diff for build generate-protocol-tests

c5f0d86

smilkuri force-pushed the resolve-conflict-params branch from ef3cda8 to c5f0d86 Compare December 1, 2025 20:11

fix: add isClientContextParam flag to handle parameter types

3605e29

kuhe reviewed Dec 1, 2025

View reviewed changes

...rc/main/java/software/amazon/smithy/typescript/codegen/endpointsV2/EndpointsV2Generator.java Outdated Show resolved Hide resolved

kuhe reviewed Dec 1, 2025

View reviewed changes

...rc/main/java/software/amazon/smithy/typescript/codegen/endpointsV2/EndpointsV2Generator.java Outdated Show resolved Hide resolved

kuhe reviewed Dec 1, 2025

View reviewed changes

private/my-local-model-schema/src/endpoint/EndpointParameters.ts Show resolved Hide resolved

chore: refactor code and add custom ruleset

815c7a7

kuhe reviewed Dec 2, 2025

View reviewed changes

	if (!customContextParams.isEmpty()) {
	if (ruleSetParameterFinder.hasCustomClientContextParams()) {

fix: handle clientContextParam collisions with builtin config keys #1788

Are you sure you want to change the base?

fix: handle clientContextParam collisions with builtin config keys #1788

Uh oh!

Conversation

smilkuri commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kuhe Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

smilkuri commented Nov 24, 2025 •

edited

Loading

kuhe Dec 2, 2025 •

edited

Loading