Skip to content

fixess to middleware after some testing #1345

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
StuartFerguson merged 5 commits into from
Oct 25, 2026
Merged

fixess to middleware after some testing #1345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
927a259
fixess to middleware after some testing
StuartFerguson Oct 25, 2026
028f0bb
Merge branch 'feature/#1337_use_modern_structured_logging' of https:/…
StuartFerguson Oct 25, 2026
9d65dd6
Merge branch 'main' into feature/#1337_use_modern_structured_logging
StuartFerguson Oct 25, 2026
017f858
some more fixes
StuartFerguson Oct 25, 2026
27edc70
Merge branch 'feature/#1337_use_modern_structured_logging' of https:/…
StuartFerguson 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
64 changes: 41 additions & 23 deletions Shared.Tests/StructuredLoggingTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,14 +85,20 @@ public async Task Middleware_RedactsSensitiveQueryHeadersAndJsonBody()

StructuredLogEntry request = logger.Entries.ShouldHaveSingleItem();
request.Template.ShouldContain("{query}");
String query = JsonSerializer.Serialize(request.Arguments[3]);
request.Template.ShouldContain("{header_Authorization}");
request.Template.ShouldContain("{header_X_Request_Id}");
request.Template.ShouldNotContain("X-Unlisted");
String query = JsonSerializer.Serialize(GetStructuredValue(request, "query"));
query.ShouldContain("[REDACTED]");
query.ShouldContain("visible");
String headers = JsonSerializer.Serialize(request.Arguments[4]);
String headers = JsonSerializer.Serialize(new[]
{
GetStructuredValue(request, "header_Authorization"),
GetStructuredValue(request, "header_X_Request_Id")
});
headers.ShouldContain("[REDACTED]");
headers.ShouldContain("request-123");
headers.ShouldNotContain("X-Unlisted");
String body = request.Arguments[6]!.ToString()!;
String body = GetStructuredValue(request, "requestBody")!.ToString()!;
body.ShouldContain("[REDACTED]");
body.ShouldContain("alice");
String allFields = String.Join('|', request.Arguments);
Expand Down Expand Up @@ -127,22 +133,19 @@ public async Task Middleware_PreservesQueryAndHeaderCollectionsWithLegacyLogger(
}

[Fact]
public async Task Middleware_OmitsBodyWhenRequestExceedsConfiguredLimitAndRestoresRequestStream()
public async Task Middleware_RedactsRequestBodyAndRestoresRequestStream()
{
CapturingLogger logger = new();
Shared.Logger.Logger.Initialise(logger);
DefaultHttpContext context = CreateContext("{\"data\":\"123456789\"}", "application/json");
Stream originalBody = context.Request.Body;
RequestResponseLoggingMiddleware middleware = new(_ => Task.CompletedTask);

await middleware.Invoke(context, new RequestResponseMiddlewareLoggingConfig(LogLevel.Information, true, false)
{
MaximumRequestBodyBytes = 8
});
await middleware.Invoke(context, new RequestResponseMiddlewareLoggingConfig(LogLevel.Information, true, false));

StructuredLogEntry request = logger.Entries.ShouldHaveSingleItem();
request.Arguments[5].ShouldBe("size_limit");
request.Arguments[6].ShouldBeNull();
GetStructuredValue(request, "bodyStatus").ShouldBe("captured");
GetStructuredValue(request, "requestBody")!.ToString().ShouldContain("123456789");
context.Request.Body.ShouldBeSameAs(originalBody);
}

Expand All @@ -163,7 +166,7 @@ public async Task Middleware_RedactsSensitiveJsonResponseBodyAndPreservesRespons
await middleware.Invoke(context, new RequestResponseMiddlewareLoggingConfig(LogLevel.Information, false, true));

