fix: make order of SSE events stable in openapi #806
Merged
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request fixes issue #797 by ensuring that the OpenAPI representation of SSE events maintains a stable order.
- Introduces new event types (AMessage and ZMessage) for ordering verification.
- Refactors the SSE test suite to use a table-driven approach with subtests.
- Applies sorting on the event schemas in the SSE registration to standardize the order.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| sse/sse_test.go | Added new event types and refactored tests into a table-driven format to verify stable event ordering. |
| sse/sse.go | Added a sorting step for event schemas using slices.SortFunc to ensure a stable order in the OpenAPI spec. |
Comments suppressed due to low confidence (1)
sse/sse_test.go:60
- [nitpick] Consider renaming 'sseTest' to a more descriptive name (e.g., 'sseSubTest') to clarify its purpose in organizing subtests.
type sseTest struct {
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #806 +/- ##
=======================================
Coverage 93.10% 93.11%
=======================================
Files 23 23
Lines 5296 5299 +3
=======================================
+ Hits 4931 4934 +3
Misses 313 313
Partials 52 52 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Owner
|
Thanks! 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
fixes #797