Optimistic UI updates in GraphQL

Introduction

Optimistic UI updates make your app feel faster by showing changes right away before the server confirms them.

When a user submits a form and you want to show the new data immediately.

When liking a post and you want the like count to increase instantly.

When deleting an item and you want it to disappear from the list right away.

When updating a profile and you want to show the new info without waiting.

When toggling a setting and you want the UI to reflect the change instantly.

Syntax

GraphQL

mutation UpdateItem($id: ID!, $newValue: String!) {
  updateItem(id: $id, value: $newValue) {
    id
    value
  }
}

// Use optimisticResponse in your client code like this:
client.mutate({
  mutation: UpdateItem,
  variables: { id: "1", newValue: "New Text" },
  optimisticResponse: {
    updateItem: {
      id: "1",
      value: "New Text",
      __typename: "Item"
    }
  }
})

The optimisticResponse mimics the server response to update the UI immediately.

Make sure the optimistic response matches the shape of the real response.

Examples

This example instantly increases the like count to 101 before the server confirms.

GraphQL

client.mutate({
  mutation: LIKE_POST,
  variables: { postId: "123" },
  optimisticResponse: {
    likePost: {
      id: "123",
      likes: 101,
      __typename: "Post"
    }
  }
})

This example removes a comment from the UI immediately by updating the cache optimistically.

GraphQL

client.mutate({
  mutation: DELETE_COMMENT,
  variables: { commentId: "456" },
  optimisticResponse: {
    deleteComment: {
      id: "456",
      __typename: "Comment"
    }
  },
  update(cache) {
    cache.modify({
      fields: {
        comments(existingComments = [], { readField }) {
          return existingComments.filter(
            commentRef => readField('id', commentRef) !== "456"
          );
        }
      }
    });
  }
})

Sample Program

This mutation adds a new task and shows it immediately in the UI with a temporary id before the server responds.

GraphQL

mutation AddTask($text: String!) {
  addTask(text: $text) {
    id
    text
    completed
  }
}

// Client code example:
client.mutate({
  mutation: AddTask,
  variables: { text: "Buy milk" },
  optimisticResponse: {
    addTask: {
      id: "temp-id-1",
      text: "Buy milk",
      completed: false,
      __typename: "Task"
    }
  }
})

Important Notes

If the server later returns an error, you should handle reverting the optimistic update.

Optimistic updates improve user experience by reducing waiting time.

Summary

Optimistic UI updates show changes instantly before server confirmation.

Use optimisticResponse to tell the client what to show.

Make sure to handle errors to keep UI consistent.

Practice

1. What is the main purpose of using optimisticResponse in GraphQL client updates?

easy

A. To show UI changes immediately before the server responds

B. To delay UI updates until the server confirms

C. To rollback UI changes after server response

D. To fetch data from the server without updating UI

Solution

1. Step 1: Understand optimisticResponse role

   The optimisticResponse is used to update the UI instantly, assuming the server will succeed.

2. Step 2: Compare options with purpose

   Only To show UI changes immediately before the server responds describes showing UI changes immediately before server confirmation, which matches the optimistic update concept.

3. Final Answer:

   To show UI changes immediately before the server responds -> Option A

4. Quick Check:

   optimisticResponse = immediate UI update [OK]

Hint: Think: optimistic means 'hopeful' update shown early [OK]

Common Mistakes:

• Confusing optimisticResponse with delayed updates
• Thinking it rolls back changes automatically
• Assuming it fetches data without UI change

2. Which of the following is the correct syntax to provide an optimistic response in a GraphQL mutation using Apollo Client?

easy

A. mutation({ variables, optimisticResponse: { id: 1, name: 'Test' } })

B. mutation({ variables, optimisticResponse: { __typename: 'User', id: 1, name: 'Test' } })

C. mutation({ variables, optimistic: { id: 1, name: 'Test' } })

D. mutation({ variables, optimisticResponse: { id: 1 } })

Solution

1. Step 1: Recall optimisticResponse structure

   The optimisticResponse must include the __typename field to match the GraphQL schema type.

