Skip to content

fix(apigateway): deployOptions.description is not used for deployment's description#26149

Merged
mergify[bot] merged 15 commits intoaws:mainfrom
woltsu:main
Aug 22, 2023
Merged

fix(apigateway): deployOptions.description is not used for deployment's description#26149
mergify[bot] merged 15 commits intoaws:mainfrom
woltsu:main

Conversation

@woltsu
Copy link
Copy Markdown
Contributor

@woltsu woltsu commented Jun 28, 2023

When creating an instance of a RestApi construct, by default it has a Deployment attached to it. The description of the Deployment can be configured with an option given to the RestApi, like so:

const api = new RestApi(this, 'Api', {
	restApiName: 'MyApi',
	deployOptions: {
		description: 'Deployment description'
	}
});

However, looking at the source code, we see that instead of using the props.deployOptions.description, it uses props.description.

Fixes #26148

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

@gitpod-io
Copy link
Copy Markdown

gitpod-io Bot commented Jun 28, 2023

@aws-cdk-automation aws-cdk-automation requested a review from a team June 28, 2023 15:53
@github-actions github-actions Bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK bug This issue is a bug. p2 labels Jun 28, 2023
aws-cdk-automation
aws-cdk-automation previously requested changes Jun 28, 2023
View reviewed changes
Copy link
Copy Markdown
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.

@woltsu woltsu marked this pull request as draft June 28, 2023 18:35
@aws-cdk-automation aws-cdk-automation dismissed their stale review June 28, 2023 20:23

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

@woltsu woltsu marked this pull request as ready for review June 28, 2023 20:27
@woltsu woltsu mentioned this pull request Jun 28, 2023
Closed
@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jun 28, 2023
yamatatsu
yamatatsu approved these changes Jul 23, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@yamatatsu yamatatsu left a comment

Choose a reason for hiding this comment

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

LGTM

Comment thread packages/aws-cdk-lib/aws-apigateway/lib/restapi.ts Outdated

this._latestDeployment = new Deployment(this, 'Deployment', {
description: props.description? props.description :'Automatically created by the RestApi construct',
description: props.deployOptions?.description ?? 'Automatically created by the RestApi construct',
Copy link
Copy Markdown
Contributor

@yamatatsu yamatatsu Jul 23, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

That make sense.
I found the issue for this imprementation.
#20934

And it say this imprementation is to be able to set the description per deployment.
I think this PR make the imprementation close to customer thinking.

Copy link
Copy Markdown
Contributor

@rix0rrr rix0rrr Aug 3, 2023

Choose a reason for hiding this comment

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

This is good, but please consider backwards compatibility. This will change the description of all deployments that don't have an explicit description today. This bug has been in here for ~4 years and people have so far been fine with the current behavior.

A safer implementation seems to me:

Suggested change
description: props.description? props.description :'Automatically created by the RestApi construct',
description: props.deployOptions?.description ?? 'Automatically created by the RestApi construct',
description: props.deployOptions?.description ?? props.description ?? 'Automatically created by the RestApi construct',

@github-actions github-actions Bot mentioned this pull request Jul 26, 2023
Closed
yamatatsu
yamatatsu approved these changes Jul 29, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@yamatatsu yamatatsu left a comment

Choose a reason for hiding this comment

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

Reapprovement for changing PR label.

@aws-cdk-automation aws-cdk-automation added pr/needs-maintainer-review This PR needs a review from a Core Team Member and removed pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Jul 29, 2023
rix0rrr
rix0rrr previously requested changes Aug 3, 2023
View reviewed changes
Comment thread packages/aws-cdk-lib/aws-apigateway/lib/restapi.ts Outdated

this._latestDeployment = new Deployment(this, 'Deployment', {
description: props.description? props.description :'Automatically created by the RestApi construct',
description: props.deployOptions?.description ?? 'Automatically created by the RestApi construct',
Copy link
Copy Markdown
Contributor

@rix0rrr rix0rrr Aug 3, 2023

Choose a reason for hiding this comment

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

This is good, but please consider backwards compatibility. This will change the description of all deployments that don't have an explicit description today. This bug has been in here for ~4 years and people have so far been fine with the current behavior.

A safer implementation seems to me:

Suggested change
description: props.description? props.description :'Automatically created by the RestApi construct',
description: props.deployOptions?.description ?? 'Automatically created by the RestApi construct',
description: props.deployOptions?.description ?? props.description ?? 'Automatically created by the RestApi construct',

@rix0rrr rix0rrr self-assigned this Aug 3, 2023
@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Aug 3, 2023
@rix0rrr rix0rrr changed the title fix(apigateway): use deployOptions.description for deployment's description instead of the api's description fix(apigateway): deployOptions.description is not used for deployment's description Aug 22, 2023
rix0rrr
rix0rrr previously approved these changes Aug 22, 2023
View reviewed changes
@github-actions github-actions Bot added the effort/small Small work item – less than a day of effort label Aug 22, 2023
@mergify mergify Bot dismissed rix0rrr’s stale review August 22, 2023 08:58

Pull request has been modified.

@mergify mergify Bot dismissed rix0rrr’s stale review August 22, 2023 09:16

Pull request has been modified.

rix0rrr
rix0rrr previously approved these changes Aug 22, 2023
View reviewed changes
@mergify mergify Bot dismissed rix0rrr’s stale review August 22, 2023 12:15

Pull request has been modified.

@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented Aug 22, 2023

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

aws-cdk-automation commented Aug 22, 2023

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 403fe4a
  • 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 6f9fcd6 into aws:main Aug 22, 2023
@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented Aug 22, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mrgrain mrgrain mrgrain approved these changes

@rix0rrr rix0rrr rix0rrr left review comments

@aws-cdk-automation aws-cdk-automation aws-cdk-automation left review comments

+1 more reviewer

@yamatatsu yamatatsu yamatatsu approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@rix0rrr rix0rrr

Labels

beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK bug This issue is a bug. effort/small Small work item – less than a day of effort p2

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

RestApi: wrong description used for deployments

5 participants

@woltsu @aws-cdk-automation @mrgrain @rix0rrr @yamatatsu