fix(cli): excessive stack event polling during deployment

[iliapolo]

Closes #32186

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.

[codecov]

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]

➡️ 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.

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

[aws-cdk-automation]

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]

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]

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.