ci: Add lint rule that ensures a mutex guards "AlreadyLocked" functions#4456
Draft
johnsaigle wants to merge 3 commits into
Draft
ci: Add lint rule that ensures a mutex guards "AlreadyLocked" functions#4456johnsaigle wants to merge 3 commits into
johnsaigle wants to merge 3 commits into
Conversation
johnsaigle
changed the title
Contributor
Author
|
This will be refactored into the infrastructure created by #4841 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Implements a custom rule using the
revivelinter framework. (Ordinarilyrevivecould be added and configured in the usualgolangci-lintway but not if you use custom rules.)This is done by creating a thin binary wrapper around the
reviveCLI in accordance with their official documentation. (https://github.com/mgechev/revive/tree/master?tab=readme-ov-file#using-revive-as-a-library)This specific rule checks that the use of our
*AlreadyLockedfunctions are only called when a mutex is locked within the same function scoped. This should help us protect against data corruption issues for parallel access to e.g. the database.This PR also adds documentation and linting configuration so that we can continue to extend revive if we want and easily incorporate it into our existing lint set-up.