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

问题描述

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

我需要正确验证这些输入的字段。我尝试使用 IErrorFilter。My Error Filter 我设法自定义了错误消息，但它始终返回 500 状态代码并且没有指定具有无效输入值的字段。例如：客户端可以将 GraphQl 变量的一个字段作为浮点数（后面有点和数字）发送。在这种情况下，我收到了带有状态代码 500 和错误消息的内部服务器错误。 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);
    }
}

解决方法

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

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

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

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;
        }
    }

asp.net-core c#c#graphql graphql hotchocolate