fix(core): use correct formatting for aggregate errors in aws-cdk

[sumupitchayan]

Closes #32237

Reason for this change

Sometimes when we print e.message, e is an AggegateError - so the message text is incomplete/not formatted correctly. This PR adds a new util function, formatErrorMessage which returns e.message if it exists, or a correctly formatted string of errors if e is an AggregateError.

Description of changes

See formatErrorMessage function in the newly created file, packages/aws-cdk/lib/util/error.ts. All other changes are grunt work replacing e.message with formateErrorMessage(e). This PR only does the finding and replacing in the aws-cdk package, TBD whether we need to do the same for the rest of the repo.

Describe any new or updated permissions being added

None

Description of how you validated changes

See unit tests in packages/aws-cdk/test/api/util/error.test.ts

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 60.00000% with 18 lines in your changes missing coverage. Please review.

Project coverage is 81.52%. Comparing base (f63ec29) to head (ded7a14).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #32817      +/-   ##
==========================================
- Coverage   81.52%   81.52%   -0.01%     
==========================================
  Files         222      223       +1     
  Lines       13717    13740      +23     
  Branches     2417     2420       +3     
==========================================
+ Hits        11183    11201      +18     
- Misses       2254     2257       +3     
- Partials      280      282       +2     

Flag	Coverage Δ
suite.unit	81.52% <60.00%> (-0.01%)	⬇️

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

Components	Coverage Δ
packages/aws-cdk	80.97% <60.00%> (-0.01%)	⬇️
packages/aws-cdk-lib/core	82.09% <ø> (ø)

[rix0rrr]

I suppose do add a test for this

[sumupitchayan]

Just did see packages/aws-cdk/test/api/util/error.test.ts

[aws-cdk-automation]

The pull request linter fails with the following errors:

❌ CLI code has changed. A maintainer must run the code through the testing pipeline (git fetch origin pull/32817/head && git push -f origin FETCH_HEAD:test-main-pipeline), then add the 'pr-linter/cli-integ-tested' label when the pipeline succeeds.

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.

[aws-cdk-automation]

AWS CodeBuild CI Report

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

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