如何处理 HotChocolate 中的输入错误？

Question

我有 Asp.Net Core Api 和由 HotChocolate 集成的 Graphql。我有输入类型为 CreateRoadmapInput 的突变 CreateRoadmap。 My Mutation。 My input type.

我需要正确验证这些输入字段。我尝试使用 IErrorFilter.My Error Filter I managed to customize error messages, but it always returns 500 status code and doesn't specify the field that has invalid input value. For example: client may send one field of GraphQl variable as float(with dot and numbers after it). In this case, i got Internal Server Error with status code 500 and the error message. Response with invalid input Response Body。俄语翻译：“输入数据无效：字段值无效：请输入整数”

我想要的：

在无效输入的情况下给出 400（错误请求）状态代码。
指定哪些字段具有无效值

抱歉我的英语不好。希望你理解这个问题。感谢您的帮助！

我的变异

public ObjectPayload<Roadmap> CreateRoadmap(
        CreateRoadmapInput obj,
        [Service] IServiceFactory<Roadmap> serviceFactory)
    {
        try
        {
            var roadmapService = serviceFactory.CreateServiceInstance(obj.WorkerType);
            var roadmap = roadmapService.Create(obj);

            return new ObjectPayload<Roadmap>(roadmap);
        }
        catch (Exception e)
        {
            return new ObjectPayload<Roadmap>(
                new UserError(e.Message, "EXECUTION_ERROR"));
        }
    }

Mu 输入类型

public class CreateRoadmapInput : InputBase
{
    
    public int WorkerId { get; set; }
    public RoadmapType Type { get; set; }
    public int Period { get; set; }
    public int Year { get; set; }
    public int ProcessPercent { get; set; }
    public int ProjectPercent { get; set; }
    public WorkerType WorkerType { get; set; }
}

我的错误过滤器

public class ErrorHandling : IErrorFilter
{
    public IError OnError(IError error)
    {
        error = error.RemoveExtensions().RemoveLocations().RemoveCode();
        if (error.Message.Contains("got an invalid value"))
        {
            if (error.Exception.Message.Contains("Int cannot parse the given literal of type"))
                return error.WithMessage($"Некорректные вводимые данные: Неверное значение поля. Введите целое число");
            else
                return error.WithMessage($"Некорректные вводимые данные: {error.Exception.Message}");
        }
        return error.WithMessage(error.Exception.Message);
    }
}

Answer 1

您可以尝试使用社区维护的软件包之一进行输入验证

https://github.com/ChilliCream/hotchocolate/blob/develop/COMMUNITY.md#validation

或者通过提供的代码示例编写您自己的代码

Answer 2

graphql 处理管道分为验证和执行。据我了解，Sergey Shaykhullin 提出的用于输入验证的自定义库仅在执行阶段开始参与该过程。但是你提到的变量的情况是 a part of 验证阶段。实际上，11.2.2 版本的 HotChocolate 验证引擎为您提供了您需要的所有数据（即具体的错误代码和变量名称） “扩展”字段：

{
    "errors": [
        {
            "message": "Variable `someInt` got an invalid value.",
            "locations": [
                {
                    "line": 1,
                    "column": 21
                }
            ],
            "extensions": {
                "code": "HC0016",
                "variable": "someInt",
                "underlyingError": "Int cannot parse the given literal of type `StringValueNode`."
            }
        }
    ]
}

关于状态码400的第二个问题，是的，错误500在这里真的很奇怪。我认为验证错误的错误 500 不符合 graphql over http 规范。规范明确指出

"The server SHOULD deny execution with a status code of 400"

要解决这个问题，您可以编写 your own result serializer。在最简单的形式中，它可能类似于下面的形式：

public class HttpResultSerializerWithCustomStatusCodes : DefaultHttpResultSerializer
    {
        public override HttpStatusCode GetStatusCode(IExecutionResult result)
        {
            var baseStatusCode = base.GetStatusCode(result);

            if (result is IQueryResult && baseStatusCode == HttpStatusCode.InternalServerError && result.Errors?.Count > 0)
            {
                if (result.Errors.Any(e => e.Code == ErrorCodes.Authentication.NotAuthorized || e.Code == ErrorCodes.Authentication.NotAuthenticated))
                    return HttpStatusCode.Forbidden;    

                return HttpStatusCode.BadRequest;    

            }

            return baseStatusCode;
        }
    }

如何处理 HotChocolate 中的输入错误？

How can I handle input errors in HotChocolate?

c#

asp.net-core

graphql

hotchocolate