2. Step 2: Check each option for __typename

   Only mutation({ variables, optimisticResponse: { __typename: 'User', id: 1, name: 'Test' } }) includes __typename: 'User' along with id and name, making it syntactically correct.

3. Final Answer:

   mutation({ variables, optimisticResponse: { __typename: 'User', id: 1, name: 'Test' } }) -> Option B

4. Quick Check:

   Include __typename in optimisticResponse [OK]

Hint: Always add __typename in optimisticResponse object [OK]

Common Mistakes:

• Omitting __typename causes errors
• Using 'optimistic' instead of 'optimisticResponse'
• Providing incomplete optimisticResponse data

3. Given this mutation call with optimisticResponse:

client.mutate({
  mutation: ADD_TODO,
  variables: { text: 'Buy milk' },
  optimisticResponse: {
    __typename: 'Mutation',
    addTodo: {
      __typename: 'Todo',
      id: 'temp-id',
      text: 'Buy milk',
      completed: false
    }
  }
})

What will the UI show immediately after this mutation is called but before the server responds?

medium

A. An error message about missing id

B. No change until server responds

C. A new todo with id 'temp-id' and text 'Buy milk' shown

D. A blank todo item with no text

Solution

1. Step 1: Analyze optimisticResponse content

   The optimisticResponse provides a new todo with id 'temp-id', text 'Buy milk', and completed false.

2. Step 2: Understand UI behavior

   The UI will immediately show this new todo item with the given fields before server confirmation.

3. Final Answer:

   A new todo with id 'temp-id' and text 'Buy milk' shown -> Option C

4. Quick Check:

   optimisticResponse shows temporary UI data [OK]

Hint: optimisticResponse data appears instantly in UI [OK]

Common Mistakes:

• Expecting no UI change before server response
• Thinking optimisticResponse causes errors
• Assuming blank or incomplete UI display

4. You wrote this optimisticResponse but the UI does not update immediately:

optimisticResponse: {
  addTodo: {
    id: 'temp-id',
    text: 'Buy milk',
    completed: false
  }
}

What is the most likely reason for this issue?

medium

A. optimisticResponse should be a function

B. Variables object is empty

C. Mutation name is incorrect

D. Missing __typename fields in optimisticResponse

Solution

1. Step 1: Check optimisticResponse structure

   The optimisticResponse must include __typename for each object to match the schema.

2. Step 2: Identify missing fields

   The given optimisticResponse lacks __typename fields, causing Apollo Client to ignore it.

3. Final Answer:

   Missing __typename fields in optimisticResponse -> Option D

4. Quick Check:

   __typename required for optimisticResponse to work [OK]

Hint: Always add __typename to every object in optimisticResponse [OK]

Common Mistakes:

• Forgetting __typename causes no UI update
• Assuming variables affect optimisticResponse directly
• Thinking optimisticResponse must be a function

5. You want to implement an optimistic UI update for a mutation that toggles a user's 'active' status. The server might reject the change. Which approach best ensures UI consistency?

hard

A. Use optimisticResponse to toggle status immediately and handle errors to revert if needed

B. Wait for server response before updating UI to avoid inconsistencies

C. Update UI without optimisticResponse and ignore server errors

D. Use optimisticResponse but do not handle errors, assuming success

Solution

1. Step 1: Understand optimistic UI with possible server rejection

   Optimistic UI shows changes immediately but must handle errors to keep UI correct.

2. Step 2: Evaluate options for best practice

   Use optimisticResponse to toggle status immediately and handle errors to revert if needed uses optimisticResponse for instant UI update and error handling to revert if server rejects, ensuring consistency.

3. Final Answer:

   Use optimisticResponse to toggle status immediately and handle errors to revert if needed -> Option A

4. Quick Check:

   Optimistic update + error handling = consistent UI [OK]

Hint: Combine optimisticResponse with error handling for safe UI [OK]

Common Mistakes:

• Ignoring error handling causes UI mismatch
• Waiting for server loses optimistic UI benefits
• Assuming optimisticResponse alone guarantees correctness