Refactor: add defensive check to state machine replies #972
Conversation
This file contains 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
When implementing the `RaftStateMachine::apply` method, if the user fails to return a number of replies that corresponds to the number of input entries, OpenRaft will panic, often without providing helpful diagnostic information. To address this issue, this commit introduces an assertion immediately after the `apply()` method returns its replies. This assertion checks that the quantity of replies is equal to the number of input entries, ensuring consistency. Additionally, new test cases focusing on the `apply()` method have been added into the test suites provided by OpenRaft, enhancing the robustness of the implementation.
drmingdrmer
commented
Dec 19, 2023
There was a problem hiding this comment.
Reviewed 2 of 2 files at r1, all commit messages.
Reviewable status:complete! all files reviewed, all discussions resolved (waiting on @ariesdevil and @lichuang)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changelog
Refactor: add defensive check to state machine replies
When implementing the
RaftStateMachine::applymethod, if the userfails to return a number of replies that corresponds to the number of
input entries, OpenRaft will panic, often without providing helpful
diagnostic information.
To address this issue, this commit introduces an assertion immediately
after the
apply()method returns its replies. This assertion checksthat the quantity of replies is equal to the number of input entries,
ensuring consistency.
Additionally, new test cases focusing on the
apply()method have beenadded into the test suites provided by OpenRaft, enhancing the
robustness of the implementation.
This change is