Cypress commands for intercepting and testing graphql endpoints.
Install this package w/ npm or yarn
npm install --dev @shopify/cypress-graphql
yarn add --dev @shopify/cypress-graphqlThen in your cypress/support/index files, import the entire package to register these commands.
import '@shopify/cypress-graphql';
Typescript types are automatically included, so no further action is required.
This command sets up spies and stubs for a graphql endpoint, similar to cypress route intercepts. This registers a top-level route alias called GraphQL. Optionally, but definitely encouraged is providing an array of known operations, which will then be registered as sub-operations with their own aliases.
cy.interceptGql('**/graphql') // register route intercepts
cy.get('button[type="submit"]').click() // make the UI send a request
cy.wait('@GraphQL').its('status').should('eq', 200) // test the response
cy.interceptGql('**/graphql', ['UserQuery']) // register route intercepts
cy.get('button[type="submit"]').click() // make the UI send a request
cy.wait('@UserQuery').its('status').should('eq', 200) // test the response
cy.interceptGql('**/graphql', [
['UserQuery', { statusCode: 400, body: { data: null, errors: ['fake err'] } }]
]) // provide a fake error
cy.get('button[type="submit"]').click() // make the UI send a request
cy.wait('@UserQuery').its('status').should('eq', 400) // test the response
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent