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

top-level error handling #865

Merged
merged 8 commits into from
Jan 4, 2024
Merged

top-level error handling #865

merged 8 commits into from
Jan 4, 2024

Conversation

edwardfoyle
Copy link
Contributor

@edwardfoyle edwardfoyle commented Jan 4, 2024

Problem

The error handler attached to the yargs commands does not execute if an error is thrown by a sigint handler (or any other process listener). This meant that if a customer hit ctrl+C to stop sandbox (which invokes the sigint handler), then hit ctrl+C again to exit the "do you want to delete the sandbox" prompt, the error thrown by inquirer in the sigint handler would not go through the yargs error handler and instead becomes a top-level unhandled rejection

Issue number, if available:
Fixes #821

Changes

  1. Removes all individual command failure handlers and replaces with one top level command failure handler. yargs will execute this failure handler for any command failure
  2. Adds error handlers for the unhandledRejection and uncaughtException process events. This ensures that errors thrown outside of yargs are still handled
  3. Some small refactors to support the two changes above
  4. test additions and updates

Corresponding docs PR, if applicable:

Validation

Tested various failure scenarios locally, updated unit tests, existing tests pass and added additional unit tests

Checklist

  • If this PR includes a functional change to the runtime behavior of the code, I have added or updated automated test coverage for this change.
  • If this PR requires a change to the Project Architecture README, I have included that update in this PR.
  • If this PR requires a docs update, I have linked to that docs PR above.
  • If this PR modifies E2E tests, makes changes to resource provisioning, or makes SDK calls, I have run the PR checks with the run-e2e label set.

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

Copy link

changeset-bot bot commented Jan 4, 2024

🦋 Changeset detected

Latest commit: ff16f27

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@aws-amplify/backend-cli Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

sobolk
sobolk previously approved these changes Jan 4, 2024
packages/cli/src/error_handler.ts Outdated Show resolved Hide resolved
packages/cli/src/error_handler.ts Outdated Show resolved Hide resolved
packages/cli/src/error_handler.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@0618 0618 left a comment

Choose a reason for hiding this comment

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

LGTM!

@edwardfoyle edwardfoyle added the run-e2e Label that will include e2e tests in PR checks workflow label Jan 4, 2024
@edwardfoyle edwardfoyle merged commit 74846bd into main Jan 4, 2024
25 checks passed
@edwardfoyle edwardfoyle deleted the ctrlc-handling branch January 4, 2024 20:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
run-e2e Label that will include e2e tests in PR checks workflow
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ctrl+c on the npx amplify sandbox exit prompt crashes with stack trace
3 participants