Skip to content

Return bad request as ValidationProblemDetails #288

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
alexeyzimarev merged 3 commits into from
Nov 16, 2023
Merged

Return bad request as ValidationProblemDetails #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0439038
Return bad request as ValidationProblemDetails
LockTar Nov 8, 2023
f32f902
Merge branch 'dev' into f/400-as-validationproblemdetails
LockTar Nov 14, 2023
07ab9e3
Merge branch 'dev' into f/400-as-validationproblemdetails
alexeyzimarev Nov 15, 2023
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
41 changes: 36 additions & 5 deletions src/Extensions/src/Eventuous.AspNetCore.Web/Http/CommandHttpApiBase'TResult.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
// Copyright (C) Ubiquitous AS.All rights reserved
// Licensed under the Apache License, Version 2.0.

using Microsoft.AspNetCore.Mvc.Formatters;
using Microsoft.AspNetCore.Http;

namespace Eventuous.AspNetCore.Web;

/// <summary>
Expand Down Expand Up @@ -46,12 +49,40 @@ protected async Task<ActionResult<TResult>> Handle<TContract, TCommand>(TContrac
return AsActionResult<TAggregate>(result);
}

static ActionResult<TResult> AsActionResult<T>(Result result) where T : Aggregate
=> result is ErrorResult error
protected virtual ActionResult<TResult> AsActionResult<T>(Result result) where T : Aggregate {
Comment thread
alexeyzimarev marked this conversation as resolved.
return result is ErrorResult error
? error.Exception switch {
OptimisticConcurrencyException<T> => new ConflictObjectResult(error),
AggregateNotFoundException<T> => new NotFoundObjectResult(error),
_ => new BadRequestObjectResult(error)
OptimisticConcurrencyException<T> => AsProblemResult(StatusCodes.Status409Conflict),
AggregateNotFoundException<T> => AsProblemResult(StatusCodes.Status404NotFound),
DomainException => AsValidationProblemResult(StatusCodes.Status400BadRequest),
_ => AsProblemResult(StatusCodes.Status500InternalServerError)
}
: new OkObjectResult(result);

ActionResult AsProblemResult(int statusCode)
=> new ObjectResult(
new ProblemDetails {
Status = statusCode,
Title = error.ErrorMessage,
Detail = error.Exception?.ToString(),
Type = error.Exception?.GetType().Name
}
) {
StatusCode = StatusCodes.Status400BadRequest,
ContentTypes = new MediaTypeCollection { ContentTypes.ProblemDetails },
};

ActionResult AsValidationProblemResult(int statusCode)
=> new ObjectResult(
new ValidationProblemDetails(new Dictionary<string, string[]> { ["Domain"] = [error.ErrorMessage] }) {
Status = statusCode,
Title = error.ErrorMessage,
Detail = error.Exception?.ToString(),
Type = error.Exception?.GetType().Name
}
) {
StatusCode = StatusCodes.Status400BadRequest,
ContentTypes = new MediaTypeCollection { ContentTypes.ProblemDetails },
};
}
}
41 changes: 36 additions & 5 deletions src/Extensions/src/Eventuous.AspNetCore.Web/Http/CommandHttpApiBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
// Copyright (C) Ubiquitous AS. All rights reserved
// Licensed under the Apache License, Version 2.0.

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc.Formatters;

namespace Eventuous.AspNetCore.Web;

/// <summary>
Expand Down Expand Up @@ -44,12 +47,40 @@ protected async Task<ActionResult> Handle<TContract, TCommand>(TContract httpCom
return AsActionResult<TAggregate>(result);
}

static ActionResult AsActionResult<T>(Result result) where T : Aggregate
=> result is ErrorResult error
protected virtual ActionResult AsActionResult<T>(Result result) where T : Aggregate {
return result is ErrorResult error
? error.Exception switch {
OptimisticConcurrencyException<T> => new ConflictObjectResult(error),
AggregateNotFoundException<T> => new NotFoundObjectResult(error),
_ => new BadRequestObjectResult(error)
OptimisticConcurrencyException<T> => AsProblemResult(StatusCodes.Status409Conflict),
AggregateNotFoundException<T> => AsProblemResult(StatusCodes.Status404NotFound),
DomainException => AsValidationProblemResult(StatusCodes.Status400BadRequest),
_ => AsProblemResult(StatusCodes.Status500InternalServerError)
}
: new OkObjectResult(result);

ActionResult AsProblemResult(int statusCode)
=> new ObjectResult(
new ProblemDetails {
Status = statusCode,
Title = error.ErrorMessage,
Detail = error.Exception?.ToString(),
Type = error.Exception?.GetType().Name
}
) {
StatusCode = StatusCodes.Status400BadRequest,
ContentTypes = new MediaTypeCollection { ContentTypes.ProblemDetails },
};

ActionResult AsValidationProblemResult(int statusCode)
=> new ObjectResult(
new ValidationProblemDetails(new Dictionary<string, string[]> { ["Domain"] = [error.ErrorMessage] }) {
Status = statusCode,
Title = error.ErrorMessage,
Detail = error.Exception?.ToString(),
Type = error.Exception?.GetType().Name
}
) {
StatusCode = StatusCodes.Status400BadRequest,
ContentTypes = new MediaTypeCollection { ContentTypes.ProblemDetails },
};
}
}
4 changes: 2 additions & 2 deletions src/Extensions/src/Eventuous.AspNetCore.Web/Http/HttpCommandMapping.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ async Task<IResult> (HttpContext context, ICommandService<TAggregate> service) =
.ProducesProblemDetails(Status404NotFound)
.ProducesProblemDetails(Status409Conflict)
.ProducesProblemDetails(Status500InternalServerError)
.ProducesProblemDetails(Status400BadRequest);
.ProducesValidationProblemDetails(Status400BadRequest);

