chore: update metadata_updater to skip some L2 constructs from being injectable #34463
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aws-cdk-automation
added
the
pr/needs-maintainer-review
GavinZZ
approved these changes
May 15, 2025
|
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 CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
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). |
|
Comments on closed issues and PRs are hard for our team to see. |
| @@ -1140,6 +1141,7 @@ export enum RestApiMode { | |||
| } | |||
|
|
|||
| class RootResource extends ResourceBase { | |||
There was a problem hiding this comment.
- Do we need to also add the
@propertyInjectabledecorator above the class just like we do for other constructs? - [Minor] To be consistent, we should include the below comment above the
PROPERTY_INJECTION_IDdeclaration:
/**
* Uniquely identifies this class.
*/
maharajhaider
pushed a commit
to maharajhaider/aws-cdk
that referenced
this pull request
May 15, 2025
…injectable (aws#34463) ### Issue # (if applicable) N/A ### Reason for this change Release was failing because when metadata_updater job got executed to automatically mark L2 constructs as injectables, it failed to update some constructs because they do not follow the normal patterns of L2 constructors. ### Description of changes - Added skip logic to skip some L2 constructs from being marked as Injectables. - Applied the injectables logic manually to `RootResource` since it's constructor does not follow the common constructors pattern for L2s, and should support the injectable logic. - Skipped `lib/function-base.LatestVersion`, as in my opinion it does not need to support the injectable feature. The constructor does not accept any props, and so It does not support any injected property injection. - Added some changes to the metadata_updater tool itself to fix some linter errors. ### Description of how you validated changes executed the metadata_updater job locally to verify the generated L2 constructs. ### Checklist - [X] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue # (if applicable)
N/A
Reason for this change
Release was failing because when metadata_updater job got executed to automatically mark L2 constructs as injectables, it failed to update some constructs because they do not follow the normal patterns of L2 constructors.
Description of changes
RootResourcesince it's constructor does not follow the common constructors pattern for L2s, and should support the injectable logic.lib/function-base.LatestVersion, as in my opinion it does not need to support the injectable feature. The constructor does not accept any props, and so It does not support any injected property injection.Description of how you validated changes
executed the metadata_updater job locally to verify the generated L2 constructs.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license