feat: add updated error UI + custom error rendering #705

tinaszheng · 2024-06-04T20:27:57Z

This PR updates the error rendering to the new design where it's above the card + also adds an external hook, useError, that allows consumers to customize their own error handling logic.

Custom error	Default error

Pull Request Checklist

Did you add new tests and confirm existing tests pass? (yarn test)
Did you update relevant docs? (docs are found in the site folder, and guidelines for updating/adding docs can be found in the contribution guide)
Do your commits follow the Conventional Commits standard?
Does your PR title also follow the Conventional Commits standard?
If you have a breaking change, is it correctly reflected in your commit message? (e.g. feat!: breaking change)
Did you run lint (yarn lint:check) and fix any issues? (yarn lint:write)
Did you follow the contribution guidelines?

PR-Codex overview

The focus of this PR is to enhance the authentication and error handling experience in the Alchemy application.

Detailed summary

Added new background color variants for success, warning, and error.
Updated error handling in authentication components.
Improved error display in the authentication flow.
Introduced a Notification component for displaying different types of notifications.
Refactored context and hooks for better error handling and authentication flow.

The following files were skipped due to too many changes: packages/alchemy/src/react/context.tsx

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

vercel · 2024-06-04T20:28:00Z

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

Name	Status	Preview	Comments	Updated (UTC)
aa-sdk-site	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 5, 2024 3:55pm

moldy530

LGTM had one nit

moldy530 · 2024-06-04T23:16:10Z

packages/alchemy/src/react/hooks/useError.ts

