Skip to content

Fix SanitizeFieldNamesTests #1299

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
gregkalapos merged 2 commits into from
May 26, 2021
Merged

Fix SanitizeFieldNamesTests #1299

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
26c4b0c
Update SanitizeFieldNamesTests.cs
gregkalapos May 10, 2021
13f672a
Fix failing sanitize tests
gregkalapos May 25, 2021
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/ErrorContextSanitizerFilter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public IError Filter(IError error)
{
if (realError.Context.Request?.Headers != null && realError.ConfigSnapshot != null)
{
foreach (var key in realError.Context?.Request?.Headers?.Keys)
foreach (var key in realError.Context?.Request?.Headers?.Keys.ToList())
Copy link
Contributor Author

@gregkalapos gregkalapos May 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need .ToList() here, otherwise we can't change the dictionary within the foreach. Same in HeaderDictionarySanitizerFilter.cs

{
if (WildcardMatcher.IsAnyMatch(realError.ConfigSnapshot.SanitizeFieldNames, key))
realError.Context.Request.Headers[key] = Consts.Redacted;
Expand Down
2 changes: 1 addition & 1 deletion src/Elastic.Apm/Filters/HeaderDictionarySanitizerFilter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public ITransaction Filter(ITransaction transaction)
{
if (realTransaction.IsContextCreated && realTransaction.Context.Request?.Headers != null)
{
foreach (var key in realTransaction.Context?.Request?.Headers?.Keys)
foreach (var key in realTransaction.Context?.Request?.Headers?.Keys.ToList())
{
if (WildcardMatcher.IsAnyMatch(realTransaction.ConfigSnapshot.SanitizeFieldNames, key))
realTransaction.Context.Request.Headers[key] = Consts.Redacted;
Expand Down
2 changes: 1 addition & 1 deletion test/Elastic.Apm.AspNetCore.Tests/SanitizeFieldNamesTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ public async Task SanitizeHeadersOnError(string headerName, bool useOnlyDiagnost
_capturedPayload.FirstTransaction.Context.Request.Headers[headerName].Should().Be("[REDACTED]");

_capturedPayload.WaitForErrors();
_capturedPayload.Errors.Should().ContainSingle();
_capturedPayload.Errors.Should().NotBeEmpty();
Copy link
Contributor

@russcam russcam May 24, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is capturing more than one error now expected?

Copy link
Contributor Author

@gregkalapos gregkalapos May 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is capturing more than one error now expected?

I debugged it and I saw a failing outgoing HTTP request into some resource which looked like part of the sample app. Below we specifically assert that the first error must contain the header and the value must be [REDACTED], so I thought the easiest is to just relax this part and make sure there is at least 1 error.

_capturedPayload.FirstError.Context.Should().NotBeNull();
_capturedPayload.FirstError.Context.Request.Should().NotBeNull();
_capturedPayload.FirstError.Context.Request.Headers.Should().NotBeNull();
Expand Down