Fix websocket server proto definitions to include top-level enums #3130
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 websocket server's "protos" request handler was using descriptor->DebugString() which only outputs message definitions, causing top-level enums (like PixelFormatType) to be omitted from the generated proto definitions sent to clients. This caused protobuf.js clients to fail parsing the definitions because messages referenced enum types that were never defined. Changes: - Extract and include all top-level enums from each proto file - Use fileDescriptor->enum_type_count() to iterate enums - Add deduplication sets for both files and enums - Keep using descriptor->DebugString() for messages to avoid including import statements that would break single-file parsing The generated proto now includes all necessary enum definitions while remaining compatible with protobuf.js single-file parsing. Fixes missing PixelFormatType, SphericalCoordinatesType, and other top-level enums in the websocket proto definitions. Signed-off-by: cmeng <[email protected]>
cmeng-gao
force-pushed
the
fix/websocket-proto-enums
branch
from
91a08d9 to
03676b3
Compare
Contributor
|
Thanks for the contribution! I believe this is your first time contributing, so can you please go through the checklist and check-off relevant items? |
Contributor
Author
|
Sorry, is there anything else I need to do regarding this MR? |
Contributor
Author
iche033
approved these changes
Nov 7, 2025
Contributor
iche033
left a comment
iche033
left a comment
There was a problem hiding this comment.
The CI failures should be unrelated. Changes look good to me.
Contributor
|
@Mergifyio backport main |
Contributor
✅ Backports have been created
|
mergify bot
pushed a commit
that referenced
this pull request
Nov 7, 2025
) The websocket server's "protos" request handler was using descriptor->DebugString() which only outputs message definitions, causing top-level enums (like PixelFormatType) to be omitted from the generated proto definitions sent to clients. This caused protobuf.js clients to fail parsing the definitions because messages referenced enum types that were never defined. Changes: - Extract and include all top-level enums from each proto file - Use fileDescriptor->enum_type_count() to iterate enums - Add deduplication sets for both files and enums - Keep using descriptor->DebugString() for messages to avoid including import statements that would break single-file parsing The generated proto now includes all necessary enum definitions while remaining compatible with protobuf.js single-file parsing. Fixes missing PixelFormatType, SphericalCoordinatesType, and other top-level enums in the websocket proto definitions. Signed-off-by: cmeng <[email protected]> (cherry picked from commit f53d4ab)
8 tasks
iche033
pushed a commit
that referenced
this pull request
Nov 10, 2025
) The websocket server's "protos" request handler was using descriptor->DebugString() which only outputs message definitions, causing top-level enums (like PixelFormatType) to be omitted from the generated proto definitions sent to clients. This caused protobuf.js clients to fail parsing the definitions because messages referenced enum types that were never defined. Changes: - Extract and include all top-level enums from each proto file - Use fileDescriptor->enum_type_count() to iterate enums - Add deduplication sets for both files and enums - Keep using descriptor->DebugString() for messages to avoid including import statements that would break single-file parsing The generated proto now includes all necessary enum definitions while remaining compatible with protobuf.js single-file parsing. Fixes missing PixelFormatType, SphericalCoordinatesType, and other top-level enums in the websocket proto definitions. Signed-off-by: cmeng <[email protected]> (cherry picked from commit f53d4ab)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
The websocket server's "protos" request handler was using descriptor->DebugString() which only outputs message definitions, causing top-level enums (like PixelFormatType) to be omitted from the generated proto definitions sent to clients.
This caused protobuf.js clients to fail parsing the definitions because messages referenced enum types that were never defined.
Changes:
The generated proto now includes all necessary enum definitions while remaining compatible with protobuf.js single-file parsing.
Fixes missing PixelFormatType, SphericalCoordinatesType, and other top-level enums in the websocket proto definitions.
Summary
Checklist
codecheckpassed (See contributing)Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining
Signed-off-byandGenerated-bymessages.