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(appconfig): prefix names with resource name #28742

Merged
merged 2 commits into from
Jan 17, 2024

Conversation

chenjane-dev
Copy link
Contributor

@chenjane-dev chenjane-dev commented Jan 17, 2024

Linter rules caught that CDK standardizes resource name prop as [resource]Name. Previously this module only used name for the prop.

Follow up from #28671.

BREAKING CHANGE: ApplicationProps.name renamed to ApplicationProps.applicationName

  • appconfig: EnvironmentProps.name renamed to EnvironmentProps.environmentName
  • appconfig: DeploymentStrategyProps.name renamed to DeploymentStrategyProps.deploymentStrategyName
  • appconfig: ExtensionProps.name renamed to ExtensionProps.extensionName

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 the p2 label Jan 17, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team January 17, 2024 17:01
@github-actions github-actions bot added the valued-contributor [Pilot] contributed between 6-12 PRs to the CDK label Jan 17, 2024
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.

@kaizencc kaizencc added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Jan 17, 2024
Copy link
Contributor

@kaizencc kaizencc left a comment

Choose a reason for hiding this comment

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

Nice!

One overall thing unrelated to this PR (but I know you wrote the module too @chenjane-dev). Everywhere you have a || logical OR you really want a ?? nullish coalescer. The subtle difference is this:

'' ?? 'default'; // evaluates to '', because it takes the right-hand side only if the left-hand side is `null` or `undefined`
'' || 'default'; // evaluates to 'default', because it takes the right-hand side if the left-hand side is falsy

Now you can debate the merits for what specifying an empty string truly entails, but in some rare cases, users actually WANT an '' (in the general sense. i'm not saying that this is a valid input for name). On the CDK side we try haphazardly to standardize on ?? for this reason, though we do not do a good job enforcing.

Not a problem for now, and I know you just want to get this in. But food for thought.

@aws-cdk-automation aws-cdk-automation dismissed their stale review January 17, 2024 21:31

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

Copy link
Contributor

mergify bot commented Jan 17, 2024

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
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 4c90b31
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@mergify mergify bot merged commit 3960720 into aws:main Jan 17, 2024
17 checks passed
Copy link
Contributor

mergify bot commented Jan 17, 2024

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).

@chenjane-dev chenjane-dev deleted the resource-name-lint branch January 17, 2024 22:20
mergify bot pushed a commit that referenced this pull request Jan 18, 2024
…28671)

Auditing awslint errors.

Reasons for keeping current list of exemptions:


* "no-unused-type:@aws-cdk/aws-appconfig-alpha.PredefinedDeploymentStrategyId" - will be fixed in a separate PR.
* "props-physical-name:@aws-cdk/aws-appconfig-alpha.ApplicationProps" 
 "props-physical-name:@aws-cdk/aws-appconfig-alpha.DeploymentStrategyProps"
 "props-physical-name:@aws-cdk/aws-appconfig-alpha.EnvironmentProps"
"props-physical-name:@aws-cdk/aws-appconfig-alpha.ExtensionProps" - will be fixed in a separate PR.
* "events-method-signature" - exempting because appconfig handles their events without cloudwatch events
* "events-generic" - exempting because appconfig handles their events without cloudwatch events

Closes #27894 alongside #28742 and #28743

----

*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
Labels
p2 pr-linter/exempt-integ-test The PR linter will not require integ test changes valued-contributor [Pilot] contributed between 6-12 PRs to the CDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants