Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: improve type annotation for CustomResource properties #29541

Closed
wants to merge 1 commit into from

Conversation

jfly
Copy link

@jfly jfly commented Mar 19, 2024

Issue # (if applicable)

refs aws/aws-cdk-rfcs#375

Reason for this change

My team just went on quite the adventure trying to figure out why JSON false values were getting converted to "false". It would have been really nice if cdk's typing could have prevented that bug in the first place. (It would be even nicer if the underlying CloudFormation bug were fixed, but this is better than nothing)

Description of changes

I've improved the typing of the properties attribute to help people realize that only strings leaves are allowed here.

Description of how you validated changes

I have not tested this, hopefully the change is straightforward enough.

Checklist


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

@github-actions github-actions bot added p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Mar 19, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team March 19, 2024 19:19
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@jfly jfly changed the title fix: Improve type annotation for CustomResource properties fix: improve type annotation for CustomResource properties Mar 19, 2024
@jfly jfly force-pushed the rfc-375-workaround branch from d618de4 to 1225f8a Compare March 19, 2024 19:25
@jfly
Copy link
Author

jfly commented Mar 19, 2024

Exemption Request: I don't know what an appropriate unittest would look like here, but I'm happy to add one if you suggest it.

@aws-cdk-automation aws-cdk-automation added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Mar 19, 2024
@jfly jfly force-pushed the rfc-375-workaround branch from 1225f8a to 12fe791 Compare March 21, 2024 20:50
This was referenced Mar 25, 2024
@aws-cdk-automation
Copy link
Collaborator

This PR has been in the CHANGES REQUESTED state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week.

@jfly
Copy link
Author

jfly commented Apr 10, 2024

See above, I requested an exception. Again, happy to add unittests if someone points me in a useful direction.

@jfly
Copy link
Author

jfly commented Apr 10, 2024

No idea if this is useful, but reposting:

Exemption Request: I don't know what an appropriate unittest would look like here, but I'm happy to add one if you suggest it.

My team just went on quite the adventure trying to figure out why
JSON `false` values where getting converted to `"false"`. It would have
been really nice if cdk's typing could have prevented that bug in the
first place. (It would be even nicer if the underlying CloudFormation
bug were fixed, but this is better than nothing)
@jfly jfly force-pushed the rfc-375-workaround branch from 12fe791 to 5aa92dd Compare April 15, 2024 21:48
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 5aa92dd
  • Result: FAILED
  • Build Logs (available for 30 days)

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

@aws-cdk-automation
Copy link
Collaborator

This PR has been deemed to be abandoned, and will be automatically closed. Please create a new PR for these changes if you think this decision has been made in error.

@aws-cdk-automation aws-cdk-automation added the closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. label Apr 17, 2024
@jfly
Copy link
Author

jfly commented Apr 17, 2024

This PR is very much not abandonded. I think these two automations are fighting with each other: I requested an exemption, and didn't get feedback before the PR was automatically closed.

@aws-cdk-automation, can I get a human's eyes on this please?

@jfly
Copy link
Author

jfly commented Apr 25, 2024

@SankyRed, I see you recently reopened a PR that was closed for staleness. Any advice about what I should do here?

@calebpalmer
Copy link

I also went through this adventure and think this could be useful. I hope this PR gets some attention.

@jfly
Copy link
Author

jfly commented Jun 9, 2024

@aws-cdk-automation, @SankyRed, any advice about what I should do here?

@aws-cdk-automation
Copy link
Collaborator

The pull request linter fails with the following errors:

❌ Fixes must contain a change to a test file.
❌ Fixes must contain a change to an integration test file and the resulting snapshot.

PRs must pass status checks before we can provide a meaningful review.

If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing Exemption Request and/or Clarification Request.

✅ A exemption request has been requested. Please wait for a maintainer's review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. p2 pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants