fix(cli): excessive stack event polling during deployment by iliapolo · Pull Request #32196 · aws/aws-cdk

iliapolo · 2024-11-19T19:23:31Z

Reason for this change

The CLI will poll for all stack events from the beginning of time, even though it will end up using only a fraction of them to display in the terminal. This can cause a significant slowdown of cdk deploy.

Description of changes

Moved the pagination to the caller side, so it can decide whether or not to poll the next page. This is how it was before 2.167.0

aws-cdk/packages/aws-cdk/lib/api/util/cloudformation/stack-event-poller.ts

Lines 73 to 74 in 7bb9203

    
           while (!finished) { 
        
             const response = await this.cfn.describeStackEvents({ StackName: this.props.stackName, NextToken: nextToken }).promise();

Description of how you validated changes

Added unit test.

Notes

There are several functions in the sdk.ts that perform implicit pagination to retrieve all results. From a quick glance, none of them seem to be misusing it though (at least with respect to how it always was). I will investigate those functions further in a followup PR.

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

aws-cdk-automation

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.

packages/aws-cdk/lib/api/util/cloudformation/stack-event-poller.ts

codecov · 2024-11-20T05:47:36Z

Codecov Report

Attention: Patch coverage is 76.19048% with 5 lines in your changes missing coverage. Please review.

Project coverage is 77.19%. Comparing base (6317a2a) to head (850b150).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #32196      +/-   ##
==========================================
+ Coverage   77.18%   77.19%   +0.01%     
==========================================
  Files         105      105              
  Lines        7161     7166       +5     
  Branches     1312     1314       +2     
==========================================
+ Hits         5527     5532       +5     
  Misses       1454     1454              
  Partials      180      180

Flag	Coverage Δ
suite.unit	`77.19% <76.19%> (+0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	`77.19% <76.19%> (+0.01%)`	⬆️

---- 🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests
JS Bundle Analysis - Avoid shipping oversized bundles

aws-cdk-automation · 2024-11-20T06:15:43Z

➡️ PR build request submitted to test-main-pipeline ⬅️

A maintainer must now check the pipeline and add the pr-linter/cli-integ-tested label once the pipeline succeeds.

packages/aws-cdk/lib/api/util/cloudformation/stack-event-poller.ts

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

packages/aws-cdk/lib/api/aws-auth/sdk.ts

aws-cdk-automation · 2024-11-20T11:29:08Z

AWS CodeBuild CI Report

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

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

mergify · 2024-11-20T11:29:41Z

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 · 2024-11-20T11:45:48Z

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.

mid work

a18adaf

aws-cdk-automation requested a review from a team November 19, 2024 19:23

github-actions bot added the p2 label Nov 19, 2024

mergify bot added the contribution/core This is a PR that came from AWS. label Nov 19, 2024

iliapolo had a problem deploying to test-pipeline November 19, 2024 19:24 — with GitHub Actions Failure

aws-cdk-automation previously requested changes Nov 19, 2024

View reviewed changes

aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Nov 19, 2024

github-actions bot added bug This issue is a bug. effort/medium Medium work item – several days of effort p0 and removed p2 labels Nov 19, 2024

iliapolo commented Nov 19, 2024

View reviewed changes

packages/aws-cdk/lib/api/util/cloudformation/stack-event-poller.ts Show resolved Hide resolved

add test

57d9126

iliapolo had a problem deploying to test-pipeline November 20, 2024 05:17 — with GitHub Actions Failure

cleanup

e8776ba

iliapolo had a problem deploying to test-pipeline November 20, 2024 05:18 — with GitHub Actions Failure

iliapolo added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Nov 20, 2024

fix tests

2b75f65

iliapolo had a problem deploying to test-pipeline November 20, 2024 05:37 — with GitHub Actions Failure

iliapolo added 2 commits November 20, 2024 07:56

mock with sdk

ebf0b17

Merge branch 'main' into epolon/stack-events-pagination

c209206

iliapolo temporarily deployed to test-pipeline November 20, 2024 05:58 — with GitHub Actions Inactive

iliapolo marked this pull request as ready for review November 20, 2024 06:14

exclude coverage

f459d6a

iliapolo had a problem deploying to test-pipeline November 20, 2024 06:22 — with GitHub Actions Failure

exclude coverage

d9b6dba

iliapolo had a problem deploying to test-pipeline November 20, 2024 06:23 — with GitHub Actions Failure

Merge branch 'main' into epolon/stack-events-pagination

8919fd6

iliapolo had a problem deploying to test-pipeline November 20, 2024 06:25 — with GitHub Actions Failure

exclude coverage

78fe63a

iliapolo had a problem deploying to test-pipeline November 20, 2024 06:50 — with GitHub Actions Failure

iliapolo commented Nov 20, 2024

View reviewed changes

packages/aws-cdk/lib/api/util/cloudformation/stack-event-poller.ts Outdated Show resolved Hide resolved

iliapolo commented Nov 20, 2024

View reviewed changes

packages/aws-cdk/lib/api/util/cloudformation/stack-event-poller.ts Outdated Show resolved Hide resolved

iliapolo commented Nov 20, 2024

View reviewed changes

packages/aws-cdk/lib/api/util/cloudformation/stack-event-poller.ts Outdated Show resolved Hide resolved

iliapolo commented Nov 20, 2024

View reviewed changes

packages/aws-cdk/lib/api/util/cloudformation/stack-event-poller.ts Outdated Show resolved Hide resolved

iliapolo added the pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested label Nov 20, 2024

aws-cdk-automation added pr/needs-maintainer-review This PR needs a review from a Core Team Member and removed pr/needs-cli-test-run This PR needs CLI tests run against it. labels Nov 20, 2024

rix0rrr requested changes Nov 20, 2024

View reviewed changes

packages/aws-cdk/lib/api/aws-auth/sdk.ts Outdated Show resolved Hide resolved

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Nov 20, 2024

mid work

850b150

iliapolo had a problem deploying to test-pipeline November 20, 2024 11:00 — with GitHub Actions Failure

rix0rrr approved these changes Nov 20, 2024

View reviewed changes

iliapolo merged commit a8bc46d into main Nov 20, 2024

iliapolo deleted the epolon/stack-events-pagination branch November 20, 2024 11:45

github-actions bot locked as resolved and limited conversation to collaborators Nov 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(cli): excessive stack event polling during deployment #32196

fix(cli): excessive stack event polling during deployment #32196
iliapolo merged 11 commits intomainfrom
epolon/stack-events-pagination

iliapolo commented Nov 19, 2024 •

edited

Loading

Uh oh!

aws-cdk-automation left a comment

Uh oh!

Uh oh!

codecov bot commented Nov 20, 2024 •

edited

Loading

Uh oh!

aws-cdk-automation commented Nov 20, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aws-cdk-automation commented Nov 20, 2024

Uh oh!

mergify bot commented Nov 20, 2024

Uh oh!

github-actions bot commented Nov 20, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	while (!finished) {
	const response = await this.cfn.describeStackEvents({ StackName: this.props.stackName, NextToken: nextToken }).promise();

Conversation

iliapolo commented Nov 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reason for this change

Description of changes

Description of how you validated changes

Notes

Checklist

Uh oh!

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov bot commented Nov 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

aws-cdk-automation commented Nov 20, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aws-cdk-automation commented Nov 20, 2024

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Nov 20, 2024

Uh oh!

github-actions bot commented Nov 20, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

iliapolo commented Nov 19, 2024 •

edited

Loading

codecov bot commented Nov 20, 2024 •

edited

Loading