Skip to content

Fix websocket server proto definitions to include top-level enums #3130

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: gz-sim10
Choose a base branch
from
+26 −1
Open

Fix websocket server proto definitions to include top-level enums #3130

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03676b3
Fix websocket server proto definitions to include top-level enums
cmeng-gao Oct 17, 2025
88b27d3
Merge branch 'gz-sim10' into fix/websocket-proto-enums
cmeng-gao Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion src/systems/websocket_server/WebsocketServer.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -715,11 +715,15 @@ void WebsocketServer::OnMessage(int _socketId, const std::string _msg)
gzdbg << "Protos request received\n";

std::string allProtos = "syntax = \"proto3\";\n";
allProtos += "package gz.msgs;\n";
allProtos += "package gz.msgs;\n\n";

std::vector<std::string> types;
gz::msgs::Factory::Types(types);

// Track processed files and enums to avoid duplicates
std::set<const google::protobuf::FileDescriptor*> processedFiles;
std::set<const google::protobuf::EnumDescriptor*> processedEnums;

// Get all the messages, and build a single proto to send to the client.
for (auto const &type : types)
{
Expand All @@ -739,7 +743,28 @@ void WebsocketServer::OnMessage(int _socketId, const std::string _msg)
continue;

if (descriptor)
{
auto fileDescriptor = descriptor->file();

// Only process each file once to extract top-level enums
if (processedFiles.insert(fileDescriptor).second)
{
// Extract all top-level enums from this file
for (int i = 0; i < fileDescriptor->enum_type_count(); ++i)
{
auto enumDescriptor = fileDescriptor->enum_type(i);
if (processedEnums.insert(enumDescriptor).second)
{
allProtos += enumDescriptor->DebugString();
allProtos += "\n";
}
}
}

// Add the message definition (without file-level import statements)
allProtos += descriptor->DebugString();
allProtos += "\n";
}
else
{
gzerr << "Failed to get the descriptor for message["
Expand Down