Skip to content
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

Fix bug when handling of multiple cookie entries with the same name #2310

Merged
merged 2 commits into from
Mar 21, 2024
Merged

Fix bug when handling of multiple cookie entries with the same name #2310

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
0080d0e
Fix bug when handling of multiple cookie entries with the same name
stevejgordon Mar 13, 2024
ecdc0a9
Formatting
stevejgordon Mar 14, 2024
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
2 changes: 1 addition & 1 deletion src/Elastic.Apm/Filters/RequestCookieExtractionFilter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ namespace Elastic.Apm.Filters
/// </summary>
internal class RequestCookieExtractionFilter
{
private static readonly WildcardMatcher[] CookieMatcher = new WildcardMatcher[] { new WildcardMatcher.VerbatimMatcher("Cookie", true) };
private static readonly WildcardMatcher[] CookieMatcher = [new WildcardMatcher.VerbatimMatcher("Cookie", true)];

public static IError Filter(IError error)
{
Expand Down
14 changes: 12 additions & 2 deletions src/Elastic.Apm/Helpers/CookieHeaderParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,11 @@ public static Dictionary<string, string> ParseCookies(string cookieHeader)
var trimmed = cookieValue.Trim();
var parts = trimmed.Split('=');

if (parts.Length == 2 && !string.IsNullOrEmpty(parts[0]) && !string.IsNullOrEmpty(parts[1]))
// Fow now, we store only the first value for a given key. This aligns to our nodeJS agent behavior.
if (parts.Length == 2
&& !string.IsNullOrEmpty(parts[0])
&& !cookies.ContainsKey(parts[0])
&& !string.IsNullOrEmpty(parts[1]))
{
cookies.Add(parts[0], parts[1]);
}
Expand Down Expand Up @@ -75,8 +79,14 @@ public static Dictionary<string, string> ParseCookies(string cookieHeader)
var keyString = key.ToString();
var valueString = value.ToString();

if (!string.IsNullOrEmpty(keyString) && !string.IsNullOrEmpty(valueString))
// Fow now, we store only the first value for a given key. This aligns to our nodeJS agent behavior.
#if NETSTANDARD2_0
if (!string.IsNullOrEmpty(keyString) && !cookies.ContainsKey(keyString) && !string.IsNullOrEmpty(valueString))
cookies.Add(keyString, valueString);
#else
if (!string.IsNullOrEmpty(keyString) && !string.IsNullOrEmpty(valueString))
cookies.TryAdd(keyString, valueString);
#endif
}

span = span.Slice(foundComma ? separatorIndex + 1 : span.Length);
Expand Down
31 changes: 18 additions & 13 deletions test/Elastic.Apm.Tests/HelpersTests/CookieHeaderParserTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,31 +26,36 @@ public void ParsesHeadersCorrectly(string input, Dictionary<string, string> expe
result.Should().Contain(expected);
}

public static IEnumerable<object[]> TestData() => new[] {
new object[] { null, null },
new object[] { "", null },
new object[] { "Key1=Value1", new Dictionary<string, string>() { { "Key1", "Value1" }} },
new object[] { "Key1=Value1,Key2=Value2", new Dictionary<string, string>()
public static IEnumerable<object[]> TestData() => [
[null, null],
["", null],
["Key1=Value1", new Dictionary<string, string>() { { "Key1", "Value1" }}],
[ "Key1=Value1,Key2=Value2", new Dictionary<string, string>()
{
{ "Key1", "Value1" },
{ "Key2", "Value2" }
}},
new object[] { "Key1=Value1,Key2=Value2,Key3=Value3", new Dictionary<string, string>()
}],
[ "Key1=Value1,Key2=Value2,Key3=Value3", new Dictionary<string, string>()
{
{ "Key1", "Value1" },
{ "Key2", "Value2" },
{ "Key3", "Value3" }
}},
new object[] { "Key1=Value1; Key2=Value2", new Dictionary<string, string>()
}],
[ "Key1=Value1; Key2=Value2", new Dictionary<string, string>()
{
{ "Key1", "Value1" },
{ "Key2", "Value2" }
}},
new object[] { "Key1=Value1; Key2=Value2; Key3=Value3", new Dictionary<string, string>()
}],
[ "Key1=Value1; Key2=Value2; Key3=Value3", new Dictionary<string, string>()
{
{ "Key1", "Value1" },
{ "Key2", "Value2" },
{ "Key3", "Value3" }
}}
};
}],
[ "Key1=Value1; Key2=Value2; Key1=Value3", new Dictionary<string, string>()
{
{ "Key1", "Value1" },
{ "Key2", "Value2" }
}],
];
}
Loading