Streaming support for JsonRpcServer #4879
Open
Conversation
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
tothtamas28
reviewed
Nov 10, 2025
| def encode(self) -> bytes: | ||
| return json.dumps(self.to_json()).encode('ascii') | ||
| def encode(self) -> Iterator[bytes]: | ||
| yield json.dumps(self.wrap_response()).encode('utf-8') |
Contributor
There was a problem hiding this comment.
This yields the whole bytes value, if you want to yield each byte, you can do
data = json.dumps(self.wrap_response()).encode('utf-8')
yield from (bytes([b]) for b in data)| id: str | int | None | ||
|
|
||
| def to_json(self) -> dict[str, Any]: | ||
| def wrap_response(self) -> dict[str, Any]: |
Contributor
There was a problem hiding this comment.
The PR description states
This PR extends the JsonRpcServer with support for streaming.
but it introduces what look like breaking changes. Are there other clients to this library other than kontrol-node?
| version_encoded = json.dumps(JsonRpcServer.JSONRPC_VERSION) | ||
| yield f'{{"jsonrpc": {version_encoded}, "id": {id_encoded}, "result": '.encode() | ||
| if isinstance(self.payload, Iterator): | ||
| yield from self.payload |
Contributor
There was a problem hiding this comment.
Is self.payload a bytes now? If so, the type hint can be strengthened.
| if isinstance(self.payload, Iterator): | ||
| yield from self.payload | ||
| else: | ||
| yield json.dumps(self.payload).encode('utf-8') |
Contributor
There was a problem hiding this comment.
This also yields the whole bytes.
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 extends the JsonRpcServer with support for streaming.
JsonRpcMethods can now return a stream of bytes (Iterator[bytes]) instead of a JSON-serializable value.
The method must ensure that the produced stream is already JSON-encoded, as no extra validation is performed.
This allows us to transfer large responses without buffering the entire response in memory.
This is needed by the kontrol-node, when transferring large execution traces.