CELEBORN-1079: Fix use of GuardedBy in client-flink/common #2029
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
Codecov Report
@@ Coverage Diff @@
## main #2029 +/- ##
=======================================
Coverage 46.90% 46.90%
=======================================
Files 165 165
Lines 10531 10531
Branches 959 959
=======================================
Hits 4938 4938
Misses 5271 5271
Partials 322 322 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
mridulm
commented
Oct 23, 2023
| @@ -92,7 +90,6 @@ public class PartitionSortedBuffer implements SortBuffer { | |||
| // For writing | |||
| // --------------------------------------------------------------------------------------------- | |||
| /** Whether this sort buffer is released. A released sort buffer can not be used. */ | |||
| @GuardedBy("lock") | |||
There was a problem hiding this comment.
I am assuming this GuardedBy is a holdover from some past migration ?
This class is marked as not thread safe, and there is no lock instance.
Given this, I removed the annotation
mridulm
commented
Oct 23, 2023
| @@ -155,6 +155,7 @@ public void recycle(ByteBuffer buffer) { | |||
| } | |||
| } | |||
|
|
|||
| @GuardedBy("lock") | |||
There was a problem hiding this comment.
There is a assert Thread.holdsLock(lock) - so the expectation is that these two methods have the lock held.
This annotation is is to help error prone understand that entire method is marked thread safe w.r.t lock
waitinfuture
pushed a commit
to waitinfuture/RemoteShuffleService
that referenced
this pull request
Oct 24, 2023
* Fix use of `GuardedBy` on nonexistant lock. * Annotate methods, which are expected to be called with lock held, with `GuardedBy` so that error prone can analyze all invocations There is no functional change, but it helps errorprone analysis. No Unit tests Closes apache#2029 from mridulm/fix-flink-guarded-by-annotation. Authored-by: Mridul Muralidharan <mridulatgmail.com> Signed-off-by: zky.zhoukeyong <[email protected]>
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.
What changes were proposed in this pull request?
GuardedByon nonexistant lock.GuardedByso that error prone can analyze all invocationsWhy are the changes needed?
There is no functional change, but it helps errorprone analysis.
Does this PR introduce any user-facing change?
No
How was this patch tested?
Unit tests