-
Notifications
You must be signed in to change notification settings - Fork 10.4k
Cleanup Results helper #34296
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.
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
Merged
Cleanup Results helper #34296
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,6 @@ | ||
// Copyright (c) .NET Foundation. All rights reserved. | ||
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. | ||
|
||
using System.Threading.Tasks; | ||
using Microsoft.AspNetCore.Http.Extensions; | ||
using Microsoft.AspNetCore.Mvc; | ||
using Microsoft.Extensions.DependencyInjection; | ||
|
@@ -42,7 +41,7 @@ public Task ExecuteAsync(HttpContext httpContext) | |
{ | ||
var loggerFactory = httpContext.RequestServices.GetRequiredService<ILoggerFactory>(); | ||
var logger = loggerFactory.CreateLogger(GetType()); | ||
Log.ObjectResultExecuting(logger, Value); | ||
Log.ObjectResultExecuting(logger, Value, StatusCode); | ||
|
||
if (Value is ProblemDetails problemDetails) | ||
{ | ||
|
@@ -54,10 +53,25 @@ public Task ExecuteAsync(HttpContext httpContext) | |
httpContext.Response.StatusCode = statusCode; | ||
} | ||
|
||
ConfigureResponseHeaders(httpContext); | ||
|
||
if (Value is null) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Shouldn't this go earlier? |
||
{ | ||
return Task.CompletedTask; | ||
} | ||
|
||
OnFormatting(httpContext); | ||
return httpContext.Response.WriteAsJsonAsync(Value); | ||
} | ||
|
||
protected virtual void OnFormatting(HttpContext httpContext) | ||
{ | ||
} | ||
|
||
protected virtual void ConfigureResponseHeaders(HttpContext httpContext) | ||
{ | ||
} | ||
|
||
private void ApplyProblemDetailsDefaults(ProblemDetails problemDetails) | ||
{ | ||
// We allow StatusCode to be specified either on ProblemDetails or on the ObjectResult and use it to configure the other. | ||
|
@@ -89,23 +103,29 @@ private void ApplyProblemDetailsDefaults(ProblemDetails problemDetails) | |
} | ||
} | ||
|
||
protected virtual void OnFormatting(HttpContext httpContext) | ||
{ | ||
} | ||
|
||
private static partial class Log | ||
{ | ||
public static void ObjectResultExecuting(ILogger logger, object? value) | ||
public static void ObjectResultExecuting(ILogger logger, object? value, int? statusCode) | ||
{ | ||
if (logger.IsEnabled(LogLevel.Information)) | ||
{ | ||
var valueType = value is null ? "null" : value.GetType().FullName!; | ||
ObjectResultExecuting(logger, valueType); | ||
if (value is null) | ||
{ | ||
ObjectResultExecutingWithoutValue(logger, statusCode ?? StatusCodes.Status200OK); | ||
} | ||
else | ||
{ | ||
var valueType = value.GetType().FullName!; | ||
ObjectResultExecuting(logger, valueType, statusCode ?? StatusCodes.Status200OK); | ||
} | ||
} | ||
} | ||
|
||
[LoggerMessage(1, LogLevel.Information, "Writing value of type '{Type}'.", EventName = "ObjectResultExecuting", SkipEnabledCheck = true)] | ||
public static partial void ObjectResultExecuting(ILogger logger, string type); | ||
[LoggerMessage(1, LogLevel.Information, "Writing value of type '{Type}' with status code '{StatusCode}'.", EventName = "ObjectResultExecuting", SkipEnabledCheck = true)] | ||
private static partial void ObjectResultExecuting(ILogger logger, string type, int statusCode); | ||
|
||
[LoggerMessage(2, LogLevel.Information, "Executing result with status code '{StatusCode}'.", EventName = "ObjectResultExecutingWithoutValue", SkipEnabledCheck = true)] | ||
private static partial void ObjectResultExecutingWithoutValue(ILogger logger, int statusCode); | ||
} | ||
} | ||
} |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah hah! That was the bug!