Skip to content

json-rpc: Add the support for json-rpc response #43516

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

Merged
botengyao merged 4 commits into from
Feb 18, 2026
Merged

json-rpc: Add the support for json-rpc response #43516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1ed2718
response
tyxia Feb 17, 2026
9ef1635
miss a push
tyxia Feb 17, 2026
fa1938e
more tests
tyxia Feb 17, 2026
793eb2a
Merge branch 'main' of https://github.com/envoyproxy/envoy into jsonrpc
tyxia Feb 17, 2026
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
89 changes: 65 additions & 24 deletions source/common/json/json_rpc_field_extractor.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ JsonRpcFieldExtractor::JsonRpcFieldExtractor(Protobuf::Struct& metadata,
}

JsonRpcFieldExtractor* JsonRpcFieldExtractor::StartObject(absl::string_view name) {
checkValidJsonRpc(name);
if (array_depth_ > 0 || can_stop_parsing_) {
return this;
}
Expand Down Expand Up @@ -92,6 +93,9 @@ JsonRpcFieldExtractor* JsonRpcFieldExtractor::StartList(absl::string_view name)
array_depth_++;
return this;
}

checkValidJsonRpc(name);

if (can_stop_parsing_) {
return this;
}
Expand Down Expand Up @@ -157,29 +161,13 @@ std::string JsonRpcFieldExtractor::buildFullPath(absl::string_view name) const {

JsonRpcFieldExtractor* JsonRpcFieldExtractor::RenderString(absl::string_view name,
absl::string_view value) {
checkValidJsonRpc(name, value);
if (array_depth_ > 0 || can_stop_parsing_) {
return this;
}
std::string full_path = buildFullPath(name);
ENVOY_LOG_MISC(debug, "render string name {} path {}, value {}", name, full_path, value);

// Check top-level fields for method detection
if (depth_ == 1) {
if (name == jsonRpcField() && value == jsonRpcVersion()) {
has_jsonrpc_ = true;
if (has_method_) {
is_valid_jsonrpc_ = true;
}
} else if (name == methodField()) {
has_method_ = true;
if (has_jsonrpc_) {
is_valid_jsonrpc_ = true;
}
method_ = std::string(value);
is_notification_ = isNotification(method_);
}
}

// Store in temp storage
Protobuf::Value proto_value;
proto_value.set_string_value(std::string(value));
Expand All @@ -191,6 +179,7 @@ JsonRpcFieldExtractor* JsonRpcFieldExtractor::RenderString(absl::string_view nam
}

JsonRpcFieldExtractor* JsonRpcFieldExtractor::RenderBool(absl::string_view name, bool value) {
checkValidJsonRpc(name);
if (array_depth_ > 0) {
return this;
}
Expand All @@ -217,6 +206,7 @@ JsonRpcFieldExtractor* JsonRpcFieldExtractor::RenderUint32(absl::string_view nam
}

JsonRpcFieldExtractor* JsonRpcFieldExtractor::RenderInt64(absl::string_view name, int64_t value) {
checkValidJsonRpc(name);
if (array_depth_ > 0) {
return this;
}
Expand All @@ -235,6 +225,7 @@ JsonRpcFieldExtractor* JsonRpcFieldExtractor::RenderInt64(absl::string_view name
}

JsonRpcFieldExtractor* JsonRpcFieldExtractor::RenderUint64(absl::string_view name, uint64_t value) {
checkValidJsonRpc(name);
if (array_depth_ > 0) {
return this;
}
Expand All @@ -253,6 +244,8 @@ JsonRpcFieldExtractor* JsonRpcFieldExtractor::RenderUint64(absl::string_view nam
}

JsonRpcFieldExtractor* JsonRpcFieldExtractor::RenderDouble(absl::string_view name, double value) {
checkValidJsonRpc(name);

if (array_depth_ > 0) {
return this;
}
Expand All @@ -275,6 +268,7 @@ JsonRpcFieldExtractor* JsonRpcFieldExtractor::RenderFloat(absl::string_view name
}

JsonRpcFieldExtractor* JsonRpcFieldExtractor::RenderNull(absl::string_view name) {
checkValidJsonRpc(name);
if (array_depth_ > 0) {
return this;
}
Expand Down Expand Up @@ -364,17 +358,32 @@ void JsonRpcFieldExtractor::checkEarlyStop() {
}

void JsonRpcFieldExtractor::finalizeExtraction() {
if (!has_jsonrpc_ || !has_method_) {
// Valid JSON-RPC message must have jsonrpc and either:
// - method (for requests)
// - result or error (for responses)
if (!has_jsonrpc_ || (!has_method_ && !has_result_ && !has_error_)) {
ENVOY_LOG(debug, "not a valid {} message", protocolName());
is_valid_jsonrpc_ = false;
return;
}

// Copy selected fields from temp to final
copySelectedFields();

// Validate required fields
validateRequiredFields();
is_valid_jsonrpc_ = true;

if (has_method_) {
// Copy selected fields from temp to final
copySelectedFields();
// Validate required fields
validateRequiredFields();
} else if (has_result_ || has_error_) {
// response: copy jsonrpc, id, result and/or error
copyFieldByPath("jsonrpc");
copyFieldByPath("id");
if (has_result_) {
copyFieldByPath("result");
}
if (has_error_) {
copyFieldByPath("error");
}
}
}

void JsonRpcFieldExtractor::copySelectedFields() {
Expand Down Expand Up @@ -449,5 +458,37 @@ void JsonRpcFieldExtractor::validateRequiredFields() {
}
}

void JsonRpcFieldExtractor::checkValidJsonRpc(absl::string_view name,
absl::optional<absl::string_view> value) {
if (depth_ == 1) {
if (name == jsonRpcField()) {
if (value.has_value() && value.value() == jsonRpcVersion()) {
has_jsonrpc_ = true;
} else {
// Early stop if it is not a valid JSON-RPC version.
can_stop_parsing_ = true;
}
} else if (name == methodField()) {
if (value.has_value()) {
has_method_ = true;
method_ = std::string(value.value());
is_notification_ = isNotification(method_);
} else {
// Early stop if method value is not a valid JSON-RPC method.
can_stop_parsing_ = true;
}
// JSON-RPC 2.0 response.
} else if (name == "result") {
has_result_ = true;
} else if (name == "error") {
has_error_ = true;
}

if (has_jsonrpc_ && (has_method_ || has_result_ || has_error_)) {
is_valid_jsonrpc_ = true;
}
}
}

} // namespace Json
} // namespace Envoy
6 changes: 6 additions & 0 deletions source/common/json/json_rpc_field_extractor.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@ class JsonRpcFieldExtractor : public ProtobufUtil::converter::ObjectWriter,
// Path helper
std::string buildFullPath(absl::string_view name) const;

// Check if it is a valid JSON-RPC request or response.
void checkValidJsonRpc(absl::string_view name,
absl::optional<absl::string_view> value = absl::nullopt);

// Protocol-specific interface
virtual bool isNotification(const std::string& method) const = 0;
virtual absl::string_view protocolName() const = 0;
Expand Down Expand Up @@ -105,6 +109,8 @@ class JsonRpcFieldExtractor : public ProtobufUtil::converter::ObjectWriter,
bool is_valid_jsonrpc_{false};
bool has_jsonrpc_{false};
bool has_method_{false};
bool has_result_{false};
bool has_error_{false};

// Optimization flag
bool can_stop_parsing_{false};
Expand Down
67 changes: 67 additions & 0 deletions test/common/json/json_rpc_field_extractor_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,6 +354,73 @@ TEST_F(JsonRpcFieldExtractorTest, InvalidJsonRpcMissingMethod) {
EXPECT_FALSE(extractor.isValidJsonRpc());
}

TEST_F(JsonRpcFieldExtractorTest, ResponseWithResult) {
ExtractorTestJsonRpcParserConfig config;
Protobuf::Struct metadata;
TestJsonRpcFieldExtractor extractor(metadata, config);

extractor.StartObject("");
extractor.RenderString("jsonrpc", "2.0");
extractor.RenderString("result", "success");
extractor.RenderInt32("id", 1);
extractor.EndObject();
extractor.finalizeExtraction();

EXPECT_TRUE(extractor.isValidJsonRpc());
EXPECT_TRUE(metadata.fields().contains("result"));
EXPECT_EQ("success", metadata.fields().at("result").string_value());
EXPECT_TRUE(metadata.fields().contains("id"));
EXPECT_EQ(1, metadata.fields().at("id").number_value());
EXPECT_TRUE(metadata.fields().contains("jsonrpc"));
EXPECT_EQ("2.0", metadata.fields().at("jsonrpc").string_value());
EXPECT_FALSE(metadata.fields().contains("error"));
EXPECT_FALSE(metadata.fields().contains("method"));
}

TEST_F(JsonRpcFieldExtractorTest, ResponseWithError) {
ExtractorTestJsonRpcParserConfig config;
Protobuf::Struct metadata;
TestJsonRpcFieldExtractor extractor(metadata, config);

extractor.StartObject("");
extractor.RenderString("jsonrpc", "2.0");
extractor.StartObject("error");
extractor.RenderInt32("code", -32602);
extractor.RenderString("message", "Invalid parameters");
extractor.EndObject();
extractor.RenderInt32("id", 1);
extractor.EndObject();
extractor.finalizeExtraction();

EXPECT_TRUE(extractor.isValidJsonRpc());
EXPECT_FALSE(metadata.fields().contains("result"));
EXPECT_TRUE(metadata.fields().contains("error"));
EXPECT_TRUE(metadata.fields().at("error").has_struct_value());
EXPECT_EQ(-32602,
metadata.fields().at("error").struct_value().fields().at("code").number_value());
EXPECT_EQ("Invalid parameters",
metadata.fields().at("error").struct_value().fields().at("message").string_value());
EXPECT_TRUE(metadata.fields().contains("id"));
EXPECT_EQ(1, metadata.fields().at("id").number_value());
EXPECT_TRUE(metadata.fields().contains("jsonrpc"));
EXPECT_EQ("2.0", metadata.fields().at("jsonrpc").string_value());
EXPECT_FALSE(metadata.fields().contains("method"));
}

TEST_F(JsonRpcFieldExtractorTest, InvalidJsonRpcResponseMissingResultAndError) {
ExtractorTestJsonRpcParserConfig config;
Protobuf::Struct metadata;
TestJsonRpcFieldExtractor extractor(metadata, config);

extractor.StartObject("");
extractor.RenderString("jsonrpc", "2.0");
extractor.RenderInt32("id", 1);
extractor.EndObject();
extractor.finalizeExtraction();

EXPECT_FALSE(extractor.isValidJsonRpc());
}

} // namespace
} // namespace Json
} // namespace Envoy
58 changes: 56 additions & 2 deletions test/extensions/filters/http/a2a/a2a_json_parser_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1055,7 +1055,6 @@ TEST_F(A2aJsonParserTest, Reset) {
EXPECT_EQ(parser_.metadata().fields().at("id").string_value(), "2");
}

// TODO(tyxia): Add support for parsing responses.
TEST_F(A2aJsonParserTest, ParseResponseWithResult) {
const std::string json = R"({
"jsonrpc": "2.0",
Expand Down Expand Up @@ -1084,7 +1083,62 @@ TEST_F(A2aJsonParserTest, ParseResponseWithResult) {

ASSERT_TRUE(parser_.parse(json).ok());
ASSERT_TRUE(parser_.finishParse().ok());
EXPECT_FALSE(parser_.isValidA2aRequest());
EXPECT_TRUE(parser_.isValidA2aRequest());
EXPECT_TRUE(parser_.metadata().fields().contains("jsonrpc"));
EXPECT_EQ(parser_.metadata().fields().at("jsonrpc").string_value(), "2.0");
EXPECT_TRUE(parser_.metadata().fields().contains("id"));
EXPECT_EQ(parser_.metadata().fields().at("id").string_value(), "1");
EXPECT_TRUE(parser_.metadata().fields().contains("result"));
EXPECT_TRUE(parser_.metadata().fields().at("result").has_struct_value());

const auto& result = parser_.metadata().fields().at("result").struct_value().fields();
EXPECT_EQ(result.at("kind").string_value(), "task");
EXPECT_EQ(result.at("id").string_value(), "run-uuid");
EXPECT_EQ(result.at("contextId").string_value(), "f5bd2a40-74b6-4f7a-b649-ea3f09890003");

const auto& status = result.at("status").struct_value().fields();
EXPECT_EQ(status.at("state").string_value(), "completed");

const auto& artifacts = result.at("artifacts").list_value();
ASSERT_EQ(artifacts.values_size(), 1);
const auto& artifact = artifacts.values(0).struct_value().fields();
EXPECT_EQ(artifact.at("artifactId").string_value(), "artifact-uuid");
EXPECT_EQ(artifact.at("name").string_value(), "Assistant Response");

const auto& parts = artifact.at("parts").list_value();
ASSERT_EQ(parts.values_size(), 1);
const auto& part = parts.values(0).struct_value().fields();
EXPECT_EQ(part.at("kind").string_value(), "text");
EXPECT_EQ(part.at("text").string_value(), "Hello back");
}

TEST_F(A2aJsonParserTest, GetTaskErrorResponse) {
const std::string json = R"({
"jsonrpc": "2.0",
"id": 102,
"result": null,
"error": {
"code": -32001,
"message": "Task not found",
"data": null
}
})";
ASSERT_TRUE(parser_.parse(json).ok());
ASSERT_TRUE(parser_.finishParse().ok());
EXPECT_TRUE(parser_.isValidA2aRequest());
EXPECT_TRUE(parser_.metadata().fields().contains("jsonrpc"));
EXPECT_EQ(parser_.metadata().fields().at("jsonrpc").string_value(), "2.0");
EXPECT_TRUE(parser_.metadata().fields().contains("id"));
EXPECT_EQ(parser_.metadata().fields().at("id").number_value(), 102);
EXPECT_TRUE(parser_.metadata().fields().contains("result"));
EXPECT_EQ(parser_.metadata().fields().at("result").null_value(), Protobuf::NULL_VALUE);
EXPECT_TRUE(parser_.metadata().fields().contains("error"));
EXPECT_TRUE(parser_.metadata().fields().at("error").has_struct_value());

const auto& error = parser_.metadata().fields().at("error").struct_value().fields();
EXPECT_EQ(error.at("code").number_value(), -32001);
EXPECT_EQ(error.at("message").string_value(), "Task not found");
EXPECT_EQ(error.at("data").null_value(), Protobuf::NULL_VALUE);
}

} // namespace
Expand Down
Loading