chore(enum-updater): support adding manual static enum mappings #34441

paulhcsun · 2025-05-13T01:06:47Z

Issue # (if applicable)

Closes #.

Reason for this change

Manual changes to the static-enum-mapping.json would be overwritten the next time the workflow was run.

Description of changes

Add a new file manual-enum-mapping.json that allows maintainers to add manual mappings that will be used over any matching mapping that the script calculates.

Manual mappings should be added in the form:

{
    "serviceName": {
      "CdkEnumName": {
        "cdk_path": "path/to/cdkEnum",
        "sdk_service": "serviceName",
        "sdk_enum_name": "AwsEnumThatWeWantThisToMapTo",
        "match_percentage": 1.0,
        "manual": true
      }
    }
}

For example:

{
    "ec2": {
      "VpcEndpointIpAddressType": {
        "cdk_path": "aws-cdk/packages/aws-cdk-lib/aws-ec2/lib/vpc-endpoint.ts",
        "sdk_service": "ec2",
        "sdk_enum_name": "IpAddressType",
        "match_percentage": 1.0,
        "manual": true
      }
    }
}

Description of how you validated changes

Manual + unit testing

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

GavinZZ · 2025-05-13T20:32:49Z

tools/@aws-cdk/enum-updater/lib/static-enum-mapping-updater.ts

@@ -103,6 +104,16 @@ interface UnmatchedEnums {
  };
 }

+export interface ManualMappingEntry extends StaticMappingEntry {
+  manual: boolean;


would this always be true? what if user accidentally add a entry to the manual-enum-mapping.json but add it as false?
how does manual get used?

This should always be true but the value doesnt actually matter. When creating the static mapping, we only check if an entry for the specific enum exists by the enum name, if so, we just use the entry in the manual mapping instead which would include this manual field.

Basically the manual field just exists so that we know a static mapping was manually updated when we look at the entry in static-enum-mapping.json.

I would remove this field from the manual mapping file and let the code logic add it.

GavinZZ · 2025-05-13T20:34:00Z

tools/@aws-cdk/enum-updater/test/static-enum-mapping-updater.test.ts

+            sdk_service: "amplify",
+            sdk_enum_name: "OverrideManualEnum",
+            match_percentage: 1.0,
+            manual: true


what happen if you add it as false? would it still override?

Yes, we check for the enum by its name, not by whether or not manual == true.

scorbiere · 2025-05-13T22:37:44Z

tools/@aws-cdk/enum-updater/lib/static-enum-mapping-updater.ts

+        if (!staticMapping[module]) {
+          staticMapping[module] = {};
+        }
+        staticMapping[module][enumName] = manualEnumMappings[module][enumName];


I guess the manual: true could be added here if it was not in the manual mapping file, right?

I've updated it to add the manual: true here instead of having it specified in the manual overrides json file.

scorbiere · 2025-05-13T22:39:28Z

tools/@aws-cdk/enum-updater/lib/static-enum-mapping-updater.ts

@@ -103,6 +104,16 @@ interface UnmatchedEnums {
  };
 }

+export interface ManualMappingEntry extends StaticMappingEntry {
+  manual: boolean;


I would remove this field from the manual mapping file and let the code logic add it.

mergify · 2025-05-14T22:41:45Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2025-05-14T22:45:31Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2025-05-14T23:04:02Z

This pull request has been removed from the queue for the following reason: pull request branch update failed.

The pull request can't be updated.

You should update or rebase your pull request manually. If you do, this pull request will automatically be requeued once the queue conditions match again.
If you think this was a flaky issue, you can requeue the pull request, without updating it, by posting a @mergifyio requeue comment.

samson-keung · 2025-05-15T00:04:23Z

Manually updated PR with main as main has new commits that changed workflow files.

mergify · 2025-05-15T00:35:08Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2025-05-15T01:05:37Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 0786e05
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2025-05-15T01:06:01Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

github-actions · 2025-05-15T01:06:16Z

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

unit tests

1f3db7f

aws-cdk-automation requested a review from a team May 13, 2025 01:06

github-actions bot added the p2 label May 13, 2025

mergify bot added the contribution/core This is a PR that came from AWS. label May 13, 2025

README

8308ae7

paulhcsun marked this pull request as ready for review May 13, 2025 01:09

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label May 13, 2025

paulhcsun assigned scorbiere May 13, 2025

GavinZZ reviewed May 13, 2025

View reviewed changes

scorbiere reviewed May 13, 2025

View reviewed changes

paulhcsun added 2 commits May 13, 2025 16:05

remove manual field requirement in manual overrides file

d08474e

update method docstring

ade53e1

scorbiere approved these changes May 14, 2025

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label May 14, 2025

Merge branch 'main' into enum-updater-manual-static-mappings

94538f8

Merge branch 'main' into enum-updater-manual-static-mappings

0786e05

mergify bot merged commit 967ee9d into aws:main May 15, 2025
16 checks passed

github-actions bot locked as resolved and limited conversation to collaborators May 15, 2025

chore(enum-updater): support adding manual static enum mappings #34441

chore(enum-updater): support adding manual static enum mappings #34441

Uh oh!

Conversation

paulhcsun commented May 13, 2025

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

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!

mergify bot commented May 14, 2025

Uh oh!

mergify bot commented May 14, 2025

Uh oh!

mergify bot commented May 14, 2025

Uh oh!

samson-keung commented May 15, 2025

Uh oh!

mergify bot commented May 15, 2025

Uh oh!

aws-cdk-automation commented May 15, 2025

AWS CodeBuild CI Report

Uh oh!

mergify bot commented May 15, 2025

Uh oh!

Uh oh!

github-actions bot commented May 15, 2025

Uh oh!

Uh oh!