Skip to content

Use ProblemDetails.Status to configure ObjectResult.StatusCode #17565

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 1 commit into from
Dec 4, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,10 @@ internal static IActionResult ProblemDetailsInvalidModelStateResponse(ProblemDet
}
else
{
result = new ObjectResult(problemDetails);
result = new ObjectResult(problemDetails)
{
StatusCode = problemDetails.Status,
};
}
result.ContentTypes.Add("application/problem+json");
result.ContentTypes.Add("application/problem+xml");
Expand Down
17 changes: 12 additions & 5 deletions src/Mvc/Mvc.Core/src/ObjectResult.cs
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,22 @@ public virtual void OnFormatting(ActionContext context)
throw new ArgumentNullException(nameof(context));
}

if (StatusCode.HasValue)
if (Value is ProblemDetails details)
{
context.HttpContext.Response.StatusCode = StatusCode.Value;

if (Value is ProblemDetails details && !details.Status.HasValue)
if (details.Status != null && StatusCode == null)
{
StatusCode = details.Status;
}
else if (details.Status == null && StatusCode != null)
{
details.Status = StatusCode.Value;
details.Status = StatusCode;
}
}

if (StatusCode.HasValue)
{
context.HttpContext.Response.StatusCode = StatusCode.Value;
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Infrastructure;
using Microsoft.AspNetCore.Mvc.ModelBinding;
using Moq;
using Xunit;

namespace Microsoft.Extensions.DependencyInjection
Expand Down Expand Up @@ -70,6 +72,29 @@ public void ProblemDetailsInvalidModelStateResponse_UsesUserConfiguredLink()
Assert.Equal(link, problemDetails.Type);
}

[Fact]
public void ProblemDetailsInvalidModelStateResponse_UsesProblemDetailsFactory()
{
// Arrange
var actionContext = GetActionContext();
var factory = Mock.Of<ProblemDetailsFactory>(m => m.CreateValidationProblemDetails(It.IsAny<HttpContext>(), It.IsAny<ModelStateDictionary>(), null, null, null, null, null) == new ValidationProblemDetails
{
Status = 422,
});

// Act
var result = ApiBehaviorOptionsSetup.ProblemDetailsInvalidModelStateResponse(factory, actionContext);

// Assert
var objectResult = Assert.IsType<ObjectResult>(result);
Assert.Equal(422, objectResult.StatusCode);
Assert.Equal(new[] { "application/problem+json", "application/problem+xml" }, objectResult.ContentTypes.OrderBy(c => c));

var problemDetails = Assert.IsType<ValidationProblemDetails>(objectResult.Value);
Assert.Equal(422, problemDetails.Status);
Assert.Equal("One or more validation errors occurred.", problemDetails.Title);
}

[Fact]
public void ProblemDetailsInvalidModelStateResponse_SetsTraceId()
{
Expand Down
62 changes: 62 additions & 0 deletions src/Mvc/Mvc.Core/test/ObjectResultTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,68 @@ public async Task ObjectResult_ExecuteResultAsync_SetsProblemDetailsStatus()
Assert.Equal(StatusCodes.Status422UnprocessableEntity, details.Status.Value);
}

[Fact]
public async Task ObjectResult_ExecuteResultAsync_GetsStatusCodeFromProblemDetails()
{
// Arrange
var details = new ProblemDetails { Status = StatusCodes.Status413RequestEntityTooLarge, };

var result = new ObjectResult(details)
{
Formatters = new FormatterCollection<IOutputFormatter>()
{
new NoOpOutputFormatter(),
},
};

var actionContext = new ActionContext()
{
HttpContext = new DefaultHttpContext()
{
RequestServices = CreateServices(),
}
};

// Act
await result.ExecuteResultAsync(actionContext);

// Assert
Assert.Equal(StatusCodes.Status413RequestEntityTooLarge, details.Status.Value);
Assert.Equal(StatusCodes.Status413RequestEntityTooLarge, result.StatusCode.Value);
Assert.Equal(StatusCodes.Status413RequestEntityTooLarge, actionContext.HttpContext.Response.StatusCode);
}

[Fact]
public async Task ObjectResult_ExecuteResultAsync_ResultAndProblemDetailsHaveStatusCodes()
{
// Arrange
var details = new ProblemDetails { Status = StatusCodes.Status422UnprocessableEntity, };

var result = new BadRequestObjectResult(details)
{
Formatters = new FormatterCollection<IOutputFormatter>()
{
new NoOpOutputFormatter(),
},
};

var actionContext = new ActionContext()
{
HttpContext = new DefaultHttpContext()
{
RequestServices = CreateServices(),
}
};

// Act
await result.ExecuteResultAsync(actionContext);

// Assert
Assert.Equal(StatusCodes.Status422UnprocessableEntity, details.Status.Value);
Assert.Equal(StatusCodes.Status400BadRequest, result.StatusCode.Value);
Assert.Equal(StatusCodes.Status400BadRequest, actionContext.HttpContext.Response.StatusCode);
}

private static IServiceProvider CreateServices()
{
var services = new ServiceCollection();
Expand Down