Handle code-less JSON RPC errors #130
Merged
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: 6ee04a2 The changes in this PR will be included in the next version bump. 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 |
BundleMonFiles updated (4)
Unchanged files (123)
Total files change +944B +0.27% Final result: ✅ View report in BundleMon website ➡️ |
lorisleiva
force-pushed
the
02-21-handle_code-less_json_rpc_errors
branch
from
271c7a7 to
eba7948
Compare
|
appreciate u! |
Jac0xb
reviewed
Feb 23, 2025
| @@ -40,6 +41,13 @@ describe('getSolanaErrorFromJsonRpcError', () => { | |||
| const error = getSolanaErrorFromJsonRpcError({ code, message: 'o no' }); | |||
| expect(error).toHaveProperty('context.__code', 123); | |||
| }); | |||
| it('produces a `SOLANA_ERROR__UNRECOGNIZED_JSON_RPC_ERROR` when no code is given', () => { | |||
There was a problem hiding this comment.
I think the actual conditional that invokes getSolanaErrorFromJsonRpcError looks like "error" in data and if it is it calls this.
There was a problem hiding this comment.
Hmm I think that according to the specs if the JSON RPC returns a response whose payload does not include an "error" attribute, it should not be treated as an error.
Therefore, the only thing we need to handle is a fallback for an "error" object we do not recognise — i.e. no error code provided.
Jac0xb
reviewed
Feb 23, 2025
mcintyre94
previously approved these changes
Feb 24, 2025
steveluscher
previously approved these changes
Feb 24, 2025
There was a problem hiding this comment.
Just to be completely clear for future readers, this is a patch to gracefully handle JSON-RPC that do not comply with the spec. https://www.jsonrpc.org/specification#error_object
lorisleiva
force-pushed
the
02-21-handle_code-less_json_rpc_errors
branch
from
eba7948 to
6ee04a2
Compare
github-actions
bot
dismissed stale reviews from mcintyre94 and steveluscher
Your organization requires reapproval when changes are made, so Graphite has dismissed approvals. See the output of git range-diff at https://github.com/anza-xyz/solana-web3.js/actions/runs/13544848140
mcintyre94
approved these changes
Feb 26, 2025
Merged
|
Because there has been no activity on this PR for 14 days since it was merged, it has been automatically locked. Please open a new issue if it requires a follow up. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Problem
I've had reports that some RPC errors do not include a
codeattribute in their response. For instance:{ "id": "25", "jsonrpc": "2.0", "error": { "message": "No RPC endpoints available" } }Because our types strongly expect a
bigint | numbercode to be provided in the response, thegetSolanaErrorFromJsonRpcErrorfunction of the@solana/errorspackage doesn't gracefully handle this use-case and throws the following unhelpful error stack.Summary of Changes
This PR fixes this by introducing a new
SOLANA_ERROR__UNRECOGNIZED_JSON_RPC_ERRORerror which gracefully tackles the case where acodeisn't part of the RPC response.