Skip to content

Escape resolved hostnames in HTML connection output #3664

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
wasphin wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Escape resolved hostnames in HTML connection output #3664

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
655422b
Escape resolved hostnames in HTML connection output
wasphin Oct 25, 2026
bba98ab
Use an ephemeral port in connection output tests
wasphin Oct 25, 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
10 changes: 6 additions & 4 deletions src/brpc/builtin/connections_service.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,17 @@ inline const char* SSLStateToYesNo(SSLState s, bool use_html) {
}

struct NameOfPoint {
explicit NameOfPoint(const butil::EndPoint& pt_) : pt(pt_) {}
NameOfPoint(const butil::EndPoint& pt_, bool use_html_)
: pt(pt_), use_html(use_html_) {}
butil::EndPoint pt;
bool use_html;
};

std::ostream& operator<<(std::ostream& os, const NameOfPoint& nop) {
char buf[128];
if (FLAGS_show_hostname_instead_of_ip &&
butil::endpoint2hostname(nop.pt, buf, sizeof(buf)) == 0) {
return os << buf;
return os << (nop.use_html ? WebEscape(buf) : std::string(buf));
} else {
return os << nop.pt;
}
Expand Down Expand Up @@ -174,7 +176,7 @@ void ConnectionsService::PrintConnections(
}
if (failed) {
os << min_width("Broken", 26) << bar
<< min_width(NameOfPoint(ptr->remote_side()), 19) << bar;
<< min_width(NameOfPoint(ptr->remote_side(), use_html), 19) << bar;
if (is_channel_conn) {
os << min_width(ptr->local_side().port, 5) << bar
<< min_width(ptr->recent_error_count(), 10) << bar
Expand Down Expand Up @@ -276,7 +278,7 @@ void ConnectionsService::PrintConnections(
} else {
strcpy(rtt_display, "-");
}
os << bar << min_width(NameOfPoint(ptr->remote_side()), 19) << bar;
os << bar << min_width(NameOfPoint(ptr->remote_side(), use_html), 19) << bar;
if (is_channel_conn) {
if (ptr->local_side().port > 0) {
os << min_width(ptr->local_side().port, 5) << bar;
Expand Down
28 changes: 24 additions & 4 deletions test/brpc_builtin_service_unittest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ const bool ALLOW_UNUSED dummy_validate_reloadable_string_flag_for_ut =

namespace brpc {
DECLARE_bool(enable_rpcz);
DECLARE_bool(show_hostname_instead_of_ip);
DECLARE_bool(rpcz_hex_log_id);
DECLARE_int32(idle_timeout_second);
} // namespace rpc
Expand Down Expand Up @@ -246,9 +247,8 @@ class BuiltinServiceTest : public ::testing::Test{
brpc::Controller cntl;
ClosureChecker done;
SetUpController(&cntl, use_html);
butil::EndPoint ep;
ASSERT_EQ(0, str2endpoint("127.0.0.1:9798", &ep));
ASSERT_EQ(0, _server.Start(ep, nullptr));
ASSERT_EQ(0, _server.Start("127.0.0.1:0", nullptr));
const butil::EndPoint ep = _server.listen_address();
int self_port = -1;
const int cfd = tcp_connect(ep, &self_port);
ASSERT_GT(cfd, 0);
Expand All @@ -259,7 +259,20 @@ class BuiltinServiceTest : public ::testing::Test{
service.default_method(&cntl, &req, &res, &done);
EXPECT_FALSE(cntl.Failed());
EXPECT_EQ(expect_type, cntl.http_response().content_type());
CheckContent(cntl, buf);
if (brpc::FLAGS_show_hostname_instead_of_ip) {
char hostname[256];
butil::EndPoint peer;
ASSERT_EQ(0, str2endpoint(buf, &peer));
if (butil::endpoint2hostname(peer, hostname, sizeof(hostname)) == 0) {
const std::string expected = use_html
? brpc::WebEscape(hostname) : std::string(hostname);
CheckContent(cntl, expected.c_str());
} else {
CheckContent(cntl, buf);
}
} else {
CheckContent(cntl, buf);
}
CheckFieldInContent(cntl, "channel_connection_count: ", 0);

close(cfd);
Expand Down Expand Up @@ -693,6 +706,13 @@ TEST_F(BuiltinServiceTest, connections) {
TestConnections(true);
}

TEST_F(BuiltinServiceTest, connections_with_hostnames) {
GFLAGS_NAMESPACE::FlagSaver flag_saver;
brpc::FLAGS_show_hostname_instead_of_ip = true;
TestConnections(false);
TestConnections(true);
Comment on lines +709 to +713
}

TEST_F(BuiltinServiceTest, flags) {
TestFlags(false);
TestFlags(true);
Expand Down
Loading