github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Add x-ms-request-id to a default list of unredacted log headers (#2359)

Browse Source 
Co-authored-by: Anton Kolesnyk <antkmsft@users.noreply.github.com>
This commit is contained in:
Anton Kolesnyk 2021-05-28 08:51:53 +00:00 committed by GitHub
parent 9e7fa34c34
commit cb862f56b5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
sdk/core/azure-core/src/http/log_policy.cpp
View File

@ -131,7 +131,8 @@ inline std::string GetResponseLogMessage(
Azure::Core::CaseInsensitiveSet const
Azure::Core::Http::Policies::_detail::g_defaultAllowedHttpHeaders
= {"x-ms-client-request-id",
= {"x-ms-request-id",
"x-ms-client-request-id",
"x-ms-return-client-request-id",
"traceparent",
"Accept",

23
sdk/core/azure-core/test/ut/log_policy_test.cpp
View File

@ -60,6 +60,7 @@ void SendRequest(LogOptions const& logOptions)
request.SetHeader("hEaDeR1", "HvAlUe1");
request.SetHeader("HeAdEr2", "hVaLuE2");
request.SetHeader("x-ms-request-id", "6c536700-4c36-4e22-9161-76e7b3bf8269");
{
std::vector<std::unique_ptr<HttpPolicy>> policies;
@ -144,7 +145,8 @@ TEST(LogPolicy, Default)
"&qparam%25204=REDACTED"
"&qparam1=REDACTED"
"\nheader1 : REDACTED"
"\nheader2 : REDACTED");
"\nheader2 : REDACTED"
"\nx-ms-request-id : 6c536700-4c36-4e22-9161-76e7b3bf8269");
EXPECT_TRUE(StartsWith(entry2.Message, "HTTP Response ("));
EXPECT_TRUE(EndsWith(entry2.Message, "ms) : 200 OKAY"));
@ -153,7 +155,12 @@ TEST(LogPolicy, Default)
TEST(LogPolicy, Headers)
{
TestLogger const Log;
SendRequest(LogOptions({{}, {"HeAder1", "heaDer3"}}));
{
auto logOptions = LogOptions();
logOptions.AllowedHttpHeaders.insert({"HeAder1", "heaDer3"});
SendRequest(logOptions);
}
EXPECT_EQ(Log.Entries.size(), 2);
@ -172,7 +179,8 @@ TEST(LogPolicy, Headers)
"&qparam%25204=REDACTED"
"&qparam1=REDACTED"
"\nheader1 : HvAlUe1"
"\nheader2 : REDACTED");
"\nheader2 : REDACTED"
"\nx-ms-request-id : 6c536700-4c36-4e22-9161-76e7b3bf8269");
EXPECT_TRUE(StartsWith(entry2.Message, "HTTP Response ("));
EXPECT_TRUE(EndsWith(entry2.Message, "ms) : 200 OKAY"));
@ -200,7 +208,8 @@ TEST(LogPolicy, QueryParams)
"&qparam%25204=REDACTED"
"&qparam1=qVal1"
"\nheader1 : REDACTED"
"\nheader2 : REDACTED");
"\nheader2 : REDACTED"
"\nx-ms-request-id : REDACTED");
EXPECT_TRUE(StartsWith(entry2.Message, "HTTP Response ("));
EXPECT_TRUE(EndsWith(entry2.Message, "ms) : 200 OKAY"));
@ -228,7 +237,8 @@ TEST(LogPolicy, QueryParamsUnencoded)
"&qparam%25204=REDACTED"
"&qparam1=REDACTED"
"\nheader1 : REDACTED"
"\nheader2 : REDACTED");
"\nheader2 : REDACTED"
"\nx-ms-request-id : REDACTED");
EXPECT_TRUE(StartsWith(entry2.Message, "HTTP Response ("));
EXPECT_TRUE(EndsWith(entry2.Message, "ms) : 200 OKAY"));
@ -256,7 +266,8 @@ TEST(LogPolicy, QueryParamsEncoded)
"&qparam%25204=QVAL%25204"
"&qparam1=REDACTED"
"\nheader1 : REDACTED"
"\nheader2 : REDACTED");
"\nheader2 : REDACTED"
"\nx-ms-request-id : REDACTED");
EXPECT_TRUE(StartsWith(entry2.Message, "HTTP Response ("));
EXPECT_TRUE(EndsWith(entry2.Message, "ms) : 200 OKAY"));