在 graphql 中执行多个突变时正确的错误处理

Question

考虑到以下 GraphQL 突变：

type Mutation {
  updateUser(id: ID!, newEmail: String!): User
  updatePost(id: ID!, newTitle: String!): Post
}

Apollo 文档指出，完全有可能在一个请求中执行多个突变，例如

mutation($userId: ID!, $newEmail: String!, $postId: ID!, $newTitle: String!) {
  updateUser(id: $userId, newEmail: $newEmail) {
    id
    email
  }
  updatePost(id: $postId, newTitle: $newTitle) {
    id
    title
  }
}

1.真的有人这么做吗？如果你不明确地这样做，批处理会导致这种突变合并吗？

2. 如果您在突变中执行多个操作，您将如何正确处理错误？

我见过很多人建议在服务器上抛出错误，以便服务器响应如下内容：

{
  errors: [
    {
      statusCode: 422,
      error: 'Unprocessable Entity'
      path: [
        'updateUser'
      ],
      message: {
        message: 'Validation failed',
        fields: {
          newEmail: 'The new email is not a valid email address.'
        }
      },
    },
    {
      statusCode: 422,
      error: 'Unprocessable Entity'
      path: [
        'updatePost'
      ],
      message: {
        message: 'Validation failed',
        fields: {
          newTitle: 'The given title is too short.'
        }
      },
    }
  ],
  data: {
    updateUser: null,
    updatePost: null,
  }
}

但我如何知道哪个错误属于哪个突变呢？我们不能假设errors数组中的第一个错误属于第一个突变，因为如果updateUser成功，数组将简单地包含一个条目。然后我是否必须迭代所有错误并检查路径是否与我的突变名称匹配？：D

另一种方法是将错误包含在专用响应类型中，例如UpdateUserResponse和UpdatePostResponse。这种方法使我能够正确解决错误。

type UpdateUserResponse {
  error: Error
  user: User
}

type UpdatePostResponse {
  error: Error
  post: Post
}

但我有一种感觉，这会让我的架构变得非常臃肿。

Answer 1

简而言之，是的，如果您包含多个顶级突变字段，请利用path错误的属性来确定哪个突变失败。请注意，如果错误发生在图表的更深处（在某些子字段而不是根级别字段上），则路径将反映该字段。也就是说，解析title字段时发生的执行错误将导致pathof updatePost.title。

将错误作为 的一部分返回data是一个同样有效的选项。这种方法还有其他好处：

• 像这样发送的错误可以包括附加元数据（“代码”属性、有关可能生成错误的特定输入字段的信息等）。虽然可以通过数组发送相同的信息errors，但使其成为架构的一部分意味着客户端将了解这些错误对象的结构。这对于用类型化语言编写的客户端尤其重要，因为客户端代码通常是从模式生成的。
• 通过这种方式返回客户端错误，您可以清楚地区分应该对用户可见的用户错误（错误的凭据、用户已存在等）和客户端或服务器代码实际出现的错误（在这种情况下，充其量，我们显示一些通用消息）。
• 创建这样的“有效负载”对象可以让您在将来附加其他字段，而不会破坏您的架构。

第三种选择是以类似的方式使用 union：

type Mutation {
  updateUser(id: ID!, newEmail: String!): UpdateUserPayload!
}

union UpdateUserPayload = User | Error

这使得客户端能够使用片段和__typename字段来区分成功和失败的突变：

mutation($userId: ID!, $newEmail: String!) {
  updateUser(id: $userId, newEmail: $newEmail) {
    __typename
    ... on User {
      id
      email
    }
    ... on Error {
      message
      code
    }
  }
}

您甚至可以为每种错误创建特定类型，从而允许您省略任何类型的“代码”字段：

union UpdateUserPayload = User | EmailExistsError | EmailInvalidError

这里没有正确或错误的答案。虽然每种方法都有优点，但最终选择哪种方法取决于偏好。