Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 30 commits into
base: main
Choose a base branch
from

Conversation

sumupitchayan
Copy link
Contributor

@sumupitchayan sumupitchayan commented Dec 16, 2024

Closes #32347

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

Checklist


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@aws-cdk-automation aws-cdk-automation requested a review from a team December 16, 2024 20:19
@github-actions github-actions bot added the p2 label Dec 16, 2024
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Dec 16, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@aws-cdk-automation aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Dec 16, 2024
Signed-off-by: Sumu <[email protected]>
@sumupitchayan sumupitchayan marked this pull request as ready for review December 16, 2024 23:22
@sumupitchayan sumupitchayan requested a review from a team as a code owner December 16, 2024 23:22
@sumupitchayan sumupitchayan changed the title chore(cli): use typed ToolkitError and AuthenticationError in CLI chore(cli): use typed errors ToolkitError and AuthenticationError in CLI Dec 16, 2024
Signed-off-by: Sumu <[email protected]>
Copy link

codecov bot commented Dec 17, 2024

Codecov Report

Attention: Patch coverage is 51.63399% with 74 lines in your changes missing coverage. Please review.

Project coverage is 79.26%. Comparing base (3377c3b) to head (8b87dc2).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #32548      +/-   ##
==========================================
+ Coverage   79.15%   79.26%   +0.11%     
==========================================
  Files         107      108       +1     
  Lines        7139     7182      +43     
  Branches     1321     1324       +3     
==========================================
+ Hits         5651     5693      +42     
  Misses       1304     1304              
- Partials      184      185       +1     
Flag Coverage Δ
suite.unit 79.26% <51.63%> (+0.11%) ⬆️

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

Components Coverage Δ
packages/aws-cdk 79.26% <51.63%> (+0.11%) ⬆️

Copy link
Contributor

@mrgrain mrgrain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking really good! I left a few minor comments. Also happy to bypass the diff-coverage in this case - I agree with you that it's unduly for this PR. Just make sure the project coverage increases (which it currently does).

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

…onError func on the ToolkitError class

Signed-off-by: Sumu <[email protected]>
Signed-off-by: Sumu <[email protected]>
Signed-off-by: Sumu <[email protected]>
@aws-cdk-automation
Copy link
Collaborator

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/32548/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.

✅ A exemption request has been requested. Please wait for a maintainer's review.

@aws-cdk-automation
Copy link
Collaborator

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/32548/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.

✅ A exemption request has been requested. Please wait for a maintainer's review.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS. p2 pr/needs-cli-test-run This PR needs CLI tests run against it.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Typed Errors for cli/toolkit
3 participants