Skip to content

fix(vars): render /vars as an HTML name-value table #3413

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
darion-yaphet wants to merge 2 commits into
base: master
Choose a base branch
from
+46 −15
Open

fix(vars): render /vars as an HTML name-value table #3413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc1239c
fix(vars): render /vars as an HTML name-value table
darion-yaphet Jul 27, 2026
c45d452
test(vars): prevent HTML table rendering regressions
darion-yaphet Jul 29, 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
37 changes: 25 additions & 12 deletions src/brpc/builtin/vars_service.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ namespace brpc {
void PutVarsHeading(std::ostream& os, bool expand_all) {
os << "<script language=\"javascript\" type=\"text/javascript\" src=\"/js/jquery_min\"></script>\n"
"<script language=\"javascript\" type=\"text/javascript\" src=\"/js/flot_min\"></script>\n"
<< gridtable_style()
<< TabsHead()
<< "<style type=\"text/css\">\n"
"#layer1 { margin:0; padding:0; width:1111px; }\n"
Expand All @@ -66,6 +67,9 @@ void PutVarsHeading(std::ostream& os, bool expand_all) {
"}\n"
// style of <p>
"p {padding: 2px 0; margin: 0px; }\n"
".detail-row td {\n"
" padding:0px;\n"
"}\n"
// style of container of flot graph.
".detail {\n"
" margin: 0px;\n"
Expand Down Expand Up @@ -93,13 +97,13 @@ void PutVarsHeading(std::ostream& os, bool expand_all) {

"function prepareGraphs() {\n"
// Hide all graphs at first.
" $(\".detail\").hide();\n"
" $(\".detail-row\").hide();\n"

// Register clicking functions.
" $(\".variable\").click(function() {\n"
" var mod = $(this).next(\".detail\");\n"
" var mod = $(this).next(\".detail-row\");\n"
" mod.slideToggle(\"fast\");\n"
" var var_name = mod.children(\":first-child\").attr(\"id\");\n"
" var var_name = mod.find(\".detail\").children(\":first-child\").attr(\"id\");\n"
" if (!everEnabled[var_name]) {\n"
" everEnabled[var_name] = true;\n"
// Create tooltip at first click.
Expand Down Expand Up @@ -272,21 +276,24 @@ class VarsDumper : public bvar::Dumper {
name, _os, series_options);
plot = (rc == 0);
if (plot) {
_os << "<p class=\"variable\">";
_os << "<tr class=\"variable\">";
} else {
_os << "<p class=\"nonplot-variable\">";
_os << "<tr class=\"nonplot-variable\">";
}
}
_os << name << VAR_SEP;
if (_use_html) {
_os << "<span id=\"value-" << name << "\">";
_os << "<td>" << name << "</td><td><span id=\"value-" << name << "\">";
} else {
_os << name << VAR_SEP;
}
_os << desc;
if (_use_html) {
_os << "</span></p>\n";
_os << "</span></td></tr>\n";
if (plot) {
_os << "<div class=\"detail\"><div id=\"" << name
<< "\" class=\"flot-placeholder\"></div></div>\n";
_os << "<tr class=\"detail-row\"><td colspan=\"2\">"
"<div class=\"detail\"><div id=\"" << name
<< "\" class=\"flot-placeholder\"></div></div>"
"</td></tr>\n";
}
} else {
_os << "\r\n";
Expand Down Expand Up @@ -369,7 +376,7 @@ void VarsService::default_method(::google::protobuf::RpcController* cntl_base,
" enabled = {};\n"
" everEnabled = {};\n"
" }\n"
" $(\".detail\").hide();\n"
" $(\".detail-row\").hide();\n"
" $('#layer1').html(data);\n"
" prepareGraphs();\n"
" window.history.pushState('', '', toURL(searchText));\n"
Expand Down Expand Up @@ -406,7 +413,10 @@ void VarsService::default_method(::google::protobuf::RpcController* cntl_base,
os << "<p>Search : <input id='searchbox' type='text'"
" onkeyup='onQueryChanged()'></p>"
"<div id=\"layer1\">\n";
}
}
if (use_html) {
os << "<table class=\"gridtable\" border=\"1\"><tr><th>Name</th><th>Value</th></tr>\n";
}
Comment thread
darion-yaphet marked this conversation as resolved.
VarsDumper dumper(os, use_html);
bvar::DumpOptions options;
options.question_mark = '$';
Expand All @@ -422,6 +432,9 @@ void VarsService::default_method(::google::protobuf::RpcController* cntl_base,
cntl->SetFailed(ENOMETHOD, "Fail to find any bvar by `%s'",
options.white_wildcards.c_str());
}
if (use_html) {
os << "</table>";
}
if (with_tabs) {
os << "</div></body></html>";
}
Expand Down
24 changes: 21 additions & 3 deletions test/brpc_builtin_service_unittest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -697,15 +697,33 @@ TEST_F(BuiltinServiceTest, vars) {
brpc::VarsService service;
brpc::VarsRequest req;
brpc::VarsResponse res;
bvar::Adder<int64_t> myvar;
myvar.expose("myvar");
myvar << 9;
{
ClosureChecker done;
brpc::Controller cntl;
bvar::Adder<int64_t> myvar;
myvar.expose("myvar");
myvar << 9;
service.default_method(&cntl, &req, &res, &done);
EXPECT_FALSE(cntl.Failed());
EXPECT_EQ("text/plain", cntl.http_response().content_type());
CheckFieldInContent(cntl, "myvar : ", 9);
EXPECT_EQ(std::string::npos,
cntl.response_attachment().to_string().find("<table"));
}
{
ClosureChecker done;
brpc::Controller cntl;
SetUpController(&cntl, true);
cntl.http_request()._unresolved_path = "myvar";
service.default_method(&cntl, &req, &res, &done);
EXPECT_FALSE(cntl.Failed());
EXPECT_EQ("text/html", cntl.http_response().content_type());
CheckContent(cntl,
"<table class=\"gridtable\" border=\"1\"><tr><th>Name</th><th>Value</th></tr>");
CheckContent(cntl,
"<tr class=\"variable\"><td>myvar</td><td><span id=\"value-myvar\">9</span></td></tr>");
CheckContent(cntl,
"<tr class=\"detail-row\"><td colspan=\"2\"><div class=\"detail\"><div id=\"myvar\" class=\"flot-placeholder\"></div></div></td></tr>");
}
{
ClosureChecker done;
Expand Down
Loading