+ *
+ * @returns the current Error object
+ */
+export function useError(): UseErrorResult {


nit: maybe useAuthError?

🫡🫡 good call

* feat: add error boundary by id * fix: remove unused classnames * feat: use error from hook * fix: remove unused variables * fix: remove console log * fix: add new colors to test * feat: rename to useAuthError

* docs: revert revert to use vocs for docs * docs: address some of the broken things on the site (#689) * docs: update the logos for AK * docs: adds streamlined quick start * docs: drops the file extension on local quick start links * docs: fix relative routes across quick start * feat: run store hydration on window focus (#695) * run store hydration on window focus * remove logs * feat: update button colors (#696) * feat: update button colors * fix: update test * fix: plugins were missing mainnet config (#692) * fix: account hydration was missing state (#693) * chore: enable version syncing when publishing (#694) * chore(release): publish v3.18.0 [skip-ci] * fix: fix paymaster override for multisig plugin (#676) * fix: allow nonzero paymaster override * refactor: update to use Hex type for paymasterAndData/paymasterData override * fix: add checks for paymasterData and paymaster field nonzero overrides * fix: add paymaster address override type * feat: gas manager only bypasses paymaster middleware when the UserOp paying for its own gas * fix: add signatures and overrides to fix 3/3 msig test and add paymaster test * chore: rename button "type" to "variant" (#699) * feat: switch type => variant and use type submit * fix: add custom focus state * fix: update the version of the store so that we don't have clashes (#703) * chore(release): publish v3.18.1 [skip-ci] * chore(release): publish v3.18.2 [skip-ci] * feat: add updated error UI + custom error rendering (#705) * feat: add error boundary by id * fix: remove unused classnames * feat: use error from hook * fix: remove unused variables * fix: remove console log * fix: add new colors to test * feat: rename to useAuthError * docs: add vercel json (#700) * docs: revert revert to use vocs for docs * docs: address some of the broken things on the site (#689) * docs: update the logos for AK * docs: add vercel json * docs: add build script * docs: add rewrites for .html` * docs: try cleanUrls * docs: remove rewrites --------- Co-authored-by: moldy <michael.moldoveanu@alchemy.com> * chore: remove the docs publishing github action * docs: run locally meets dashboard quickstart * chore: update the gh actions to checkout submodules * chore: add embedded accounts submodule --------- Co-authored-by: moldy <michael.moldoveanu@alchemy.com> Co-authored-by: Tina <59578595+tinaszheng@users.noreply.github.com> Co-authored-by: Alchemy Bot <alchemy-bot@alchemy.com> Co-authored-by: Zer0dot <zer0dot.dev@gmail.com> Co-authored-by: Cody McCabe <cmccabe524@gmail.com>

* docs: revert revert to use vocs for docs * docs: address some of the broken things on the site (#689) * docs: update the logos for AK * docs: add vercel json (#700) * docs: revert revert to use vocs for docs * docs: address some of the broken things on the site (#689) * docs: update the logos for AK * docs: add vercel json * docs: add build script * docs: add rewrites for .html` * docs: try cleanUrls * docs: remove rewrites --------- Co-authored-by: moldy <michael.moldoveanu@alchemy.com> * chore: remove the docs publishing github action * docs: adds streamlined quick start (#697) * docs: revert revert to use vocs for docs * docs: address some of the broken things on the site (#689) * docs: update the logos for AK * docs: adds streamlined quick start * docs: drops the file extension on local quick start links * docs: fix relative routes across quick start * feat: run store hydration on window focus (#695) * run store hydration on window focus * remove logs * feat: update button colors (#696) * feat: update button colors * fix: update test * fix: plugins were missing mainnet config (#692) * fix: account hydration was missing state (#693) * chore: enable version syncing when publishing (#694) * chore(release): publish v3.18.0 [skip-ci] * fix: fix paymaster override for multisig plugin (#676) * fix: allow nonzero paymaster override * refactor: update to use Hex type for paymasterAndData/paymasterData override * fix: add checks for paymasterData and paymaster field nonzero overrides * fix: add paymaster address override type * feat: gas manager only bypasses paymaster middleware when the UserOp paying for its own gas * fix: add signatures and overrides to fix 3/3 msig test and add paymaster test * chore: rename button "type" to "variant" (#699) * feat: switch type => variant and use type submit * fix: add custom focus state * fix: update the version of the store so that we don't have clashes (#703) * chore(release): publish v3.18.1 [skip-ci] * chore(release): publish v3.18.2 [skip-ci] * feat: add updated error UI + custom error rendering (#705) * feat: add error boundary by id * fix: remove unused classnames * feat: use error from hook * fix: remove unused variables * fix: remove console log * fix: add new colors to test * feat: rename to useAuthError * docs: add vercel json (#700) * docs: revert revert to use vocs for docs * docs: address some of the broken things on the site (#689) * docs: update the logos for AK * docs: add vercel json * docs: add build script * docs: add rewrites for .html` * docs: try cleanUrls * docs: remove rewrites --------- Co-authored-by: moldy <michael.moldoveanu@alchemy.com> * chore: remove the docs publishing github action * docs: run locally meets dashboard quickstart * chore: update the gh actions to checkout submodules * chore: add embedded accounts submodule --------- Co-authored-by: moldy <michael.moldoveanu@alchemy.com> Co-authored-by: Tina <59578595+tinaszheng@users.noreply.github.com> Co-authored-by: Alchemy Bot <alchemy-bot@alchemy.com> Co-authored-by: Zer0dot <zer0dot.dev@gmail.com> Co-authored-by: Cody McCabe <cmccabe524@gmail.com> --------- Co-authored-by: Cody McCabe <cmccabe524@gmail.com> Co-authored-by: Dan Nolan <dan.nolan@alchemy.com> Co-authored-by: Tina <59578595+tinaszheng@users.noreply.github.com> Co-authored-by: Alchemy Bot <alchemy-bot@alchemy.com> Co-authored-by: Zer0dot <zer0dot.dev@gmail.com>

tinaszheng added 2 commits June 4, 2024 16:25

feat: add error boundary by id

bedb53f

fix: remove unused classnames

9f1ed9f

tinaszheng requested review from moldy530, rthomare, dancoombs, mokok123 and dphilipson as code owners June 4, 2024 20:27

vercel bot deployed to Preview June 4, 2024 20:34 View deployment

feat: use error from hook

63b74d5

vercel bot deployed to Preview June 4, 2024 23:00 View deployment

fix: remove unused variables

eada9d8

tinaszheng changed the title ~~feat: add error boundary by id [wip]~~ feat: add updated error UI + custom error rendering Jun 4, 2024

vercel bot deployed to Preview June 4, 2024 23:02 View deployment

tinaszheng and others added 3 commits June 4, 2024 19:03

Merge branch 'main' into tina/errors

6723698

fix: remove console log

398ff8a

fix: add new colors to test

8b7d193

vercel bot deployed to Preview June 4, 2024 23:10 View deployment

vercel bot deployed to Preview June 4, 2024 23:11 View deployment

moldy530 previously approved these changes Jun 4, 2024

View reviewed changes

feat: rename to useAuthError

692aa9d

tinaszheng dismissed moldy530’s stale review via 692aa9d June 5, 2024 02:24

Merge branch 'main' into tina/errors

79d2323

tinaszheng requested a review from moldy530 June 5, 2024 02:24

vercel bot deployed to Preview June 5, 2024 02:28 View deployment

moldy530 approved these changes Jun 5, 2024

View reviewed changes

Merge branch 'main' into tina/errors

6590748

vercel bot deployed to Preview June 5, 2024 15:55 View deployment

tinaszheng merged commit 0b23625 into main Jun 5, 2024
5 checks passed

tinaszheng deleted the tina/errors branch June 5, 2024 15:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add updated error UI + custom error rendering #705

feat: add updated error UI + custom error rendering #705

tinaszheng commented Jun 4, 2024 •

edited by pr-codex bot

Loading

vercel bot commented Jun 4, 2024 •

edited

Loading

moldy530 left a comment

moldy530 Jun 4, 2024

tinaszheng Jun 4, 2024

feat: add updated error UI + custom error rendering #705

feat: add updated error UI + custom error rendering #705

Conversation

tinaszheng commented Jun 4, 2024 • edited by pr-codex bot Loading

Pull Request Checklist

PR-Codex overview

Detailed summary

vercel bot commented Jun 4, 2024 • edited Loading

moldy530 left a comment

Choose a reason for hiding this comment

moldy530 Jun 4, 2024

Choose a reason for hiding this comment

tinaszheng Jun 4, 2024

Choose a reason for hiding this comment

tinaszheng commented Jun 4, 2024 •

edited by pr-codex bot

Loading

vercel bot commented Jun 4, 2024 •

edited

Loading