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

Project coverage is 81.41%. Comparing base (e7e908b) to head (5bb86c1).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #32817      +/-   ##
==========================================
+ Coverage   81.38%   81.41%   +0.03%     
==========================================
  Files         222      223       +1     
  Lines       13698    13721      +23     
  Branches     2413     2416       +3     
==========================================
+ Hits        11148    11171      +23     
  Misses       2271     2271              
  Partials      279      279              

Flag	Coverage Δ
suite.unit	81.41% <71.11%> (+0.03%)	⬆️

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

Components	Coverage Δ
packages/aws-cdk	80.75% <71.11%> (+0.06%)	⬆️
packages/aws-cdk-lib/core	82.10% <ø> (ø)

[rix0rrr]

I suppose do add a test for this

[sumupitchayan]

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

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

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

[aws-cdk-automation]

AWS CodeBuild CI Report

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

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