supertest-graphql

Extends supertest to test a GraphQL endpoint

Install

1npm install supertest-graphql

Usage

1import request from 'supertest-graphql'
2import gql from 'graphql-tag'
3
4test('should get pets', async () => {
5  const { data } = await request(app)
6    .query(gql`
7      query {
8        pets {
9          name
10          petType
11        }
12      }
13    `)
14    .expectNoErrors()
15  
16  expect(data.pets).toHaveLength(2)
17})

Set expectations

expectNoErrors will verify that the API response has no errors in its result payload.

1await request(app)
2  .query('blooop')
3  .expectNoErrors()
4  // expected no errors but got 1 error(s) in GraphQL response: Syntax Error: Unexpected Name "blooop".

Variables

1const { data } = await request(app)
2  .query(gql`
3    query GetPets($first: Int){
4      pets(first: $first) {
5        name
6        petType
7      }
8    }
9  `)
10  .variables({ first: 4 })

Mutation

1const { data } = await request(app)
2  .mutate(gql`
3    mutation PetAnimal($petId: ID!) {
4      petAnimal(petId: $petId) {
5        name
6        petType
7      }
8    }
9  `)
10  .variables({petId: 'my-cat' })

Subscriptions with WebScoket

1import { supertestWs } from 'supertest-graphql'
2import gql from 'graphql-tag'
3
4// for websocket the server needs to be started and stopped manually
5beForeEach(() => server.listen(0, "localhost"))
6afterEach(() => server.close())
7
8test('should get pets', async () => {
9  const sub = await supertestWs(app)
10    .subscribe(gql`
11      subscription {
12        newPetAdded {
13          name
14          petType
15        }
16      }
17    `)
18  
19  // will wait or pop the next value
20  const { data } = await sub.next().expectNoErrors()
21
22  expect(data.newPetAdded.name).toEqual('Fifi')
23})

Authentication

1const { data } = await request(app)
2  .auth('username', 'password')
3  .query(...)

or via headers:

1const { data } = await request(app)
2  .set('authorization', 'my token')
3  .query(...)

For WebSocket with connectionParams:

1import { supertestWs } from 'supertest-graphql'
2
3const sub = await supertestWs(app)
4  .connectionParams({
5    token: 'my token'
6  })
7  .subscribe(...)

Change GraphQL endpoint path

By default, the execution are sent to /graphql.

You can change this with .path():

1const { data } = await request(app)
2  .path('/new-graphql')
3  .query(...)

Use WebSocket legacy protocol

1import { supertestWs, LEGACY_WEBSOCKET_PROTOCOL } from 'supertest-graphql'
2
3const sub = await supertestWs(app)
4  .protocol(LEGACY_WEBSOCKET_PROTOCOL)
5  .subscribe(...)