chore(cli): use typed errors ToolkitError and AuthenticationError in CLI

[sumupitchayan]

Closes #32347

This PR creates two new error types, ToolkitError and AuthenticationError and uses them in aws-cdk.

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

Project coverage is 80.64%. Comparing base (5735e9e) to head (ee8204b).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #32548      +/-   ##
==========================================
+ Coverage   80.54%   80.64%   +0.10%     
==========================================
  Files         106      107       +1     
  Lines        6954     6996      +42     
  Branches     1287     1290       +3     
==========================================
+ Hits         5601     5642      +41     
  Misses       1175     1175              
- Partials      178      179       +1     

Flag	Coverage Δ
suite.unit	80.64% <54.16%> (+0.10%)	⬆️

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

Components	Coverage Δ
packages/aws-cdk	80.64% <54.16%> (+0.10%)	⬆️

[kaizencc]

Apologies if some of these questions were already asked/responded to by momo.

Also please configure the eslint rule for this package only to enforce we don't accidentally add new untyped errors.

I don't see where you've resolved this request

[kaizencc]

is this being used anywhere other than tests?

[sumupitchayan]

Nope (not yet at least) - I am also copying the implementation from ConstructError again here:

aws-cdk/packages/aws-cdk-lib/core/lib/errors.ts

Line 56 in 8718767

public abstract get type(): string;

Adding a type property is also the third instruction on Momo's ticket: #32347

[kaizencc]

again i wish you had a real reason beyond Momo telling you to. but this is fine, i suppose

[kaizencc]

should we restrict type to either toolkit or authentication? what was the decision making behind typing it as string?

[kaizencc]

also, should the constructor be private?

[sumupitchayan]

Both ConstructError and ValidationError have public constructors:

aws-cdk/packages/aws-cdk-lib/core/lib/errors.ts

Line 140 in 8718767

constructor(msg: string, scope: IConstruct) {

I could make it an enum with string values? But I'm pretty sure Momo wanted a type property that is a string (third bullet point here): #32347

[kaizencc]

for all of these questions its my hope that you answer them with your reasons for why you've done something, not because Momo said to or because a prior implementation did so. Both of those things can be true, but you should at least know why you're doing it.

now for this case my question was a silly one. you have a public constructor because you are calling new ToolkitError everywhere

stale, and i am the captain now

[sumupitchayan]

Also please configure the eslint rule for this package only to enforce we don't accidentally add new untyped errors.

I don't see where you've resolved this request

cdklabs/eslint-rules#74

[kaizencc]

I've approved. I will leave it to you to ensure that the CLI integ tests pass + to override the codecov failures

[aws-cdk-automation]

AWS CodeBuild CI Report

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

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

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