Apollo-feature-requests: Ability to tell if a mock was called on MockedProvider

Created on 16 Jan 2019 · 3Comments · Source: apollographql/apollo-feature-requests

When trying to write tests for a react component that contains a mutation, I'd like to verify that the mutation is actually called (and with the right variables). Currently the documentation on this topic suggests mocking the mutation result and testing that the component produces some sort of inspectable change as a result of the mutation.

https://www.apollographql.com/docs/react/recipes/testing.html#Testing-mutation-components

However this poses two problems:

In the event that the component does not actually change after a mutation (such as a button that triggers a mutation and then provides no feedback to the user), it is impossible to test that the component actually triggered the mutation.
Even if the component does change after the mutation (e.g. the text on the component changes from "click me" to "I have called your mutation"), testing this change does not verify that the component behaves as expected. For example, if a developer accidentally changes the component's implementation, such that clicking the button doesn't call the mutation, but does trigger a text change, the test would still pass.

One possible solution would be to allow more flexibility in how mocked responses are specified. If for example it were possible to pass in a method to the mock instead of a static result, then this could be utilized for this purpose, and perhaps other purposes as well:

let mutationWasCalled = false;
const mocks = [
  {
    request: {
      query: expectedMutation, 
      variables: expectedVariables,
    },
    result: () => {
      mutationWasCalled = true;
      return dataToReturnFromMutation;
    }
  }
]
const component = (
  <MockedProvider mocks={mocks}>
    <ComponentBeingTested>
  </MockedProvider>
)
// simulate click on the component
expect(mutationWasCalled).to.eq(true);

Another option that provides a bit less flexibility but would still solve this issue is to have some way to allow querying whether or not a specific mocked request was called, and\or how many times it was called.

Thanks for reading! Looking forward to your response.

Source

noaelad

👍7 🎉2

Most helpful comment

Thanks for the suggestion @noaelad - great idea! This change has been implemented and merged, and will be coming in the next react-apollo release. I'm going to keep this issue open to make sure we remember to update the docs to show that this is now possible. Thanks again!