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