Skip to main content

GraphQL Mutations

GraphQL Mutations

The GraphQL selectors will perform an initial query as well as subscribe to any changes. You can use Relay APIs such as useMutation() and commitMutation() to update the state on the server. These changes will also sync and cause the Recoil GraphQL selectors to update. This allows you to treat the server as the source of truth with the selector as a local cache.

The mutation response should select data that you want to be returned by the server when updated so it can update the local client state. This is necessary so other GraphQL queries and Recoil selectors based on that data will re-render with the new state. It can be a good practice to use GraphQL fragments to help ensure your queries and mutations return the same data. For more complex updates you may need to use the updater option. You can also use optimisticResponse or optimisticUpdater to update the local state before getting the response to the mutation back from the server. If there is an error the optimistic updates will be rolled back. In any case, make sure your mutation is using the same Relay environment as your queries and selectors.

function MyComponent(props) {
const user = useRecoilValue(userQuery(props.userID));
const [commitEvent] = useMutation(graphql`
mutation UserMutation($input: UsertNameChangeData!) {
user_mutation(data: $input) {
user {
id
name
}
}
}
`);

return (
<div>
<h1>{user.name}</h1>
<button onClick={() => {
commitEvent({
variables: {
input: {
id: props.userID,
name: 'New Name',
},
},
});
}}>Change Name</button>
</div>
);
}

Write-through Cache

Another pattern you can use for updating state is to treat the Recoil selector as a local write-through cache for the server. It is a writable selector, so local updates will immediately be reflected in the UI. If you provide GraphQL mutation information, then updating the selector will also initiate a mutation with the server.

const userState = graphQLSelector({
key: 'User',
environment: relayFBEnvironmentKey,
query: graphql`
query UserQuery($eventID: ID!, $clientID: ClientID!) {
user(id: $eventID, client_id: $clientID) {
name
timestamp
}
}
`,
variables: id => ({get}) => ({id, clientID: get(clientIDAtom}),
mapResponse: data => data.user,

mutations: {
mutation: graphql`
mutation UserMutation($input: UserNameChangeData!) {
user_mutation(data: $input) {
user {
id
name
}
}
}
`,
variables: newUserData => id => ({input: {id, name: newUserData.name}}),
},
});
function MyComponent() {
const [user, setUser] = useRecoilState(userState);

return (
<div>
<h1>{user.name}</h1>
<button onClick={() => {
setUser(user => ({...user, name: 'New Name'}));
}}>Change Name</button>
</div>
);
}

Note that when using Recoil as a write-through cache like this the Relay concept of "optimistic response" is not necessary for mutations since updating the selector will update the UI before the remote mutation is committed. If there is an error from the server then the local update will be rolled back.

Local Updates

The commitLocalUpdate() Relay API can be used for local updates to the GraphQL state without issuing a network request to update the server. Updates will cause all relevant components subscribing to affected queries and selectors to re-render.