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

Question

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

---

我需要正确验证这些输入的字段。我尝试使用 IErrorFilter.My Error Filter 我设法自定义错误消息，但它总是返回 500 状态代码并且没有指定具有无效输入值的字段。例如：客户端可以将 GraphQl 变量的一个字段作为浮点数发送（后面带有点和数字）。在这种情况下，我收到了状态代码为 500 的内部服务器错误和错误消息。 Response with invalid inputResponse Body。俄语翻译：“输入数据无效：字段值无效：请输入整数”

---

我想要什么：

1. 在输入无效的情况下给出 400(Bad Request) 状态码。
2. 指定哪些字段的值无效

对不起，我的英语不好。希望你明白这个问题。感谢您的帮助！

---

我的突变

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

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 规范。该规范明确指出

“服务器应该拒绝执行，状态码为 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;
        }
    }

Answer 2

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

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

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