Why testing validates schema behavior in GraphQL - See It in Action

Why Testing Validates Schema Behavior

📖 Scenario: You are building a simple GraphQL API for a bookstore. You want to ensure that the schema behaves correctly when queried and that the data types and fields are as expected.

🎯 Goal: Build a GraphQL schema for books and authors, add a configuration for a test query, write the core query logic, and complete the schema with a test validation query to confirm schema behavior.

📋 What You'll Learn

Create a GraphQL schema with types Book and Author

Add a query type with a field books returning a list of Book

Configure a test query to fetch book titles and author names

Complete the schema with a validation query to test schema correctness

💡 Why This Matters

🌍 Real World

GraphQL schemas define the structure of data clients can query. Testing ensures the schema behaves as expected before deployment.

💼 Career

Understanding schema design and validation is essential for backend developers and API engineers working with GraphQL.

1

Define the GraphQL types for Book and Author

Create a GraphQL schema with a type Book that has fields id (ID!), title (String!), and author (Author). Also create a type Author with fields id (ID!) and name (String!).

GraphQL

# Define the Book and Author types
# Your code here

Hint

Use type keyword to define GraphQL object types with the specified fields and types.

2

Add the Query type with a books field

Add a type Query with a field books that returns a list of Book objects (use [Book]).

GraphQL

type Author {
  id: ID!
  name: String!
}

type Book {
  id: ID!
  title: String!
  author: Author
}

# Add Query type with books field
# Your code here

Hint

Define the root Query type with a books field returning a list of Book.

3

Write a test query to fetch book titles and author names

Write a GraphQL query named TestBooksQuery that requests the title of each book and the name of its author from the books field.

GraphQL

type Author {
  id: ID!
  name: String!
}

type Book {
  id: ID!
  title: String!
  author: Author
}

type Query {
  books: [Book]
}

# Write a test query named TestBooksQuery
# Your code here

Hint

Write a query operation that selects title and nested author.name from books.

4

Complete the schema with a validation query

Add a type Mutation with a dummy field validateSchema that returns a Boolean. This helps to complete the schema and allows testing schema behavior.

GraphQL

type Author {
  id: ID!
  name: String!
}

type Book {
  id: ID!
  title: String!
  author: Author
}

type Query {
  books: [Book]
}

query TestBooksQuery {
  books {
    title
    author {
      name
    }
  }
}

# Add Mutation type with validateSchema field
# Your code here

Hint

Add a Mutation type with a Boolean field validateSchema to complete the schema.

Practice

1. Why is testing important for validating a GraphQL schema?

easy

A. It confirms the schema matches the expected data structure.

B. It speeds up the database queries automatically.

C. It changes the schema to fit new data types without errors.

D. It removes unused fields from the schema without manual work.

Solution

1. Step 1: Understand the purpose of schema testing

   Testing checks if the schema correctly represents the data structure expected by the application.

2. Step 2: Identify the correct role of testing

   Testing does not automatically speed queries, change schema, or remove fields; it validates correctness.

3. Final Answer:

   It confirms the schema matches the expected data structure. -> Option A

4. Quick Check:

   Schema validation = Confirm structure [OK]

Hint: Testing checks if schema matches expected data structure [OK]

Common Mistakes:

• Thinking testing changes schema automatically
• Believing testing speeds up queries
• Assuming testing removes unused fields

2. Which of the following is the correct way to define a required field in a GraphQL schema?

easy

A. type User { name: String }

B. type User { name: String! }

C. type User { name: !String }

D. type User { name: Required String }

Solution

1. Step 1: Recall GraphQL syntax for required fields

   In GraphQL, adding an exclamation mark ! after the type marks it as required (non-nullable).

2. Step 2: Identify the correct syntax

   String! is correct; !String and Required String are invalid syntax.

3. Final Answer:

   type User { name: String! } -> Option B

4. Quick Check:

   Required field = type followed by ! [OK]

Hint: Use ! after type to mark required fields [OK]

Common Mistakes:

• Placing ! before the type name
• Using 'Required' keyword which is invalid
• Omitting ! for required fields

3. Given this GraphQL schema snippet:

type Query { user(id: ID!): User }

And this test query:

{ user(id: "123") { name } }

What will happen if the user field resolver returns null?

medium

A. The query returns { "user": {} } with empty fields.

B. The query returns an error because user is non-nullable.

C. The query returns { "user": null } without errors.

D. The query crashes the server due to null value.

Solution

1. Step 1: Analyze the schema for nullability

   The user field returns type User which is nullable (no !), so it can be null.

2. Step 2: Understand resolver behavior with null

   If resolver returns null, the query returns { "user": null } without error because null is allowed.

3. Final Answer:

   The query returns { "user": null } without errors. -> Option C

4. Quick Check:

   Nullable field allows null result [OK]

Hint: Nullable fields can return null without errors [OK]

Common Mistakes:

• Confusing nullable and non-nullable fields
• Expecting errors on null return for nullable fields
• Assuming empty object is returned instead of null

4. You wrote this GraphQL schema:

type Mutation { addUser(name: String!): User! }

But your test fails with error: Cannot return null for non-nullable field Mutation.addUser. What is the likely cause?

medium

A. The resolver returned null instead of a User object.

B. The name argument was missing in the mutation call.

C. The schema syntax is invalid because User! is not allowed.

D. The mutation should not have any arguments.

Solution

1. Step 1: Understand the schema non-null constraints

   The mutation returns User! which means it must never return null.

2. Step 2: Interpret the error message

   Error says null was returned for a non-nullable field, so the resolver likely returned null instead of a User object.

3. Final Answer:

   The resolver returned null instead of a User object. -> Option A

4. Quick Check:

   Non-null return must not be null [OK]

Hint: Non-null return types cannot return null [OK]

Common Mistakes:

• Assuming missing argument causes this error
• Thinking schema syntax is invalid for User!
• Believing mutations cannot have arguments

5. You want to ensure your GraphQL schema enforces that every Post has a non-empty title and an optional content. Which testing approach best validates this behavior?

hard

A. Write tests that accept any title value and ignore content field.

B. Write tests that only query Post fields without mutations.

C. Write tests that check if content is always returned as an empty string.

D. Write tests that send mutations with empty title and expect errors, and mutations with missing content to succeed.

Solution

1. Step 1: Identify validation goals

   We want to ensure title is non-empty (required) and content is optional.

2. Step 2: Choose tests that check required and optional fields

   Tests should try sending empty title to confirm errors, and omit content to confirm success.

3. Final Answer:

   Write tests that send mutations with empty title and expect errors, and mutations with missing content to succeed. -> Option D

4. Quick Check:

   Test required fields with errors, optional fields with success [OK]

Hint: Test required fields cause errors when empty, optional fields can be missing [OK]

Common Mistakes:

• Testing only queries without mutations
• Ignoring validation of required fields
• Expecting optional fields to always have values