routeBuilder.AddPolicy(policyName);
routeBuilder.AddAuthorization(typeof(TContract));
Expand Down Expand Up @@ -247,7 +247,7 @@ async Task<IResult> (HttpContext context) => {
.ProducesOk(resultType)
.ProducesProblemDetails(Status404NotFound)
.ProducesProblemDetails(Status409Conflict)
.ProducesProblemDetails(Status400BadRequest)
.ProducesValidationProblemDetails(Status400BadRequest)
.ProducesProblemDetails(Status500InternalServerError);

routeBuilder.AddPolicy(policyName);
Expand Down
26 changes: 24 additions & 2 deletions src/Extensions/src/Eventuous.AspNetCore.Web/Http/ResultExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public static IResult AsResult<TResult>(this Result result) where TResult : Resu
? error.Exception switch {
OptimisticConcurrencyException => AsProblemDetails(Status409Conflict, error),
AggregateNotFoundException => AsProblemDetails(Status404NotFound, error),
DomainException => AsProblemDetails(Status400BadRequest, error),
DomainException => AsValidationProblemDetails(Status400BadRequest, error),
_ => AsProblemDetails(Status500InternalServerError, error)
}
: Results.Ok(result);
Expand All @@ -29,12 +29,21 @@ static IResult AsProblemDetails(int statusCode, ErrorResult error)
}
);

static IResult AsValidationProblemDetails(int statusCode, ErrorResult error)
=> Results.ValidationProblem(
errors: new Dictionary<string, string[]> { ["Domain"] = [error.ErrorMessage] },
statusCode: statusCode,
title: error.ErrorMessage,
detail: error.Exception?.ToString(),
type: error.Exception?.GetType().Name
);

public static ActionResult<Result<T>> AsActionResult<T>(this Result result) where T : State<T>, new() {
return result is ErrorResult error
? error.Exception switch {
OptimisticConcurrencyException => AsProblemResult(Status409Conflict),
AggregateNotFoundException => AsProblemResult(Status404NotFound),
DomainException => AsProblemResult(Status400BadRequest),
DomainException => AsValidationProblemResult(Status400BadRequest),
_ => AsProblemResult(Status500InternalServerError)
}
: new OkObjectResult(result);
Expand All @@ -51,5 +60,18 @@ ActionResult AsProblemResult(int statusCode)
StatusCode = Status400BadRequest,
ContentTypes = new MediaTypeCollection { ContentTypes.ProblemDetails },
};

ActionResult AsValidationProblemResult(int statusCode)
=> new ObjectResult(
new ValidationProblemDetails(new Dictionary<string, string[]> { ["Domain"] = [error.ErrorMessage] }) {
Status = statusCode,
Title = error.ErrorMessage,
Detail = error.Exception?.ToString(),
Type = error.Exception?.GetType().Name
}
) {
StatusCode = Status400BadRequest,
ContentTypes = new MediaTypeCollection { ContentTypes.ProblemDetails },
};
Comment thread
alexeyzimarev marked this conversation as resolved.
}
}
7 changes: 5 additions & 2 deletions src/Extensions/src/Eventuous.AspNetCore.Web/Http/RouteHandlerBuilderExt.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,21 @@
namespace Eventuous.AspNetCore.Web;

static class RouteHandlerBuilderExt {
public static RouteHandlerBuilder ProducesValidationProblemDetails(this RouteHandlerBuilder builder, int statusCode)
=> builder.Produces<ValidationProblemDetails>(statusCode, ContentTypes.ProblemDetails);

public static RouteHandlerBuilder ProducesProblemDetails(this RouteHandlerBuilder builder, int statusCode)
=> builder.Produces<ProblemDetails>(statusCode, ContentTypes.ProblemDetails);

public static RouteHandlerBuilder ProducesOk(this RouteHandlerBuilder builder, Type resultType)
=> builder.Produces(StatusCodes.Status200OK, resultType, ContentTypes.Json);

public static RouteHandlerBuilder ProducesOk<T>(this RouteHandlerBuilder builder) where T : Result
=> builder.ProducesOk(typeof(T));

public static RouteHandlerBuilder Accepts(this RouteHandlerBuilder builder, Type commandType)
=> builder.Accepts(commandType, false, ContentTypes.Json);

public static RouteHandlerBuilder Accepts<T>(this RouteHandlerBuilder builder)
=> builder.Accepts(typeof(T));
}