使用 graphql 和 apollo 引发描述性错误

Question

考虑以下类：

// entity/Account.ts
import { Entity, PrimaryGeneratedColumn, Column, BaseEntity, Index, CreateDateColumn, UpdateDateColumn } from 'typeorm'
import { Field, Int, ObjectType } from 'type-graphql'

@ObjectType()
@Entity()
export class Account extends BaseEntity {
  @Field(() => Int)
  @PrimaryGeneratedColumn()
  id: number

  @Field()
  @Column({ length: 50, unique: true })
  @Index({ unique: true })
  accountIdentifier: string

  @Field({ nullable: true })
  @Column({ length: 100 })
  name?: string
}

对应的解析器：

// AccountResolver.ts
@Resolver()
export class AccountResolver {
  @Mutation(() => Account)
  async addAccount(@Arg('options', () => AccountInput) options: AccountInput) {
    try {
      // if (!options.accountIdentifier) {
      //   throw new Error(`Failed adding account: the accountIdentifier is missing`)
      // }
      return await Account.create(options).save()
    } catch (error) {
      if (error.message.includes('Cannot insert duplicate key')) {
        throw new Error(
          `Failed adding account: the account already exists. ${error}`
        )
      } else {
        throw new Error(`Failed adding account: ${error}`)
      }
    }
  }
}

Jest 测试文件

// AccountResolver.test.ts
describe('the addAccount Mutation', () => {
  it('should throw an error when the accountIdentifier is missing', async () => {
    await expect(
      client.mutate({
        mutation: gql`
        mutation {
          addAccount(
            options: {
              name: "James Bond"
              userName: "James.Bond@contoso.com"
            }
          ) {
            accountIdentifier
          }
        }
      `,
      })
    ).rejects.toThrowError('the accountIdentifier is missing')
  })

accountIdentifier 字段是必填字段，当请求中缺少该字段时，应抛出描述性错误消息。但是，抛出的错误是：

“网络错误：响应不成功：收到状态码 400”

修改错误信息的正确方法是什么？我查看了type-graphql 和class-validators，并确保设置了validate: true，但它没有给出描述性错误。

编辑

在检查了 graphql playground 之后，默认情况下它确实显示了正确的错误消息。剩下的唯一问题是如何编写笑话测试以便它可以读取此消息：

{
  "error": {
    "errors": [
      {
        "message": "Field AccountInput.accountIdentifier of required type String! was not provided.",

感谢您能给我的任何帮助。

Answer 1

您的客户端返回的ApolloError 包含响应中返回的errors 以及执行请求时遇到的任何网络错误。前者可在graphQLErrors 属性下访问，后者可在networkError 属性下访问。 Instea dof 使用 toThrowError，你应该使用 toMatchObject 代替：

const expectedError = {
  graphQLErrors: [{ message: 'the accountIdentifier is missing' }]
}
await expect(client.mutate(...)).rejects.toMatchObject(expectedError)

但是，我建议避免使用 Apollo Client 进行测试。相反，您可以直接针对您的架构执行操作。

import { buildSchema } from 'type-graphql'
import { graphql } from 'graphql'

const schema = await buildSchema({
  resolvers: [...],
})
const query = '{ someField }'
const context = {}
const variables = {}
const { data, errors } = await graphql(schema, query, {}, context, variables)