graphql/graphql-js

Provide utility to validate that an response match a given query

已关闭

#563 创建于 2016年11月10日

在 GitHub 查看贡献者指南
 (2 条评论) (8 个反应) (0 位负责人)TypeScript (2,223 个派生)batch import
help wantedneeds exploration

仓库指标

星标
 (19,825 个星标)
PR 合并指标
 (平均合并 12天 6小时) (30 天内合并 42 个 PR)

描述

When writing unit tests one need to mock any response that would otherwise come from the graphql server. Given that setting up the wrong expectation for the mocked payload can lead to writing tests against the wrong schema. A utility function that can be used to validate that a given object match a given query would be really useful to have.

Example payload used as a mock response:

{
  user: {
    id: 'some-id',
    name: 'Smith'
  }
}

The corresponding query is:

gql `query {
  user(id: $userId) {
    id
  }
}`

As you can see the mock response does not match the query and it would be nice to be able to assert on that.

I would be happy to submit a PR with this, but would like to know if there is a place I start looking and where is the right interface we might want to have for it.

贡献者指南

研究方向
The issue author requests guidance on where to implement and the interface for a utility that validates mock responses against GraphQL queries. Look into the graphql js repository, likely under the 'src' directory, for existing validation or utility functions. Check the issue comments (only 2) and any linked discussions. Consider creating a new module that parses a query and checks if a provided object matches the selected fields.
技术栈
javascripttypescript
领域
testing
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
半天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
较久未更新
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
GraphQL query syntaxJavaScript unit testing
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70