Feature/build error type response

[Wellingtonbsjr]

Summary

Create method WithRuleType in validation, to override property name with Prefix and Type.

How to use method WithRuleType in validation?

RuleFor(x => x.Text)
                .NotEmpty()
                .WithMessage("Text can't be null")
                .WithRuleType("SOME_RULE");

How property name stay?

{Prefix}.{RuleType}.{PropertyName}
_RuleType.SOME_RULE.Text

Why use it?
To identify Rules in InvalidModelStateResponseFactory and customize the HTTP response.

public static class MvcBuilderExtensions
{
    private const string PropertyDefault = "msg";

    /// <summary>
    /// Configure the custom bad request response format for all validation errors (model binding and ModelValidationFilter).
    /// </summary>
    /// <param name="builder"></param>
    /// <returns></returns>
    public static IMvcBuilder ConfigureValidationResponseFormat(this IMvcBuilder builder)
    {
        builder.ConfigureApiBehaviorOptions(options =>
        {
            options.InvalidModelStateResponseFactory = context =>
            {
                var response = new ErrorResponse
                {
                    Error = new Dictionary<string, string[]>(),
                    Type = GetRuleType(context)
                };

                foreach (var (key, value) in context.ModelState.Where(x => x.Value.Errors.Any()))
                {
                    var errorMessage = value.Errors.Select(e => e.ErrorMessage).ToArray();
                    var errorKey = key.Contains(RuleTypeConst.Prefix) ? PropertyDefault : key;
                    response.Error.Add(errorKey, errorMessage);
                }

                return new BadRequestObjectResult(response);
            };
        });

        return builder;
    }

    private static string GetRuleType(ActionContext context)
    {
        var type = "ERROR_DEFAULT";

        var errorType = context.ModelState.LastOrDefault(error => error.Key.Contains(RuleTypeConst.Prefix));

        if (!string.IsNullOrEmpty(errorType.Key))
            type = GetRuleType(errorType.Key);

        return type;
    }

    private static string GetRuleType(string key) =>
        key.Split('.')[1];
}

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

100.0% Coverage
0.0% Duplication

[luizhlelis]

question: maybe I'm missing something here, but is this prefix really required?

[Wellingtonbsjr]

@luizhlelis this prefix is important to set correctly type in response.
We only set type, if exists an internal ErrorCode with this prefix.

[luizhlelis]

thought: we're gonna need to use the same extension method WithErrorCode in #8, but I think we can use it in both scenarios. We can set some predefined words as ErrorCodes to change the response status code.

[Wellingtonbsjr]

Nice @luizhlelis, make sense.
We can use a new Enum.ErrorsStatusCode in this lib, creating a new method like "WithStatusCode(Enum.ErrorsStatusCode)".

[Wellingtonbsjr]

We create other branch feature/customer-main, to follow this:
1 - Change lib to response Bad Request with the format defined in the ower playbook.

{
    "error": {
        "Cnpj": [
            "O CNPJ do cliente deve ter 14 caracteres"
        ]
    },
    "type": "VALIDATION_ERRORS"
}

2 - Apply branch feature/customer-main in customer project;
3 - Later apply these changes to the branch main.