Skip to content

Don't capture HttpContext into the log objects #11723

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

Closed
benaadams wants to merge 1 commit into from
Closed

Don't capture HttpContext into the log objects #11723

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
14 changes: 8 additions & 6 deletions src/Hosting/Hosting/src/Internal/HostingRequestFinishedLog.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ internal class HostingRequestFinishedLog : IReadOnlyList<KeyValuePair<string, ob
{
internal static readonly Func<object, Exception, string> Callback = (state, exception) => ((HostingRequestFinishedLog)state).ToString();

private readonly HttpContext _httpContext;
private readonly string _contentType;
private readonly int _statusCode;
private readonly TimeSpan _elapsed;

private string _cachedToString;
Expand All @@ -29,9 +30,9 @@ public KeyValuePair<string, object> this[int index]
case 0:
return new KeyValuePair<string, object>("ElapsedMilliseconds", _elapsed.TotalMilliseconds);
case 1:
return new KeyValuePair<string, object>("StatusCode", _httpContext.Response.StatusCode);
return new KeyValuePair<string, object>("StatusCode", _statusCode);
case 2:
return new KeyValuePair<string, object>("ContentType", _httpContext.Response.ContentType);
return new KeyValuePair<string, object>("ContentType", _contentType);
default:
throw new IndexOutOfRangeException(nameof(index));
}
Expand All @@ -40,7 +41,8 @@ public KeyValuePair<string, object> this[int index]

public HostingRequestFinishedLog(HttpContext httpContext, TimeSpan elapsed)
{
_httpContext = httpContext;
_contentType = httpContext.Response.ContentType;
_statusCode = httpContext.Response.StatusCode;
_elapsed = elapsed;
}

Expand All @@ -52,8 +54,8 @@ public override string ToString()
CultureInfo.InvariantCulture,
"Request finished in {0}ms {1} {2}",
_elapsed.TotalMilliseconds,
_httpContext.Response.StatusCode,
_httpContext.Response.ContentType);
_statusCode,
_contentType);
}

return _cachedToString;
Expand Down
58 changes: 38 additions & 20 deletions src/Hosting/Hosting/src/Internal/HostingRequestStartingLog.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,15 @@ internal class HostingRequestStartingLog : IReadOnlyList<KeyValuePair<string, ob
{
internal static readonly Func<object, Exception, string> Callback = (state, exception) => ((HostingRequestStartingLog)state).ToString();

private readonly HttpRequest _request;
public string Protocol { get; }
public string Method { get; }
public string ContentType { get; }
public long? ContentLength { get; }
public string Scheme { get; }
public string Host { get; }
public string PathBase { get; }
public string Path { get; }
public string QueryString { get; }

private string _cachedToString;

Expand All @@ -26,23 +34,23 @@ public KeyValuePair<string, object> this[int index]
switch (index)
{
case 0:
return new KeyValuePair<string, object>("Protocol", _request.Protocol);
return new KeyValuePair<string, object>("Protocol", Protocol);
case 1:
return new KeyValuePair<string, object>("Method", _request.Method);
return new KeyValuePair<string, object>("Method", Method);
case 2:
return new KeyValuePair<string, object>("ContentType", _request.ContentType);
return new KeyValuePair<string, object>("ContentType", ContentType);
case 3:
return new KeyValuePair<string, object>("ContentLength", _request.ContentLength);
return new KeyValuePair<string, object>("ContentLength", ContentLength);
case 4:
return new KeyValuePair<string, object>("Scheme", _request.Scheme);
return new KeyValuePair<string, object>("Scheme", Scheme);
case 5:
return new KeyValuePair<string, object>("Host", _request.Host.ToString());
return new KeyValuePair<string, object>("Host", Host);
case 6:
return new KeyValuePair<string, object>("PathBase", _request.PathBase.ToString());
return new KeyValuePair<string, object>("PathBase", PathBase);
case 7:
return new KeyValuePair<string, object>("Path", _request.Path.ToString());
return new KeyValuePair<string, object>("Path", Path);
case 8:
return new KeyValuePair<string, object>("QueryString", _request.QueryString.ToString());
return new KeyValuePair<string, object>("QueryString", QueryString);
default:
throw new IndexOutOfRangeException(nameof(index));
}
Expand All @@ -51,7 +59,17 @@ public KeyValuePair<string, object> this[int index]

public HostingRequestStartingLog(HttpContext httpContext)
{
_request = httpContext.Request;
var request = httpContext.Request;

Protocol = request.Protocol;
Method = request.Method;
ContentType = !string.IsNullOrEmpty(request.ContentType) ? Uri.EscapeUriString(request.ContentType) : string.Empty;
Copy link
Copy Markdown
Member

@davidfowl davidfowl Jul 22, 2019

Choose a reason for hiding this comment

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

Allocations!

ContentLength = request.ContentLength;
Scheme = request.Scheme;
Host = request.Host.Value;
PathBase = request.PathBase.Value;
Path = request.Path.Value;
QueryString = request.QueryString.Value;
}

public override string ToString()
Expand All @@ -61,15 +79,15 @@ public override string ToString()
_cachedToString = string.Format(
CultureInfo.InvariantCulture,
"Request starting {0} {1} {2}://{3}{4}{5}{6} {7} {8}",
_request.Protocol,
_request.Method,
_request.Scheme,
_request.Host.Value,
_request.PathBase.Value,
_request.Path.Value,
_request.QueryString.Value,
_request.ContentType,
_request.ContentLength);
Protocol,
Method,
Scheme,
Host,
PathBase,
Path,
QueryString,
ContentType,
ContentLength);
}

return _cachedToString;
Expand Down
1 change: 1 addition & 0 deletions src/Hosting/Hosting/test/HostingApplicationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -428,6 +428,7 @@ private static HostingApplication CreateApplication(out FeatureCollection featur

features = new FeatureCollection();
features.Set<IHttpRequestFeature>(new HttpRequestFeature());
features.Set<IHttpResponseFeature>(new HttpResponseFeature());
var context = new DefaultHttpContext(features);
configure?.Invoke(context);
httpContextFactory.Setup(s => s.Create(It.IsAny<IFeatureCollection>())).Returns(context);
Expand Down