chore(clerk-js,types,localizations): Improve error handling when web3 wallet is not installed #4845
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 4c5fe2f The changes in this PR will be included in the next version bump. This PR includes changesets to release 23 packages
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 |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
nikospapcom
commented
Jan 7, 2025
Comment on lines
10
to
23
| export const web3CallbackErrorHandler: Web3CallbackErrorHandler = (err, setError) => { | ||
| if ( | ||
| isClerkAPIResponseError(err) && | ||
| err.errors[0].meta?.paramName === 'identifier' && | ||
| err.errors[0].code === 'form_param_nil' | ||
| ) { | ||
| const error = new ClerkRuntimeError('Please install a Web3 wallet.', { | ||
| code: 'web3_missing_identifier', | ||
| }); | ||
|
|
||
| return handleError(error, [], setError); | ||
| } | ||
| return handleError(err, [], setError); | ||
| }; |
There was a problem hiding this comment.
We introduced web3CallbackErrorHandler and avoid to throw an error in getWeb3Identifier and generateWeb3Signature because we don't want to introduce a break change
nikospapcom
commented
Jan 7, 2025
packages/clerk-js/src/utils/web3.ts
Outdated
| const { provider } = params; | ||
| const ethereum = await getEthereumProvider(provider); | ||
|
|
||
| // TODO: Improve error handling for the case when the provider is not found |
There was a problem hiding this comment.
Adding a TODO for core-3
There was a problem hiding this comment.
Can we include something in the todo comment that indicates it's a breaking change for core 3? 🤔
nikospapcom
commented
Jan 7, 2025
packages/clerk-js/src/utils/web3.ts
Outdated
| const { identifier, nonce, provider } = params; | ||
| const ethereum = await getEthereumProvider(provider); | ||
|
|
||
| // TODO: Improve error handling for the case when the provider is not found |
There was a problem hiding this comment.
Adding a TODO for core-3
nikospapcom
requested review from
anagstef,
chanioxaris,
octoper and
panteliselef
anagstef
reviewed
Jan 8, 2025
| err.errors[0].meta?.paramName === 'identifier' && | ||
| err.errors[0].code === 'form_param_nil' | ||
| ) { | ||
| const error = new ClerkRuntimeError('Please install a Web3 wallet.', { |
There was a problem hiding this comment.
Should we mention the browser?
Suggested change
| const error = new ClerkRuntimeError('Please install a Web3 wallet.', { | |
| const error = new ClerkRuntimeError('Please install a Web3 wallet in your browser.', { |
anagstef
approved these changes
Jan 8, 2025
chanioxaris
approved these changes
Jan 8, 2025
| err.errors[0].meta?.paramName === 'identifier' && | ||
| err.errors[0].code === 'form_param_nil' | ||
| ) { | ||
| const error = new ClerkRuntimeError('Please install a Web3 wallet.', { |
There was a problem hiding this comment.
Maybe we can make the error a bit more user friendly
Suggested change
| const error = new ClerkRuntimeError('Please install a Web3 wallet.', { | |
| const error = new ClerkRuntimeError('A Web3 Wallet extension cannot be found. Please install one to continue.', { |
packages/localizations/src/en-US.ts
Outdated
| passkey_pa_not_supported: 'Registration requires a platform authenticator but the device does not support it.', | ||
| passkey_registration_cancelled: 'Passkey registration was cancelled or timed out.', | ||
| passkey_retrieval_cancelled: 'Passkey verification was cancelled or timed out.', | ||
| web3_missing_identifier: 'Please install a Web3 wallet.', |
There was a problem hiding this comment.
Suggested change
| web3_missing_identifier: 'Please install a Web3 wallet.', | |
| web3_missing_identifier: 'A Web3 Wallet extension cannot be found. Please install one to continue.', |
nikospapcom
force-pushed
the
nikospap/user-1143-preview-an-error-if-no-web3-wallet-is-present-and-installed
branch
from
6e6903e to
697cdcb
Compare
… wallet is not installed
nikospapcom
force-pushed
the
nikospap/user-1143-preview-an-error-if-no-web3-wallet-is-present-and-installed
branch
from
697cdcb to
4c5fe2f
Compare
nikospapcom
deleted the
nikospap/user-1143-preview-an-error-if-no-web3-wallet-is-present-and-installed
branch
jakobevangelista
pushed a commit
that referenced
this pull request
Jan 9, 2025
… wallet is not installed (#4845)
wobsoriano
pushed a commit
that referenced
this pull request
Feb 8, 2025
… wallet is not installed (#4845)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
After