Apollo 客户端：如何简单调试 400 代码错误？

Question

我正在使用 Apollo 客户端，但我不明白为什么调试我的错误如此困难： 我正在尝试对我的 GraphQL 的石墨烯 python 实现执行 mutate 调用。它以 400 错误代码结束，我无法检索信息。

例如：当我在 /graphQL 界面上尝试我的石墨烯服务时，它会向我返回有用的错误，例如错误的输入或错误的方法名称。 在这里，在阿波罗客户端上，它只会给我一个 400 代码错误。这对我一点帮助都没有。那么是否有可能从我的 apolo 客户端获得来自石墨烯的错误信息，而不是无用的 400 代码错误？

这是一个示例，来自我的石墨烯接口 (/graphQL)：

mutation myMutation {
  uploadFile(input:"") {
    success
  }
}

将输出：

{
  "errors": [
    {
      "message": "Argument \"input\" has invalid value \"\".\nExpected \"UploadFileMutationInput\", found not an object.",
      "locations": [
        {
          "column": 20,
          "line": 2
        }
      ]
    }
  ]
}

当我在 apollo 客户端 (js) 上尝试相同的操作时：

client.mutate({
  mutation: gql`
    mutation($file: Upload!) {
      uploadFile(input: $file) {
        success
      }
    }
  `,
  variables: { file } })
  .then(console.log)
  .catch((e) => { console.log("catch", e) })

我明白了 Error: Network error: Response not successful: Received status code 400

我的 catch 从来没有被调用过，文档对我一点帮助也没有。

我想要的是获取我的调用的突变细节错误：当我使用不正确的方法调用或错误的输入类型时，我不应该在没有任何关于是什么导致我的请求错误的信息的情况下陷入 400。

Answer 1

我设法通过将onError 函数直接放在客户端配置中来做到这一点（在突变中执行此操作时graphQLErrors 始终为空）：

const client = new ApolloClient({
  uri: 'http://localhost:3000/graphql',
  onError: (e) => { console.log(e) },
});

Answer 2

您应该在实例化ApolloClient 时使用此链接：https://www.npmjs.com/package/apollo-link-error。它应该在其他链接之前，如下所示：

import { ApolloClient, ApolloLink } from 'apollo-boost'
import { onError } from 'apollo-link-error'

const errorLink = onError(({ graphQLErrors }) => {
  if (graphQLErrors) graphQLErrors.map(({ message }) => console.log(message))
})

new ApolloClient({
  ...
  link: ApolloLink.from([errorLink, authLink, restLink, httpLink]),
})

Answer 3

这个解决方案为我解决了这个问题：

const client = new ApolloClient({
  uri: 'http://localhost:4444/graphql',
  onError: ({ networkError, graphQLErrors }) => {
    console.log('graphQLErrors', graphQLErrors)
    console.log('networkError', networkError)
  }
})

Answer 4

就我而言，查询中有错字。 但是最终出现 400 错误。

要调试这种情况，您可以简单地使用以下代码：

function query() {
  try {
    /**
     * DO QUERY
     */
  } catch (e) {
    // Here you can catch any errors from Apollo Error.
    console.log(e.networkError.result.errors);
  }
}

提示：GraphQL 错误并不总是以graphQLErrors 结尾，因此最好将网络错误与您的 graphql 错误一起检查。 要查看 GraphQL 错误：console.log(e.graphQLErrors); 请注意 graphQLErrors 将是一个数组。

这是一个完整的例子：

async function userQueryInterface(userid = '1234', usermail = 'test@test.test') {
  try {
    let users = await client.query({
      query: gql`
        query GetUsers($userid: ID!, $usermail: String) {
          getUsers(vlanid: $userid, usermail: $usermail) {
            _id
            mail
          }
        }
      `,
      variables: { userid, usermail }
    });

    return users.data.getUsers;
  } catch (e) {
    console.log(e.networkError.result.errors); // here you can see your network
  }
}

Answer 5

Error 和 console.log 惊喜

尝试使用console.log 查看错误时，您可能会惊讶地发现没有看到所有可用的错误数据。这是因为console.log 以特殊方式处理作为内置Error 类实例的值，仅打印消息、类型和堆栈。

Apollo 从内置的 Error 类扩展了它自己的错误。这可以通过以下方式轻松测试：

const error = apolloError // from async try/catch, onError method, or a promise .catch

console.log(error instanceof Error);
// --> true

当从Error 扩展时，Apollo 会将它自己的数据添加到对象中。然而错误仍然是Error 的一个实例，因此console.log 只会显示有限的信息，

console.log(error);

// output:
// Error: Network error: Response not successful: Received status code 400
//     at ...
//     at ...
//     at ...

建议（解决方案？）

如果您知道在哪里查找，您可以对错误对象进行属性查找。例如，您可以记录error.networkError.result.errors。这种方法可能过于外科手术，并导致对所有错误的了解不完整。

或者，我们可以在错误对象上使用JSON.stringify，整个数据将打印到控制台，

// tip: use stringify's formatting options for better readability
console.log(JSON.stringify(error, null, 2));

{
  "graphQLErrors": [],
  "networkError": {
    "name": "ServerError",
    "response": {},
    "statusCode": 400,
    "result": {
      "errors": [...here you will find what you're looking for]
    }
  },
  "message": "Network error: Response not successful: Received status code 400",
  "name": "Error",
  "stack": "...same as before"
}

您一眼就能看出哪里出了问题。