Fix JavaScript connection scheduling of heartbeats #3164
Merged
Conversation
This file contains 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
pepone
commented
Nov 18, 2024
Comment on lines
+422
to
+426
| if (this._writeStream.buffer.remaining === 0) { | ||
| // If the write call consumed the complete buffer, we assume the message is sent now for | ||
| // at-most-once semantics. | ||
| this._sendStreams[0].isSent = true; | ||
| } |
There was a problem hiding this comment.
This replaces the previous callback passed to write.
pepone
commented
Nov 18, 2024
| } else if (this._transceiver instanceof IdleTimeoutTransceiverDecorator) { | ||
| // The writing of the current message completed, schedule a heartbeat in case the connection has | ||
| // nothing more to write. | ||
| this._transceiver.scheduleHeartbeat(); |
There was a problem hiding this comment.
This ensure that a heartbeat is scheduled even if write completes asynchronously. In this case Transceiver.write is not called and the decorator would not schedule one.
externl
approved these changes
Nov 18, 2024
bernardnormier
approved these changes
Nov 18, 2024
There was a problem hiding this comment.
Looks good.
A key part of the logic here is the "write" callback set by ConnectionI using setCallbacks:
this._transceiver.setCallbacks(
() => this.message(SocketOperation.Write), // connected callback
() => this.message(SocketOperation.Read), // read callback
() => this.message(SocketOperation.Write), // write callback
);This ensures message(SocketOperation.Write) is called when a write completes.
InsertCreativityHere
pushed a commit
to InsertCreativityHere/compiler-comparison
that referenced
this pull request
Dec 26, 2024
InsertCreativityHere
pushed a commit
to InsertCreativityHere/compiler-comparison
that referenced
this pull request
Jan 1, 2025
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.
This PR fixes JavaScript connection to ensure hearbeats are scheduled even if the write completes asynchronously.
It also reworks how the connection checks if the transceiver write call consumed the completed buffer. There is no need for a callback or separate parameter as the transceiver advances the buffer and the call can check if there is any remaining data.