StructuredLogEntry log = logger.Entries.ShouldHaveSingleItem();
String body = log.Arguments[5]!.ToString()!;
String body = GetStructuredValue(log, "responseBody")!.ToString()!;
body.ShouldContain("[REDACTED]");
body.ShouldNotContain("response-secret");
context.Response.Body.Position = 0;
Expand All @@ -182,8 +185,8 @@ public async Task Middleware_ReportsUnsupportedBodyContentTypeWithoutLoggingPayl
await middleware.Invoke(context, new RequestResponseMiddlewareLoggingConfig(LogLevel.Information, true, false));

StructuredLogEntry request = logger.Entries.ShouldHaveSingleItem();
request.Arguments[5].ShouldBe("unsupported_content_type");
request.Arguments[6].ShouldBeNull();
GetStructuredValue(request, "bodyStatus").ShouldBe("unsupported_content_type");
GetStructuredValue(request, "requestBody").ShouldBeNull();
String.Join('|', request.Arguments).ShouldNotContain("binary-secret");
}

Expand All @@ -202,13 +205,13 @@ public async Task Middleware_RedactsSensitiveFormAndXmlFields(String contentType
await middleware.Invoke(context, new RequestResponseMiddlewareLoggingConfig(LogLevel.Information, true, false));

StructuredLogEntry request = logger.Entries.ShouldHaveSingleItem();
request.Arguments[6].ShouldBe(expectedBody);
String redactedBody = request.Arguments[6] as String ?? String.Empty;
GetStructuredValue(request, "requestBody").ShouldBe(expectedBody);
String redactedBody = GetStructuredValue(request, "requestBody") as String ?? String.Empty;
redactedBody.ShouldNotContain("body-secret");
}

[Fact]
public async Task Middleware_OmitsResponseBodyWhenItExceedsConfiguredLimit()
public async Task Middleware_RedactsResponseBodyWithoutSizeLimit()
{
CapturingLogger logger = new();
Shared.Logger.Logger.Initialise(logger);
Expand All @@ -220,14 +223,11 @@ public async Task Middleware_OmitsResponseBodyWhenItExceedsConfiguredLimit()
return inner.Response.WriteAsync(payload, TestContext.Current.CancellationToken);
});

await middleware.Invoke(context, new RequestResponseMiddlewareLoggingConfig(LogLevel.Information, false, true)
{
MaximumResponseBodyBytes = 8
});
await middleware.Invoke(context, new RequestResponseMiddlewareLoggingConfig(LogLevel.Information, false, true));

StructuredLogEntry response = logger.Entries.ShouldHaveSingleItem();
response.Arguments[4].ShouldBe("size_limit");
response.Arguments[5].ShouldBeNull();
GetStructuredValue(response, "bodyStatus").ShouldBe("captured");
GetStructuredValue(response, "responseBody")!.ToString().ShouldContain("a value larger than the limit");
context.Response.Body.Position = 0;
using StreamReader reader = new(context.Response.Body, Encoding.UTF8, leaveOpen: true);
(await reader.ReadToEndAsync(TestContext.Current.CancellationToken)).ShouldBe(payload);
Expand All @@ -244,6 +244,24 @@ private static DefaultHttpContext CreateContext(String body, String? contentType
return context;
}

private static Object? GetStructuredValue(StructuredLogEntry entry, String propertyName)
{
Int32 argumentIndex = 0;
Int32 searchFrom = 0;
while (true)
{
Int32 placeholderStart = entry.Template.IndexOf('{', searchFrom);
if (placeholderStart < 0) break;
Int32 placeholderEnd = entry.Template.IndexOf('}', placeholderStart + 1);
if (placeholderEnd < 0) break;
String currentProperty = entry.Template.Substring(placeholderStart + 1, placeholderEnd - placeholderStart - 1);
if (currentProperty == propertyName) return entry.Arguments[argumentIndex];
argumentIndex++;
searchFrom = placeholderEnd + 1;
}
throw new InvalidOperationException($"Structured property '{propertyName}' was not found in the log template.");
}

private sealed record StructuredLogEntry(String Template, Object?[] Arguments, LogLevel Level);

private sealed class CapturingLogger : Shared.Logger.ILogger
Expand Down
Loading
Loading