Partial success responses in GraphQL

Introduction

Partial success responses let you get some data even if part of your request fails. This helps keep your app working smoothly without stopping everything.

When fetching multiple items and some might not be available but you still want the rest.

When calling a service that might return errors for some parts but still returns useful data.

When you want to show users partial results instead of a full error message.

When integrating with APIs that can return partial data with error details.

When debugging or testing to see which parts of a query succeed or fail.

Syntax

GraphQL

{
  "data": {
    "someField": {
      "subfield": "value"
    }
  },
  "errors": [
    {
      "message": "Error in some part",
      "path": ["someField", "failedSubfield"]
    }
  ]
}

Partial success is not a special syntax but a pattern where the response includes both data and errors fields.

The errors field contains details about what failed, while data contains what succeeded.

Examples

This query fetches a user and their posts. If some posts fail to load, the response may include partial data with errors.

GraphQL

query {
  user(id: "1") {
    name
    posts {
      title
    }
  }
}

Fetching multiple products. If one product ID is invalid, the response can return data for valid products and errors for invalid ones.

GraphQL

query {
  products(ids: ["1", "2", "3"]) {
    id
    name
  }
}

Sample Program

This query asks for two books by ID. If book with ID "999" does not exist, the response will include the existing book and an error for the missing one.

GraphQL

query {
  books(ids: ["1", "999"]) {
    id
    title
  }
}

Important Notes

Partial success responses help improve user experience by showing available data.

Always check both data and errors in the response to handle issues properly.

Not all GraphQL servers support partial success; it depends on the implementation.

Summary

Partial success responses return both data and errors together.

This allows apps to use available data even if some parts fail.

Check the errors field to understand what went wrong.

Practice

1. What does a partial success response in GraphQL typically include?

easy

A. Only the data field with no errors

B. Both data and errors fields

C. Only the errors field with no data

D. Neither data nor errors fields

Solution

1. Step 1: Understand partial success response structure

   Partial success responses include both data that was successfully fetched and errors for parts that failed.

2. Step 2: Identify fields present in response

   The response contains a data field with available data and an errors field describing issues.

3. Final Answer:

   Both data and errors fields -> Option B

4. Quick Check:

   Partial success = data + errors [OK]

Hint: Partial success means data and errors appear together [OK]

Common Mistakes:

• Thinking partial success returns only data
• Assuming errors field is empty on partial success
• Believing partial success means no errors

2. Which of the following is the correct way to check for errors in a GraphQL partial success response?

easy

A. Check if response.errors exists and is not empty

B. Check if response.data is null

C. Check if response.status equals 200

D. Check if response.message contains 'error'

Solution

1. Step 1: Understand error reporting in GraphQL

   Errors are reported in the errors field as an array when present.

2. Step 2: Identify correct error check

   Checking if response.errors exists and is not empty correctly detects errors.

3. Final Answer:

   Check if response.errors exists and is not empty -> Option A

4. Quick Check:

   Errors field presence = error check [OK]

Hint: Look for non-empty errors array to detect issues [OK]

Common Mistakes:

• Checking data for null instead of errors
• Using HTTP status code instead of errors field
• Looking for message text instead of errors array

3. Given this GraphQL response:

{"data": {"user": null}, "errors": [{"message": "User not found"}]}

What should the client do?

medium

A. Check the errors and handle missing user

B. Ignore the errors field and proceed

C. Retry the query immediately without changes

D. Use the user data as valid

Solution

1. Step 1: Analyze the response data and errors

   The user field is null and there is an error message "User not found".

2. Step 2: Decide client action based on partial success

   The client should check errors and handle the missing user data appropriately, not ignore errors or blindly use null data.

3. Final Answer:

   Check the errors and handle missing user -> Option A

4. Quick Check:

   Errors present + null data = handle carefully [OK]

Hint: Null data with errors means handle missing info [OK]

Common Mistakes:

• Using null data as valid without checking errors
• Ignoring errors field completely
• Retrying query without fixing cause

4. You receive this partial success response:

{"data": {"posts": [{"id": "1", "title": "Hello"}]}, "errors": [{"message": "Failed to fetch comments"}]}

What is the likely cause of the error?

medium

A. Network connection lost before response

B. The entire query failed and returned no data

C. Syntax error in the GraphQL query

D. Posts data fetched but comments part failed

Solution

1. Step 1: Examine data and errors in response

   Data for posts is present, but error message says "Failed to fetch comments".

2. Step 2: Interpret partial success meaning

   Partial success means some parts succeeded (posts), others failed (comments).

3. Final Answer:

   Posts data fetched but comments part failed -> Option D

4. Quick Check:

   Data present + error message = partial failure [OK]

Hint: Data present means partial success, check error message for failed parts [OK]

Common Mistakes:

• Assuming entire query failed with some data
• Thinking syntax error causes partial success
• Blaming network loss without evidence

5. How can you design a GraphQL query to handle partial success gracefully when fetching users and their posts, knowing posts might fail?

hard

A. Ignore errors and always use posts data blindly

B. Split into two separate queries to avoid partial success

C. Request users and posts in one query and check errors for posts failures

D. Use a mutation instead of a query to avoid partial success

Solution

1. Step 1: Understand partial success handling in GraphQL

   GraphQL allows querying multiple fields; some may succeed while others fail, returning partial success.

2. Step 2: Design query and client logic

   Request both users and posts in one query, then check errors to handle posts failures gracefully without losing users data.

3. Final Answer:

   Request users and posts in one query and check errors for posts failures -> Option C

4. Quick Check:

   One query + error check = graceful partial success [OK]

Hint: Query all, then check errors to handle partial failures [OK]

Common Mistakes:

• Splitting queries unnecessarily
• Ignoring errors and using incomplete data
• Confusing mutations with queries