Skip to content
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

refactor(rpc): handlers.go - makeJSONRPCHandler() control flow refactor #3716

Merged
merged 2 commits into from
Feb 10, 2025

Conversation

masonmcbride
Copy link
Contributor

I am proposing a simpler way to write the makeJSONRPCHandler function. There was a recent bug due to this function that turned lists of requests with a single item to a object that is a response--but not a list of responses. With this refactor, this function would be more resilient to bugs because of its simplified control flow: it first tries to unmarshal as an slice of requests, and returns an array of responses if successful. It then tries to unmarshal it into a single request, and returns a single response if successful. This refactor also abstracts the logic that process the requests to see if they actually need to be sent. All of that logic is now in the processRequest function, and improves on the previous implementation because now makeJSONRPCHandle is much easier to read and understand. If both unmarshals fail, the function returns an error "error unmarshalling request," same as before. Please let me know what you think of the refactor. Thanks.

@github-actions github-actions bot added the 📦 🌐 tendermint v2 Issues or PRs tm2 related label Feb 10, 2025
@Gno2D2 Gno2D2 requested a review from a team February 10, 2025 06:23
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Feb 10, 2025
@Gno2D2
Copy link
Collaborator

Gno2D2 commented Feb 10, 2025

🛠 PR Checks Summary

All Automated Checks passed. ✅

Manual Checks (for Reviewers):
  • IGNORE the bot requirements for this PR (force green CI check)
Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. Follow the Contributor Checklist to ensure your PR is ready for review.
    • Add new tests, or document why they are unnecessary.
    • Provide clear examples/screenshots, if necessary.
    • Update documentation, if required.
    • Ensure no breaking changes, or include BREAKING CHANGE notes.
    • Link related issues/PRs, where applicable.
☑️ Reviewer Actions:
  1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.
📚 Resources:
Debug
Automated Checks
Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 The pull request was created from a fork (head branch repo: masonmcbride/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

  • Any user with comment edit permission

Copy link

codecov bot commented Feb 10, 2025

Codecov Report

Attention: Patch coverage is 85.71429% with 7 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
tm2/pkg/bft/rpc/lib/server/handlers.go 85.71% 5 Missing and 2 partials ⚠️

📢 Thoughts on this report? Let us know!

Copy link
Contributor

@aeddi aeddi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍 your refactor makes this function more readable

tm2/pkg/bft/rpc/lib/server/handlers.go Show resolved Hide resolved
@aeddi aeddi removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Feb 10, 2025
@masonmcbride masonmcbride merged commit 31fcf6a into gnolang:master Feb 10, 2025
68 checks passed
@masonmcbride masonmcbride deleted the handlers_refactor branch February 10, 2025 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📦 🌐 tendermint v2 Issues or PRs tm2 related
Projects
Development

Successfully merging this pull request may close these issues.

3 participants