Skip to content

fix(rpc-service): handle 405 and 429 status codes without triggering circuit breaker #5767

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

cryptodev-2s
Copy link
Contributor

@cryptodev-2s cryptodev-2s commented May 6, 2025

Explanation

This PR improves the handling of HTTP status codes in the RPC service by properly handling 405 (Method Not Allowed) and 429 (Too Many Requests) responses without triggering the circuit breaker. Instead of throwing errors for these status codes, we now return appropriate JSON-RPC error responses.

Changes

  • Added handling for 405 status code, returning a JSON-RPC error with code -32601 (Method not found)
  • Added handling for 429 status code, returning a JSON-RPC error with code -32005 (Request rate limit exceeded)
  • Included retry delay information in the 429 error response when available

Why

Previously, these status codes would trigger the circuit breaker, which could lead to unnecessary failover to backup endpoints. These status codes represent expected error conditions that should be handled gracefully without triggering the circuit breaker.

Testing

  • Test with 405 response to verify proper error handling
  • Test with 429 response to verify proper error handling and retry delay information
  • Verify circuit breaker is not triggered for these status codes

References

Changelog

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've communicated my changes to consumers by updating changelogs for packages I've changed, highlighting breaking changes as necessary
  • I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

@cryptodev-2s cryptodev-2s requested review from a team as code owners May 6, 2025 16:35
@cryptodev-2s cryptodev-2s marked this pull request as draft May 6, 2025 16:35
@cryptodev-2s
Copy link
Contributor Author

@metamaskbot publish-preview

Copy link
Contributor

github-actions bot commented May 6, 2025

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.
{
  "@metamask-previews/accounts-controller": "28.0.0-preview-bee8786",
  "@metamask-previews/address-book-controller": "6.0.3-preview-bee8786",
  "@metamask-previews/announcement-controller": "7.0.3-preview-bee8786",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-bee8786",
  "@metamask-previews/approval-controller": "7.1.3-preview-bee8786",
  "@metamask-previews/assets-controllers": "61.0.0-preview-bee8786",
  "@metamask-previews/base-controller": "8.0.1-preview-bee8786",
  "@metamask-previews/bridge-controller": "21.0.0-preview-bee8786",
  "@metamask-previews/bridge-status-controller": "18.0.0-preview-bee8786",
  "@metamask-previews/build-utils": "3.0.3-preview-bee8786",
  "@metamask-previews/chain-agnostic-permission": "0.6.0-preview-bee8786",
  "@metamask-previews/composable-controller": "11.0.0-preview-bee8786",
  "@metamask-previews/controller-utils": "11.7.0-preview-bee8786",
  "@metamask-previews/delegation-controller": "0.2.0-preview-bee8786",
  "@metamask-previews/earn-controller": "0.13.0-preview-bee8786",
  "@metamask-previews/eip1193-permission-middleware": "0.1.0-preview-bee8786",
  "@metamask-previews/ens-controller": "16.0.0-preview-bee8786",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-bee8786",
  "@metamask-previews/gas-fee-controller": "23.0.0-preview-bee8786",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-bee8786",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-bee8786",
  "@metamask-previews/keyring-controller": "21.0.6-preview-bee8786",
  "@metamask-previews/logging-controller": "6.0.4-preview-bee8786",
  "@metamask-previews/message-manager": "12.0.1-preview-bee8786",
  "@metamask-previews/multichain": "4.0.0-preview-bee8786",
  "@metamask-previews/multichain-api-middleware": "0.2.0-preview-bee8786",
  "@metamask-previews/multichain-network-controller": "0.6.0-preview-bee8786",
  "@metamask-previews/multichain-transactions-controller": "0.10.0-preview-bee8786",
  "@metamask-previews/name-controller": "8.0.3-preview-bee8786",
  "@metamask-previews/network-controller": "23.3.0-preview-bee8786",
  "@metamask-previews/notification-services-controller": "7.0.0-preview-bee8786",
  "@metamask-previews/permission-controller": "11.0.6-preview-bee8786",
  "@metamask-previews/permission-log-controller": "3.0.3-preview-bee8786",
  "@metamask-previews/phishing-controller": "12.5.0-preview-bee8786",
  "@metamask-previews/polling-controller": "13.0.0-preview-bee8786",
  "@metamask-previews/preferences-controller": "17.0.0-preview-bee8786",
  "@metamask-previews/profile-sync-controller": "13.0.0-preview-bee8786",
  "@metamask-previews/queued-request-controller": "10.0.0-preview-bee8786",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-bee8786",
  "@metamask-previews/remote-feature-flag-controller": "1.6.0-preview-bee8786",
  "@metamask-previews/sample-controllers": "0.1.0-preview-bee8786",
  "@metamask-previews/selected-network-controller": "22.0.0-preview-bee8786",
  "@metamask-previews/signature-controller": "28.0.0-preview-bee8786",
  "@metamask-previews/token-search-discovery-controller": "3.1.0-preview-bee8786",
  "@metamask-previews/transaction-controller": "55.0.0-preview-bee8786",
  "@metamask-previews/user-operation-controller": "34.0.0-preview-bee8786"
}

