Blocking commands may block permanently due to lost wakeup
- Dominant language
- C++
- Stars
- 4.4k
- Forks
- 658
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 10
Description
### Search before asking
- [X] I had searched in the [issues](https://github.com/apache/kvrocks/issues) and found no similar issues.
### Version
unstable
### Minimal reproduce step
I discovered this issue while testing a PR(https://github.com/apache/kvrocks/pull/2332), even though the PR increased the likelihood of it occurring, the problem actually existed beforehand.
It is difficult to reproduce manually without modifying the code, and it almost exclusively occurs during Go's integration tests.
Here's an example with `TestRegression`:
```go
func TestRegression(t *testing.T) {
srv := util.StartServer(t, map[string]string{})
defer srv.Close()
ctx := context.Background()
rdb := srv.NewClient()
defer func() { require.NoError(t, rdb.Close()) }()
c := srv.NewTCPClient()
defer func() { require.NoError(t, c.Close()) }()
proto := "*3\r\n$5\r\nBLPOP\r\n$6\r\nhandle\r\n$1\r\n0\r\n"
require.NoError(t, c.Write(fmt.Sprintf("%s%s", proto, proto)))
resList := []string{"*2", "$6", "handle", "$1", "a"}
v := rdb.RPush(ctx, "handle", "a")
require.EqualValues(t, 1, v.Val())
for _, res := range resList {
c.MustRead(t, res)
}
v = rdb.RPush(ctx, "handle", "a")
require.EqualValues(t, 1, v.Val())
for _, res := range resList {
c.MustRead(t, res)
}
}
```
By printing some information, I was able to trace the error:
```
Start Execute BPOP
TryPopFormList
CommandPush::Execute
WakeupBlockingConns: handle, n_conns: 1
CommandPush::Execute OK
BlockingCommander::StartBlocking
BlockKeys
```
The issue occurs here:
```cpp
// CommandBPop
Status Execute(Server *srv, Connection *conn, std::string *output) override {
srv_ = srv;
InitConnection(conn);
auto s = TryPopFromList();
if (s.ok() || !s.IsNotFound()) {
return Status::OK(); // error has already output in TryPopFromList
}
// <==HERE: Push is done after TryPopFromList, but not yet Blocking
return StartBlocking(timeout_, output);
}
```
To manually reproduce the issue consistently, you can add a sleep and complete a PUSH within 5 seconds:
```cpp
Status Execute(Server *srv, Connection *conn, std::string *output) override {
srv_ = srv;
InitConnection(conn);
auto s = TryPopFromList();
if (s.ok() || !s.IsNotFound()) {
return Status::OK(); // error has already output in TryPopFromList
}
std::cout << "Sleep for 5 seconds" << std::endl;
std::this_thread::sleep_for(std::chrono::seconds(5));
std::cout << "Wake up" << std::endl;
return StartBlocking(timeout_, output);
}
```

### What did you expect to see?
Blocking commands will not be blocked after new key values are added.
### What did you see instead?
Blocking command blocks permanently.
### Anything Else?
_No response_
### Are you willing to submit a PR?
- [ ] I'm willing to submit a PR!
Contributor guide
No contributing guide indexed for this repository
Research direction
Start at CommandBPop::Execute, especially the transition from TryPopFromList to StartBlocking, and reproduce the race with the shown TestRegression integration test or the temporary five-second sleep. Trace the blocking connection registration and wakeup path for BLPOP and PUSH. Done means newly added list values reliably wake commands that are about to block, with a regression test covering the ordering.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, go
- Domain
- backend, databases, testing
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100