Skip to content

Add test for non-atomic vote persistence in handleRequestVoteRequest #1242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Qian-Cheng-nju wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add test for non-atomic vote persistence in handleRequestVoteRequest #1242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0b9a695
Add test for unchecked setVotedFor() return value in handleRequestVot…
Qian-Cheng-nju Feb 16, 2026
a0022e3
feat: Add TLA+ trace instrumentation
Qian-Cheng-nju Mar 2, 2026
7e5ca3c
test: add pending bug reproduction test
Qian-Cheng-nju Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions jraft-core/src/main/java/com/alipay/sofa/jraft/core/BallotBox.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ public class BallotBox implements Lifecycle<BallotBoxOptions>, Describer {
private long pendingIndex;
private final SegmentList<Ballot> pendingMetaQueue = new SegmentList<>(false);
private BallotBoxOptions opts;
private NodeImpl node;

@OnlyForTest
long getPendingIndex() {
Expand Down Expand Up @@ -89,6 +90,7 @@ public boolean init(final BallotBoxOptions opts) {
this.waiter = opts.getWaiter();
this.closureQueue = opts.getClosureQueue();
this.lastCommittedIndex = opts.getLastCommittedIndex();
this.node = opts.getNode();
return true;
}

Expand Down Expand Up @@ -138,6 +140,9 @@ public boolean commitAt(final long firstLogIndex, final long lastLogIndex, final
} finally {
this.stampedLock.unlockWrite(stamp);
}
if (this.node != null) {
RaftTracer.logAdvanceCommitIndex(this.node, lastCommittedIndex);
}
this.waiter.onCommitted(lastCommittedIndex);
return true;
}
Expand Down
62 changes: 62 additions & 0 deletions jraft-core/src/main/java/com/alipay/sofa/jraft/core/NodeImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,6 +511,17 @@ void nextStage() {
this.stage = Stage.STAGE_JOINT;
this.node.unsafeApplyConfiguration(new Configuration(this.newPeers, this.newLearners),
new Configuration(this.oldPeers), false);
// Build simple peer list for trace
{
final StringBuilder sb = new StringBuilder();
for (int pi = 0; pi < this.newPeers.size(); pi++) {
if (pi > 0)
sb.append(',');
sb.append(RaftTracer.mapId(this.newPeers.get(pi)));
}
RaftTracer.logMsgEvent("ProposeConfigChange", this.node,
RaftTracer.configChangeMsg(sb.toString()));
}
return;
}
case STAGE_JOINT:
Expand Down Expand Up @@ -1130,6 +1141,7 @@ private boolean initBallotBox() {
ballotBoxOpts.setWaiter(this.fsmCaller);
ballotBoxOpts.setClosureQueue(this.closureQueue);
ballotBoxOpts.setNodeId(getNodeId());
ballotBoxOpts.setNode(this);
// Try to initialize the last committed index in BallotBox to be the last snapshot index.
long lastCommittedIndex = 0;
if (this.snapshotExecutor != null) {
Expand Down Expand Up @@ -1177,6 +1189,7 @@ private void electSelf() {
this.state = State.STATE_CANDIDATE;
this.currTerm++;
this.votedId = this.serverId.copy();
RaftTracer.logNodeEvent("BecomeCandidate", this);
LOG.debug("Node {} start vote timer, term={} .", getNodeId(), this.currTerm);
this.voteTimer.start();
this.voteCtx.init(this.conf.getConf(), this.conf.isStable() ? null : this.conf.getOldConf());
Expand Down Expand Up @@ -1265,6 +1278,7 @@ private void becomeLeader() {
// cancel candidate vote timer
stopVoteTimer();
this.state = State.STATE_LEADER;
RaftTracer.logNodeEvent("BecomeLeader", this);
this.leaderId = this.serverId.copy();
this.replicatorGroup.resetTerm(this.currTerm);
// Start follower's replicators
Expand Down Expand Up @@ -1861,6 +1875,9 @@ public Message handleRequestVoteRequest(final RequestVoteRequest request) {
}
} while (false);

RaftTracer.logMsgEvent("HandleRequestVoteRequest", this,
RaftTracer.voteRequestMsg(request.getServerId(), this.serverId.toString(), request.getTerm()));

return RequestVoteResponse.newBuilder() //
.setTerm(this.currTerm) //
.setGranted(request.getTerm() == this.currTerm && candidateId.equals(this.votedId)) //
Expand Down Expand Up @@ -2021,6 +2038,11 @@ public Message handleAppendEntriesRequest(final AppendEntriesRequest request, fi

if (entriesCount == 0) {
// heartbeat or probe request
RaftTracer.logMsgEvent(
"HandleAppendEntriesRequest",
this,
RaftTracer.appendEntriesRequestMsg(request.getServerId(), this.serverId.toString(),
request.getTerm(), false, 0));
final AppendEntriesResponse.Builder respBuilder = AppendEntriesResponse.newBuilder() //
.setSuccess(true) //
.setTerm(this.currTerm) //
Expand Down Expand Up @@ -2075,6 +2097,8 @@ public Message handleAppendEntriesRequest(final AppendEntriesRequest request, fi
}
}

RaftTracer.logMsgEvent("HandleAppendEntriesRequest", this, RaftTracer.appendEntriesRequestMsg(
request.getServerId(), this.serverId.toString(), request.getTerm(), true, request.getPrevLogIndex()));
final FollowerStableClosure closure = new FollowerStableClosure(request, AppendEntriesResponse.newBuilder()
.setTerm(this.currTerm), this, done, this.currTerm);
this.logManager.appendEntries(entries, closure);
Expand Down Expand Up @@ -2544,6 +2568,37 @@ public PeerId getServerId() {
return this.serverId;
}

/**
* Package-private: build JSON state snapshot for RaftTracer.
* Caller must hold appropriate lock.
*/
String traceStateJson() {
final String role;
if (this.state == null) {
role = "Follower";
} else {
switch (this.state) {
case STATE_LEADER:
case STATE_TRANSFERRING:
role = "Leader";
break;
case STATE_CANDIDATE:
role = "Candidate";
break;
default:
role = "Follower";
}
}
final String votedFor = RaftTracer.mapId(this.votedId);
final long commitIdx = this.ballotBox.getLastCommittedIndex();
final long lastLogIdx = this.logManager.getLastLogIndex();
final long lastLogTerm = this.logManager.getLastLogId(false).getTerm();
return new StringBuilder(200).append("\"term\":").append(this.currTerm).append(",\"role\":\"").append(role)
.append('"').append(",\"votedFor\":\"").append(votedFor).append('"').append(",\"commitIndex\":")
.append(commitIdx).append(",\"lastLogIndex\":").append(lastLogIdx).append(",\"lastLogTerm\":")
.append(lastLogTerm).toString();
}

@Override
public NodeId getNodeId() {
if (this.nodeId == null) {
Expand Down Expand Up @@ -2601,14 +2656,21 @@ public void handleRequestVoteResponse(final PeerId peerId, final long term, fina
peerId, response.getTerm(), this.currTerm);
stepDown(response.getTerm(), false, new Status(RaftError.EHIGHERTERMRESPONSE,
"Raft node receives higher term request_vote_response."));
RaftTracer.logMsgEvent("HandleRequestVoteResponse", this, RaftTracer.voteResponseMsg(peerId.toString(),
this.serverId.toString(), response.getTerm(), response.getGranted()));
return;
}
// check granted quorum?
if (response.getGranted()) {
this.voteCtx.grant(peerId);
RaftTracer.logMsgEvent("HandleRequestVoteResponse", this, RaftTracer.voteResponseMsg(peerId.toString(),
this.serverId.toString(), response.getTerm(), response.getGranted()));
if (this.voteCtx.isGranted()) {
becomeLeader();
}
} else {
RaftTracer.logMsgEvent("HandleRequestVoteResponse", this, RaftTracer.voteResponseMsg(peerId.toString(),
this.serverId.toString(), response.getTerm(), response.getGranted()));
}
} finally {
this.writeLock.unlock();
Expand Down
Loading
Loading