Fix SSE event names for block update stream #2188
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
The block update stream API was incorrectly sending events named "BlockHeader" instead of "Block", while the header update stream correctly uses "BlockHeader". This caused inconsistency with the OpenAPI documentation which specifies that block stream events should be named "Block". Changed the blockStreamHandler to dynamically set event names based on the withPayloads parameter: - Block update stream (/block/updates): events named "Block" - Header update stream (/header/updates): events named "BlockHeader" 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Problem
The SSE (Server-Sent Events) implementation had an inconsistency:
/header/updates): Correctly sent events named"BlockHeader"/block/updates): Incorrectly sent events also named"BlockHeader""Block"Solution
Modified
blockStreamHandlerinsrc/Chainweb/BlockHeaderDB/RestAPI/Server.hsto dynamically set event names based on thewithPayloadsparameter:withPayloadsistrue(block stream): events are named"Block"withPayloadsisfalse(header stream): events are named"BlockHeader"Testing
cabal build chainwebChanges
blockStreamHandlerfunctionsrc/Chainweb/BlockHeaderDB/RestAPI/Server.hs🤖 Generated with Claude Code