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.
Optimize and standardize the readSSEStream function handling #204
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.
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
base: main
Are you sure you want to change the base?
Optimize and standardize the readSSEStream function handling #204
Changes from all commits
36d27b9
4413691
af8def7
9751e03
8786de7
1134c1e
250317c
0ecbcae
43c273b
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is omitting two letters really necessary?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In order to unify readSSEStream
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
emm, I think sseEvent is more scalable
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mean evt -> event
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Extensibility:
If we want to support additional SSE fields such as
id
,retry
, ortimestamp
in the future, we can easily add them into the struct without changing the function signature or breaking existing code.Optional Fields:
Structs naturally support optional fields — meaning we can selectively fill only the necessary data for each event without forcing all parameters to be provided. This provides flexibility and keeps the event handling code clean.
Readability:
Grouping related fields into a struct improves readability and reduces the risk of mistakes like wrong parameter ordering. For example:
is much clearer than:
Consistency:
It aligns with the design of
ReadSSEStream
and keeps the API surface consistent across all SSE-related functions, making the codebase easier to maintain and reason about.Although
event
is just two letters longer thanevt
, using clear naming and structured types greatly improves long-term maintainability and collaboration.