@cryptodev-2s cryptodev-2s force-pushed the fix/rpc-service-status-code-handling branch from 10169dd to d0bf3e9 Compare May 7, 2025 13:24
@cryptodev-2s
Copy link
Contributor Author

@metamaskbot publish-preview

Copy link
Contributor

github-actions bot commented May 7, 2025

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.
{
  "@metamask-previews/accounts-controller": "28.0.0-preview-d0bf3e9",
  "@metamask-previews/address-book-controller": "6.0.3-preview-d0bf3e9",
  "@metamask-previews/announcement-controller": "7.0.3-preview-d0bf3e9",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-d0bf3e9",
  "@metamask-previews/approval-controller": "7.1.3-preview-d0bf3e9",
  "@metamask-previews/assets-controllers": "61.0.0-preview-d0bf3e9",
  "@metamask-previews/base-controller": "8.0.1-preview-d0bf3e9",
  "@metamask-previews/bridge-controller": "21.0.0-preview-d0bf3e9",
  "@metamask-previews/bridge-status-controller": "18.0.0-preview-d0bf3e9",
  "@metamask-previews/build-utils": "3.0.3-preview-d0bf3e9",
  "@metamask-previews/chain-agnostic-permission": "0.6.0-preview-d0bf3e9",
  "@metamask-previews/composable-controller": "11.0.0-preview-d0bf3e9",
  "@metamask-previews/controller-utils": "11.8.0-preview-d0bf3e9",
  "@metamask-previews/delegation-controller": "0.2.0-preview-d0bf3e9",
  "@metamask-previews/earn-controller": "0.13.0-preview-d0bf3e9",
  "@metamask-previews/eip1193-permission-middleware": "0.1.0-preview-d0bf3e9",
  "@metamask-previews/ens-controller": "16.0.0-preview-d0bf3e9",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-d0bf3e9",
  "@metamask-previews/gas-fee-controller": "23.0.0-preview-d0bf3e9",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-d0bf3e9",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-d0bf3e9",
  "@metamask-previews/keyring-controller": "21.0.6-preview-d0bf3e9",
  "@metamask-previews/logging-controller": "6.0.4-preview-d0bf3e9",
  "@metamask-previews/message-manager": "12.0.1-preview-d0bf3e9",
  "@metamask-previews/multichain": "4.0.0-preview-d0bf3e9",
  "@metamask-previews/multichain-api-middleware": "0.2.0-preview-d0bf3e9",
  "@metamask-previews/multichain-network-controller": "0.6.0-preview-d0bf3e9",
  "@metamask-previews/multichain-transactions-controller": "0.10.0-preview-d0bf3e9",
  "@metamask-previews/name-controller": "8.0.3-preview-d0bf3e9",
  "@metamask-previews/network-controller": "23.4.0-preview-d0bf3e9",
  "@metamask-previews/notification-services-controller": "7.0.0-preview-d0bf3e9",
  "@metamask-previews/permission-controller": "11.0.6-preview-d0bf3e9",
  "@metamask-previews/permission-log-controller": "3.0.3-preview-d0bf3e9",
  "@metamask-previews/phishing-controller": "12.5.0-preview-d0bf3e9",
  "@metamask-previews/polling-controller": "13.0.0-preview-d0bf3e9",
  "@metamask-previews/preferences-controller": "17.0.0-preview-d0bf3e9",
  "@metamask-previews/profile-sync-controller": "13.0.0-preview-d0bf3e9",
  "@metamask-previews/queued-request-controller": "10.0.0-preview-d0bf3e9",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-d0bf3e9",
  "@metamask-previews/remote-feature-flag-controller": "1.6.0-preview-d0bf3e9",
  "@metamask-previews/sample-controllers": "0.1.0-preview-d0bf3e9",
  "@metamask-previews/selected-network-controller": "22.0.0-preview-d0bf3e9",
  "@metamask-previews/signature-controller": "28.0.0-preview-d0bf3e9",
  "@metamask-previews/token-search-discovery-controller": "3.1.0-preview-d0bf3e9",
  "@metamask-previews/transaction-controller": "55.0.0-preview-d0bf3e9",
  "@metamask-previews/user-operation-controller": "34.0.0-preview-d0bf3e9"
}

@cryptodev-2s cryptodev-2s force-pushed the fix/rpc-service-status-code-handling branch from d0bf3e9 to 1601e09 Compare May 7, 2025 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

RPC Service incorrectly triggers circuit breaker for 405 and 429 status codes
1 participant