Improve type safety wrt locking. #408
Merged
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
This patch introduces a lockedConn type: ``` type lockedConn Conn ``` ...and moves all methods that require the caller to hold c.lk onto it. It provides methods for running functions while holding the lock. This makes it much harder to introduce bugs where a method is being called without holding the lock as required, or vice versa. The patch also fixes a few call sites that were in fact not doing locking correctly, which were caught by the type checker.
lthibault
approved these changes
Dec 29, 2022
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.
This patch introduces a lockedConn type:
...and moves all methods that require the caller to hold c.lk onto it. It provides methods for running functions while holding the lock.
This makes it much harder to introduce bugs where a method is being called without holding the lock as required, or vice versa.
The patch also fixes a few call sites that were in fact not doing locking correctly, which were caught by the type checker.
The second commit also cleans up some bitrot in the implementation advice comment in rpc.go