openrewrite / openrewrite/rewrite-static-analysis
RSPEC-2276 - "wait(...)" should be used instead of "Thread.sleep(...)" when a lock is held
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 62
- Forks
- 112
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 40
Description
If Thread.sleep(...) is called when the current thread holds a lock, it could lead to performance and scalability issues, or even worse to deadlocks because the execution of the thread holding the lock is frozen. It’s better to call wait(...) on the monitor object to temporarily release the lock and allow other threads to run.
Noncompliant Code Example
public void doSomething(){
synchronized(monitor) {
while(notReady()){
Thread.sleep(200);
}
process();
}
}
Compliant Solution
public void doSomething(){
synchronized(monitor) {
while(notReady()){
monitor.wait(200);
}
process();
}
}
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the RSPEC-2276 description and its noncompliant and compliant Java examples. Identify the static-analysis entry point for detecting Thread.sleep(...) while a lock is held, then verify that the reported case recommends wait(...) on the monitor object and that the rule handles the documented example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100