Error Masking

Understanding error masking helps you work with GraphQL confidently. Here you will learn the core ideas behind error masking, see working code, and pick up best practices used on real teams.

Error Masking Overview

Error Masking lets you structure GraphQL work so it stays readable, testable, and easy to scale. Instead of ad-hoc code, you follow a clear pattern that other developers can recognise immediately.

The key is to keep error masking focused and predictable. Start from the minimal example here, then layer in only the complexity your feature actually needs.

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 Masking Example

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

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

GraphQL Cheatsheet

Quick GraphQL reference related to error masking.

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 Masking Works in GraphQL

Error Masking 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 Masking

In production, error masking 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

Skipping error handling and edge cases when wiring up error masking.
Leaving error masking untested, so regressions slip into production.
Over-engineering error masking before you actually need the extra flexibility.
Ignoring documentation, which makes error masking hard for the next developer to change.

Key Takeaways

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

Pro Tip

When you get stuck on error masking, reduce it to the smallest reproducible example first — most GraphQL issues become obvious once the noise is gone.