GraphQL Default Response Override Test Example

[orthimnas]

I'd like to see an example test that resets the handlers between tests and configures a unique response per test.

My understanding is that I should be able to add an "override" handler in individual tests that tweak a default configuration.

Here is some pseudo-code that represents what I think is needed for setup / use.

setupTests.js

import { handlers } from './mocks'
const server = setupServer(...handlers)
beforeAll(() => {
  server.listen()
})
afterEach(() => {
  server.resetHandlers()
})
afterAll(() => {
  server.close()
})

Test:

// Appropriate imports here to get access to server
it('Uses default setup', () => {
  // Test here
}

it('Uses custom setup', () => {
  server.use(
    graphql.query('SameQueryAsSetup`, (req, res, ctx) => {
      // Return different response from default
    });
  // Rest of test
}

[kettanaito]

Hey, @orthimnas! Thanks for asking for this. I'll include a runtime request handler (override) usage scenario in the unit tests as you've suggested.

[orthimnas]

Appreciate you offering to adding that test - I wasn't able to get it working on a local project and hoped that an example would make it clear what I was missing.

[danielbayerlein]

In the meantime, is it possible to override the GraphQL default response?

[kettanaito]

Hey, @danielbayerlein. It's possible to override GraphQL handlers the same way you override the REST ones.

const server = setupServer(
  graphql.query('GetUser', (req, res, ctx) => {
    return res(ctx.data({ user: { firstName: 'John' } }))
  })
)

afterEach(() => {
  // Don't forget to remove all the handlers added in each individual
  // test via `.use`. 
  server.resetHandlers()
})

test('renders a user', () => {
  server.use(
    // In this particular test the `GetUser` query
    // will resolve to a different user object.
    graphql.query('GetUser', (req, res, ctx) => {
      return res(ctx.data({ user: { firstName: 'Dean' } }))
    })
  )
})