Repository navigation
docs(bigtable): clarify session close, cancelRpc, and heartbeat invariants - #15000
Open
igorbernstein2 wants to merge 2 commits into
Open
igorbernstein2 wants to merge 2 commits into
igorbernstein2 wants to merge 2 commits into
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request enhances the documentation and inline comments in Session.java and SessionImpl.java to clarify the Session V3 protocol state transitions, graceful close behavior, RPC cancellation mechanics, and timeout handling. Specifically, it explains why a session waits in the CLOSING state during active vRPCs and details the server-side invariants bounding this state. There are no review comments, and I have no additional feedback to provide.
mutianf
reviewed
Nov 13, 2026
| * sent. Bounded by server heartbeats ({@code checkHeartbeat}) and the server-enforced | ||
| * {@code VirtualRpcRequest.deadline}. | ||
| * <li>{@link #WAIT_SERVER_CLOSE}: No vRPC is in flight on the wire (so server heartbeats stop) | ||
| * and {@code CloseSessionRequest} + {@code halfClose()} have been sent; waiting for the |
Contributor
There was a problem hiding this comment.
hmm, i just realized, we send another CloseSessionRequest when watchdog kills the session, is it gonna be redundant? maybe log a debug tag is enough?
mutianf
approved these changes
Nov 13, 2026
| public void cancelRpc(long rpcId, @Nullable String message, @Nullable Throwable cause) { | ||
| sessionSyncContext.execute( | ||
| () -> { | ||
| // The Session V3 protocol does not yet have a wire cancel-vRPC message, so the server |
This branch has not been deployed
This file contains hidden or 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
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.
Clarifies the Session lifecycle,
cancelRpc, and server heartbeat/deadline contracts inSessionandSessionImpl:Session.close()(which previously described immediate abort likeforceClose()rather than graceful drain viaCLOSING->WAIT_SERVER_CLOSE) and document how eachSessionStateis bounded.SessionImpl.cancelRpc()andSessionImpl.close()whycurrentRpcremains set after local cancellation until the server replies (the protocol does not yet have a wire cancel-vRPC message, so keepingcurrentRpcset prevents returning aREADYsession to the pool while the vRPC is still active on the server and prevents sendingCloseSessionRequestwhile a vRPC is still in flight on the server).SessionImpl.checkCloseTimeout()whycloseTimeoutonly needs to boundWAIT_SERVER_CLOSE(CLOSINGonly occurs while a vRPC is active on the wire, which is bounded by server heartbeats viacheckHeartbeat()and the server-enforcedVirtualRpcRequest.deadline).