Schema testing in GraphQL - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is schema testing in GraphQL?

Schema testing in GraphQL is the process of verifying that the GraphQL schema is correctly defined, including types, queries, mutations, and their relationships, to ensure the API behaves as expected.

beginner

Why is schema testing important in GraphQL?

Schema testing helps catch errors early, ensures the API contract is consistent, and prevents breaking changes that could affect clients relying on the GraphQL API.

intermediate

Name two common tools used for GraphQL schema testing.

Two common tools for GraphQL schema testing are Apollo Server's built-in testing utilities and GraphQL Inspector.

intermediate

What does a schema validation test typically check?

It checks that all types, fields, and resolvers exist as defined, that required fields are present, and that the schema follows the expected structure without errors.

advanced

How can schema testing help during API version upgrades?

Schema testing can detect breaking changes or missing fields early, allowing developers to fix issues before clients are affected, ensuring smooth API version upgrades.

What is the main goal of GraphQL schema testing?

A To test the database performance

B To verify the schema matches the API design and works correctly

C To check the frontend UI layout

D To optimize network speed

Schema testing focuses on verifying the GraphQL schema's correctness and structure.

Which of these is NOT typically tested in GraphQL schema testing?

A User interface colors

B Resolver functions

C Field types and names

D Required fields presence

User interface colors are unrelated to GraphQL schema testing.

Which tool can be used to detect breaking changes in a GraphQL schema?

A Postman

B Jest UI

C Chrome DevTools

D GraphQL Inspector

GraphQL Inspector helps detect schema changes and breaking changes.

Schema testing helps prevent which of the following?

A Slow internet connection

B Incorrect CSS styles

C Breaking changes that affect clients

D Database backups

Schema testing prevents breaking changes that could disrupt client applications.

What does a schema validation test NOT check?

A That the API returns correct data values

B That the schema has no syntax errors

C That all fields exist as defined

D That required fields are present

Schema validation tests the schema structure, not the actual data returned.

Explain what schema testing is and why it is important in GraphQL.

Think about how schema testing helps developers and clients.

Describe common checks performed during GraphQL schema testing.

Focus on what parts of the schema are verified.

Practice

1. What is the main purpose of schema testing in GraphQL?

easy

A. To check the database connection

B. To test the speed of GraphQL queries

C. To verify that the GraphQL schema matches the expected structure and types

D. To validate user authentication tokens

Solution

1. Step 1: Understand schema testing purpose

   Schema testing ensures the GraphQL schema is correct and matches the design.

2. Step 2: Compare options to purpose

   Only verifying schema structure and types matches schema testing's goal.

3. Final Answer:

   To verify that the GraphQL schema matches the expected structure and types -> Option C

4. Quick Check:

   Schema testing = verify schema structure [OK]

Hint: Schema testing checks schema structure, not performance or auth [OK]

Common Mistakes:

• Confusing schema testing with performance testing
• Thinking schema testing checks database connections
• Assuming schema testing validates user authentication

2. Which of the following is the correct syntax to define a GraphQL schema type for a User with fields id (ID!) and name (String)?

easy

A. User { id: ID! name: String }

B. schema User { id: ID! name: String }

C. type User (id: ID!, name: String)

D. type User { id: ID! name: String }

Solution

1. Step 1: Recall GraphQL type syntax

   GraphQL types use the keyword type followed by name and curly braces with fields.

2. Step 2: Match syntax to options

   type User { id: ID! name: String } correctly uses type User { id: ID! name: String }. Others misuse keywords or punctuation.

3. Final Answer:

   type User { id: ID! name: String } -> Option D

4. Quick Check:

   Correct type syntax = type User { id: ID! name: String } [OK]

Hint: GraphQL types start with 'type' keyword and use braces {} [OK]

Common Mistakes:

• Using 'schema' instead of 'type' keyword
• Using parentheses instead of braces
• Omitting the 'type' keyword

3. Given this GraphQL schema snippet:

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

And this query:

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

What is the expected shape of the response data?

medium

A. {"user": {"id": "123", "name": "Alice"}}

B. {"data": {"user": {"id": "123", "name": "Alice"}}}

C. {"data": {"user": null}}

D. {"error": "User not found"}

Solution

1. Step 1: Understand GraphQL response format

   GraphQL responses wrap results inside a data object with requested fields.

2. Step 2: Match query and schema to response

   The query requests user with id "123" and fields id and name. Assuming user exists, response includes these inside data.

3. Final Answer:

   {"data": {"user": {"id": "123", "name": "Alice"}}} -> Option B

4. Quick Check:

   GraphQL response wraps data in 'data' key [OK]

Hint: GraphQL responses always wrap results inside 'data' key [OK]

Common Mistakes:

• Returning data without 'data' wrapper
• Confusing null user with error response
• Assuming error is returned instead of null

4. You wrote this schema test to check if the email field exists on User type:

expect(schema.getType('User').getFields()).toHaveProperty('email')

But the test fails. What is the most likely cause?

medium

A. The User type does not have an email field defined

B. The getFields() method is not valid on schema types

C. The test syntax is incorrect and should use hasProperty

D. The schema variable is undefined

Solution

1. Step 1: Understand what getFields() returns

   The getFields() method returns an object of fields defined on the type.

2. Step 2: Analyze test failure reason

   If test fails checking for 'email', likely the User type lacks that field in schema definition.

3. Final Answer:

   The User type does not have an email field defined -> Option A

4. Quick Check:

   Missing field causes test failure [OK]

Hint: Test fails if field is missing in schema type [OK]

Common Mistakes:

• Assuming method getFields() is invalid
• Confusing test assertion method names
• Not checking if schema variable is defined

5. You want to write a schema test to ensure the Post type has a field comments that returns a list of Comment types. Which test code correctly verifies this?

hard

A. expect(schema.getType('Post').getFields().comments.type.toString()).toBe('[Comment!]!')

B. expect(schema.getType('Post').getFields().comments.type.ofType.name).toBe('Comment')

C. expect(schema.getType('Post').getFields().comments.type.toString()).toBe('[Comment]')

D. expect(schema.getType('Post').getFields().comments.type.name).toBe('Comment')

Solution

1. Step 1: Understand GraphQL list and non-null syntax

   A list of Comment types with non-null items and non-null list is represented as [Comment!]!.

2. Step 2: Match test code to expected type string

   expect(schema.getType('Post').getFields().comments.type.toString()).toBe('[Comment!]!') checks the full type string including non-null markers, correctly verifying the list of non-null Comments.

3. Final Answer:

   expect(schema.getType('Post').getFields().comments.type.toString()).toBe('[Comment!]!') -> Option A

4. Quick Check:

   List of non-null Comments = '[Comment!]!' [OK]

Hint: Use toString() to check full list and non-null type syntax [OK]

Common Mistakes:

• Checking only inner type name without list brackets
• Ignoring non-null markers in type string
• Using wrong property to access type name