pkg/reader: enforce non-copyability of ccip reader #149
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
Test Coverage
|
winder
reviewed
Sep 20, 2024
| @@ -30,6 +30,9 @@ import ( | |||
| // TODO: unit test the implementation when the actual contract reader and writer interfaces are finalized and mocks | |||
| // can be generated. | |||
| type ccipChainReader struct { | |||
| // to prevent copying this struct. | |||
| _ sync.Mutex | |||
There was a problem hiding this comment.
Sounds like there are some linters that prevent the copying, so better than nothing.
There was a problem hiding this comment.
Yeah, its linter based, not build based unfortunately.
winder
approved these changes
Sep 20, 2024
|
Pretty sure we don't need this because ptr receivers are used everywhere. |
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.
The CCIP reader is a shared object used by all processors from within the plugin.
In order to enforce it always being passed by pointer ensure that it is non-copyable by embedding a mutex.
Note that trying to copy the object will not cause compilation failures but linting failures.