Skip to content

Handle null HttpRequest in AspNetCore naming #7699

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Handle null HttpRequest in AspNetCore naming #7699

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 21 additions & 5 deletions tracer/src/Datadog.Trace/PlatformHelpers/AspNetCoreHttpRequestHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,30 @@ public AspNetCoreHttpRequestHandler(

public string GetDefaultResourceName(HttpRequest request)
{
// Be defensive: in some edge cases the HttpRequest object may be null (e.g.,
// framework- or host-specific error paths). Avoid throwing and return a safe default.
if (request is null)
{
return "UNKNOWN /";
}

string httpMethod = request.Method?.ToUpperInvariant() ?? "UNKNOWN";

string absolutePath = request.PathBase.HasValue
? request.PathBase.ToUriComponent() + request.Path.ToUriComponent()
: request.Path.ToUriComponent();
string absolutePath;
try
{
absolutePath = request.PathBase.HasValue
? request.PathBase.ToUriComponent() + request.Path.ToUriComponent()
: request.Path.ToUriComponent();
}
catch
{
// If anything goes wrong building the path, fall back to root
absolutePath = "/";
}

string resourceUrl = UriHelpers.GetCleanUriPath(absolutePath)
.ToLowerInvariant();
var cleanedPath = UriHelpers.GetCleanUriPath(absolutePath);
string resourceUrl = (cleanedPath ?? "/").ToLowerInvariant();

return $"{httpMethod} {resourceUrl}";
}
Expand Down
15 changes: 15 additions & 0 deletions tracer/test/Datadog.Trace.Tests/PlatformHelpers/AspNetCoreHttpRequestHandlerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

#if !NETFRAMEWORK
using Datadog.Trace.PlatformHelpers;
using Datadog.Trace.Configuration;
using Datadog.Trace.Logging;
using FluentAssertions;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Http.Internal;
Expand All @@ -16,6 +18,19 @@ public class AspNetCoreHttpRequestHandlerTests
{
public const string OriginalPath = "/somepath/Home/Index";

[Fact]
public void GetDefaultResourceName_ReturnsUnknownSlash_WhenRequestIsNull()
{
var handler = new AspNetCoreHttpRequestHandler(
DatadogLogging.GetLoggerFor<AspNetCoreHttpRequestHandlerTests>(),
"aspnet_core.request",
IntegrationId.AspNetCore);

var result = handler.GetDefaultResourceName(null);

result.Should().Be("UNKNOWN /");
}

[Theory]
[InlineData(null, "/somepath/Home/Index")]
[InlineData("", "/somepath/Home/Index")]
Expand Down
Loading