Query depth and complexity in GraphQL - Mini Project: Build & Apply

Understanding GraphQL Query Depth and Complexity

📖 Scenario: You are building a simple GraphQL API for a bookstore. Customers can query books and authors. To keep the API fast and safe, you want to control how deep and complex queries can be.

🎯 Goal: Learn how to set up and enforce query depth and complexity limits in a GraphQL API to prevent overly complex queries that slow down the server.

📋 What You'll Learn

Create a basic GraphQL schema with types Book and Author

Add a query type with fields books and authors

Set a maximum query depth limit of 3

Set a maximum query complexity limit of 10

Validate queries against these limits

💡 Why This Matters

🌍 Real World

Limiting query depth and complexity is important in real GraphQL APIs to prevent slowdowns and crashes caused by very large or deeply nested queries.

💼 Career

Many companies use GraphQL and need developers who understand how to keep APIs performant and secure by controlling query complexity.

1

Create the GraphQL schema with Book and Author types

Write the GraphQL schema defining a Book type with fields id (ID), title (String), and author (Author). Also define an Author type with fields id (ID) and name (String). Finally, create a Query type with fields books and authors that return lists of Book and Author respectively.

GraphQL

# Write the GraphQL schema with Book, Author, and Query types

Hint

Define the types and their fields exactly as described. Use exclamation marks ! to mark required fields.

2

Add a configuration for maximum query depth

In your GraphQL server setup code, create a variable called maxQueryDepth and set it to 3. This will limit how deep queries can go.

GraphQL

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

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

type Query {
  books: [Book!]!
  authors: [Author!]!
}

# Create a variable maxQueryDepth and set it to 3

Hint

Use a constant named maxQueryDepth and assign it the number 3.

3

Add a configuration for maximum query complexity

Add a variable called maxQueryComplexity and set it to 10 in your server setup code. This will limit how complex queries can be.

GraphQL

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

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

type Query {
  books: [Book!]!
  authors: [Author!]!
}

const maxQueryDepth = 3;
# Create a variable maxQueryComplexity and set it to 10

Hint

Use a constant named maxQueryComplexity and assign it the number 10.

4

Apply query depth and complexity validation in the GraphQL server

In your GraphQL server setup, add middleware or validation rules that use maxQueryDepth and maxQueryComplexity to reject queries exceeding these limits. Use the variables maxQueryDepth and maxQueryComplexity exactly in your validation code.

GraphQL

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

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

type Query {
  books: [Book!]!
  authors: [Author!]!
}

const maxQueryDepth = 3;
const maxQueryComplexity = 10;

# Add validation rules using maxQueryDepth and maxQueryComplexity

Hint

Use the functions depthLimit and createComplexityLimitRule with the variables maxQueryDepth and maxQueryComplexity to create validation rules.

Practice

1. What does query depth in GraphQL control?

easy

A. The maximum number of nested levels in a query

B. The total number of fields requested in a query

C. The size of the response data in bytes

D. The number of queries a client can send per minute

Solution

1. Step 1: Understand query depth meaning

   Query depth limits how many nested levels a GraphQL query can have to avoid very deep queries.

2. Step 2: Compare with other options

   Options A, C, and D describe different concepts like total fields, response size, or rate limiting, not depth.

3. Final Answer:

   The maximum number of nested levels in a query -> Option A

4. Quick Check:

   Query depth = nested levels limit [OK]

Hint: Depth means nested levels, not total fields or size [OK]

Common Mistakes:

• Confusing depth with total number of fields
• Thinking depth limits response size
• Mixing depth with request rate limits

2. Which of the following is a correct way to limit query depth in a GraphQL server?

easy

A. Disable introspection queries

B. Set a maximum response size in bytes in the schema definition

C. Limit the number of clients connected to the server

D. Use a middleware that counts nested fields and rejects queries exceeding a limit

Solution

1. Step 1: Identify how to limit query depth

   Limiting query depth is done by counting nested fields during query parsing and rejecting if too deep.

2. Step 2: Evaluate other options

   Options A, B, and C do not directly limit query depth; they affect response size, connections, or introspection.

3. Final Answer:

   Use a middleware that counts nested fields and rejects queries exceeding a limit -> Option D

4. Quick Check:

   Middleware counts depth to limit queries [OK]

Hint: Count nested fields in middleware to limit depth [OK]

Common Mistakes:

• Confusing depth limit with response size limit
• Thinking client count limits query depth
• Believing disabling introspection limits depth

3. Given this GraphQL query:

{ user { posts { comments { text } } } }

If the server limits query depth to 2, what will happen?

medium

A. The query will fail because depth is 4

B. The query will succeed and return all nested data

C. The query will return only user and posts fields

D. The query will return only user field

Solution

1. Step 1: Calculate query depth

   The query has nesting: user (level 1) -> posts (level 2) -> comments (level 3) -> text (level 4). Depth is 4.

2. Step 2: Compare with server limit

   The server limits depth to 2, but query depth is 4, so it will be rejected.

3. Final Answer:

   The query will fail because depth is 4 -> Option A

4. Quick Check:

   Query depth 4 > limit 2, so fail [OK]

Hint: Count nested braces to find depth, compare to limit [OK]

Common Mistakes:

• Counting fields instead of nesting levels
• Assuming partial data returns on depth limit
• Ignoring that depth includes all nested levels

4. You wrote a GraphQL query that exceeds the server's complexity limit and gets rejected. What is a good way to fix it?

medium

A. Add more clients to distribute the load

B. Increase the server's memory to handle complex queries

C. Reduce the number of fields requested or simplify nested queries

D. Disable query complexity checks in the server

Solution

1. Step 1: Understand query complexity

   Query complexity measures how much work the server does; reducing fields or nesting lowers complexity.

2. Step 2: Evaluate fixes

   Increasing memory or clients doesn't reduce complexity; disabling checks risks server overload.

3. Final Answer:

   Reduce the number of fields requested or simplify nested queries -> Option C

4. Quick Check:

   Lower fields/nesting to reduce complexity [OK]

Hint: Simplify query fields and nesting to lower complexity [OK]

Common Mistakes:

• Thinking hardware upgrades fix complexity limits
• Ignoring complexity and disabling checks
• Confusing client count with query complexity

5. You want to protect your GraphQL server from expensive queries. Which combined approach best balances performance and flexibility?

hard

A. Disable all limits and rely on server scaling

B. Set a query depth limit, enforce query complexity cost, and cache frequent query results

C. Only limit query depth and ignore complexity cost

D. Allow unlimited queries but limit response size

Solution

1. Step 1: Understand protection methods

   Query depth limits nesting; complexity cost limits work done; caching speeds repeated queries.

2. Step 2: Evaluate combined approach

   Using all three balances server load and user flexibility well; other options are incomplete or risky.

3. Final Answer:

   Set a query depth limit, enforce query complexity cost, and cache frequent query results -> Option B

4. Quick Check:

   Combine depth, complexity, and caching for best protection [OK]

Hint: Use depth + complexity limits plus caching for best results [OK]

Common Mistakes:

• Relying on only one limit type
• Disabling limits and trusting scaling
• Limiting response size instead of query cost