Error Extensions

Error Extensions is an important part of building production-ready GraphQL systems. This lesson explains what error extensions means, how it works, and how to apply it with practical examples you can reuse.

Error Extensions Overview

Error Extensions is a building block you will reach for often in GraphQL. It keeps related logic together and makes your intent obvious to reviewers and future maintainers.

When you learn error extensions properly, you avoid the guesswork that leads to bugs and rework. The example below shows the shape you will use in most real GraphQL projects.

import { GraphQLError } from 'graphql';

if (!input.email.includes('@')) {
  throw new GraphQLError('Invalid email', {
    extensions: { code: 'BAD_USER_INPUT', field: 'email' },
  });
}

Throw GraphQLError with an extensions code so clients can handle failures precisely.

Error Extensions Example

const typeDefs = gql`
  type Query { hello: String! }
`;
const resolvers = { Query: { hello: () => 'world' } };
const server = new ApolloServer({ typeDefs, resolvers });

Start from a minimal Error Extensions example and grow it only as needed.
Keep configuration explicit so Error Extensions behaves the same in every environment.
Name things clearly so teammates understand your Error Extensions at a glance.
Add tests around Error Extensions early to lock in expected behaviour.

GraphQL Cheatsheet

Quick GraphQL reference related to error extensions.

Concept	Example	Purpose
Schema	`type Query { user(id: ID!): User }`	Define the API shape
Resolver	`Query: { user: (_, { id }) => ... }`	Provide field data
Query	`query { user(id: 1) { name } }`	Read exactly what you need
Mutation	`mutation { createUser(input) { id } }`	Change data
Subscription	`subscription { postAdded { id } }`	Real-time updates
Context	`context: ({ req }) => ({ user })`	Auth and shared state
DataLoader	`loader.load(id)`	Batch to avoid N+1

How Error Extensions Works in GraphQL

Error Extensions fits into GraphQL's model of a single typed schema that clients query for exactly the data they need. The server resolves each requested field through resolver functions.

Throw GraphQLError with an extensions code so clients can handle failures precisely.

The schema is the contract between client and server.
Resolvers fetch data field by field, including nested types.
Clients request only the fields they use, avoiding over-fetching.
Context carries auth and shared services into every resolver.

Practical Guidance for Error Extensions

In production, error extensions should be efficient and secure. Batch data access with DataLoader, guard resolvers with authorization, and limit query depth and complexity.

Concern	Recommendation
N+1 queries	Batch with DataLoader
Security	Auth in context, depth/complexity limits
Errors	Typed GraphQLError with extension codes
Performance	Cache and paginate large lists

Common Mistakes

Copying error extensions snippets without understanding what each line does.
Skipping error handling and edge cases when wiring up error extensions.
Leaving error extensions untested, so regressions slip into production.
Over-engineering error extensions before you actually need the extra flexibility.

Key Takeaways

Error Extensions is a core part of working effectively with GraphQL.
Start small and keep error extensions focused on a single responsibility.
Apply consistent patterns so error extensions scales across your project.
Test and document error extensions to keep it maintainable over time.

Pro Tip

Pair error extensions with automated tests from day one. It is far cheaper to catch GraphQL regressions in CI than in production.