Improve errors [SDK-3552]

[Widcket]

⚠️ This PR contains breaking changes

• All new/changed/fixed functionality is covered by tests (or N/A)
• I have added documentation for all new/changed functionality (or N/A)

📋 Changes

This PR reworks the SDK errors to:

1. Improve error handling.
2. Set up a base that better accommodates typed errors. Individual error classes for specific common errors are not included in this PR, but are very simple to add.

Underlying errors

Now, SDK errors can inherit from the base AuthError, which contains a cause? property for an underlying error. This way, errors can wrap another error simply by populating this property. The message of the 'wrapped' error will be automatically appended to the message of the 'wrapper' error (and labeled accordingly), which makes it easily discoverable and actionable by the developer.

Error codes

SDK errors that inherit from AuthError will need to specify a machine-readable code. Developers can rely on error codes to identify specific errors. Unlike error messages, codes are part of the SDK API and will remain stable within a major version of the SDK. The error codes follow the ERR_SOMETHING Node.js convention.

Error names

SDK errors that inherit from AuthError will need to specify a value for the name property (typically the error class name). This value will show up when printing an error with console.log(error), making it easier for the developer to identify the error.

API handler-specific errors

Before, HandlerError was the single catch-all error for all errors produced by an API handler. Now every handler has its own error:

• CallbackHandlerError for the errors of the callback handler
• LoginHandlerError for the errors of the login handler
• LogoutHandlerError for the errors of the logout handler
• ProfileHandlerError for the errors of the profile handler

This makes it possible for handler-specific errors to feature handler-specific codes. The end result is that every handler will only throw errors of a single type, with a machine-readable code, and a single wrapped error. Which greatly simplifies error handling.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Updated
nextjs-auth0	⬜️ Ignored (Inspect)		Aug 17, 2022 at 4:16AM (UTC)