openrewrite / openrewrite/rewrite-static-analysis

RSPEC-2276 - "wait(...)" should be used instead of "Thread.sleep(...)" when a lock is held

Open
#28 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

recipe
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();
  }
  
}

https://rules.sonarsource.com/java/RSPEC-2276

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.