Resolvers

import TopLevelAwait from "../shared/top-level-await.mdx"

If you learn best by doing, check out the tutorial on writing resolvers.

Apollo Server needs to know how to populate data for every field in your schema so that it can respond to requests for that data. To accomplish this, it uses resolvers.

A resolver is a function that's responsible for populating the data for a single field in your schema. It can populate that data in any way you define, such as by fetching data from a back-end database or a third-party API.

If you don't define a resolver for a particular field, Apollo Server automatically defines a default resolver for it.

Defining a resolver

Base syntax

Let's say our server defines the following (very short) schema:

type Query {
  numberSix: Int! # Should always return the number 6 when queried
  numberSeven: Int! # Should always return 7
}

We want to define resolvers for the numberSix and numberSeven fields of the root Query type so that they always return 6 and 7 when they're queried.

Those resolver definitions look like this:

const resolvers = {
  Query: {
    numberSix() {
      return 6;
    },
    numberSeven() {
      return 7;
    },
  },
};

As this example shows:

• You define all of your server's resolvers in a single JavaScript object (named resolvers above). This object is called the resolver map.
• The resolver map has top-level fields that correspond to your schema's types (such as Query above).
• Each resolver function belongs to whichever type its corresponding field belongs to.

Handling arguments

Now let's say our server defines this schema:

type User {
  id: ID!
  name: String
}

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

We want to be able to query the user field to fetch a user by its id.

To achieve this, our server needs access to user data. For this contrived example, assume our server defines the following hardcoded array:

const users = [
  {
    id: '1',
    name: 'Elizabeth Bennet',
  },
  {
    id: '2',
    name: 'Fitzwilliam Darcy',
  },
];

Now we can define a resolver for the user field, like so:

const resolvers = {
  Query: {
    user(parent, args, contextValue, info) {
      return users.find((user) => user.id === args.id);
    },
  },
};

As this example shows:

• A resolver can optionally accept four positional arguments: (parent, args, contextValue, info).
  • Learn more about these arguments.
• The args argument is an object that contains all GraphQL arguments that were provided for the field by the GraphQL operation.

Notice that this example doesn't define resolvers for User fields (id and name). That's because the default resolver that Apollo Server creates for these fields does the right thing: it obtains the value directly from the object returned by the user resolver.

Passing resolvers to Apollo Server

After you define all of your resolvers, you pass them to the constructor of ApolloServer (as the resolvers property), along with your schema's definition (as the typeDefs property).

The following example defines a hardcoded data set, a schema, and a resolver map. It then initializes an ApolloServer instance, passing the schema and resolvers to it.

import { ApolloServer } from '@apollo/server';
import { startStandaloneServer } from '@apollo/server/standalone';

// Hardcoded data store
const books = [
  {
    title: 'The Awakening',
    author: 'Kate Chopin',
  },
  {
    title: 'City of Glass',
    author: 'Paul Auster',
  },
];

// Schema definition
const typeDefs = `#graphql
  type Book {
    title: String
    author: String
  }

  type Query {
    books: [Book]
  }
`;

// Resolver map
const resolvers = {
  Query: {
    books() {
      return books;
    },
  },
};

// Pass schema definition and resolvers to the
// ApolloServer constructor
const server = new ApolloServer({
  typeDefs,
  resolvers,
});

// Launch the server
const { url } = await startStandaloneServer(server);

console.log(`🚀 Server listening at: ${url}`);

Note that you can define your resolvers across as many different files and objects as you want, as long as you merge all of them into a single resolver map that's passed to the ApolloServer constructor.

Resolver chains

Whenever a query asks for a field that returns an object type, the query also asks for at least one field of that object (if it didn't, there would be no reason to include the object in the query). A query always "bottoms out" on fields that return a scalar, an enum, or a list of these.

For example, all fields of this Product type "bottom out":

type Product {
  id: ID!
  name: String
  variants: [String!]
  availability: Availability!
}

enum Availability {
  AVAILABLE
  DISCONTINUED
}

Because of this rule, whenever Apollo Server resolves a field that returns an object type, it always then resolves one or more fields of that object. Those subfields might in turn also contain object types. Depending on your schema, this object-field pattern can continue to an arbitrary depth, creating what's called a resolver chain.

Example

Let's say our server defines the following schema:

# A library has a branch and books
type Library {
  branch: String!
  books: [Book!]
}

# A book has a title and author
type Book {
  title: String!
  author: Author!
}

# An author has a name
type Author {
  name: String!
}

type Query {
  libraries: [Library]
}

Here's a valid query against that schema:

query GetBooksByLibrary {
  libraries {
    books {
      author {
        name
      }
    }
  }
}

The resulting resolver chain for this query matches the hierarchical structure of the query itself:

graph LR;
  libraries("Query.libraries()") --> books("Library.books()");
  books --> author("Book.author()");
  author --> name("Author.name()");

These resolvers execute in the order shown above, and they each pass their return value to the next resolver in the chain via the parent argument.

Here's a code sample that can resolve the query above with this resolver chain:

import { ApolloServer } from '@apollo/server';
import { startStandaloneServer } from '@apollo/server/standalone';

const libraries = [
  {
    branch: 'downtown',
  },
  {
    branch: 'riverside',
  },
];

// The branch field of a book indicates which library has it in stock
const books = [
  {
    title: 'The Awakening',
    author: 'Kate Chopin',
    branch: 'riverside',
  },
  {
    title: 'City of Glass',
    author: 'Paul Auster',
    branch: 'downtown',
  },
];

// Schema definition
const typeDefs = `#graphql
  # A library has a branch and books
  type Library {
    branch: String!
    books: [Book!]
  }

  # A book has a title and author
  type Book {
    title: String!
    author: Author!
  }

  # An author has a name
  type Author {
    name: String!
  }

  # Queries can fetch a list of libraries
  type Query {
    libraries: [Library]
  }
`;

// Resolver map
const resolvers = {
  Query: {
    libraries() {
      // Return our hardcoded array of libraries
      return libraries;
    },
  },
  Library: {
    books(parent) {
      // Filter the hardcoded array of books to only include
      // books that are located at the correct branch
      return books.filter((book) => book.branch === parent.branch);
    },
  },
  Book: {
    // The parent resolver (Library.books) returns an object with the
    // author's name in the "author" field. Return a JSON object containing
    // the name, because this field expects an object.
    author(parent) {
      return {
        name: parent.author,
      };
    },
  },

  // Because Book.author returns an object with a "name" field,
  // Apollo Server's default resolver for Author.name will work.
  // We don't need to define one.
};

// Pass schema definition and resolvers to the
// ApolloServer constructor
const server = new ApolloServer({
  typeDefs,
  resolvers,
});

// Launch the server
const { url } = await startStandaloneServer(server);

console.log(`🚀 Server listening at: ${url}`);

If we now update our query to also ask for each book's title:

query GetBooksByLibrary {
  libraries {
    books {
      title
      author {
        name
      }
    }
  }
}

Then the resolver chain looks like this:

graph LR;
  libraries("Query.libraries()") --> books("Library.books()");
  books --> title("Book.title()");
  books --> author("Book.author()");
  author --> name("Author.name()");

When a chain "diverges" like this, each subchain executes in parallel.

Resolver arguments

Resolver functions are passed four arguments: parent, args, contextValue, and info (in that order).

You can use any name for each argument in your code, but the Apollo docs use these names as a convention. Instead of parent, it's also common to use the parent type's name or source.

The contextValue argument

Resolvers should never destructively modify the contextValue argument. This ensures consistency across all resolvers and prevents unexpected errors.

Your resolvers can access the shared contextValue object via their third positional argument. All resolvers that are executing for a particular operation have access to contextValue:

import { UserAPI } from "./datasources/users";

const resolvers = {
  Query: {
    // Our resolvers can access the fields in contextValue
    // from their third argument
    currentUser: (_, __, contextValue) => {
      return contextValue.dataSources.userApi.findUser(contextValue.token);
    },
  },
};

interface MyContext { // Context typing
  token?: String;
  dataSources: {
    userApi: UserAPI;
  }
}

const server = new ApolloServer<MyContext>({
  typeDefs,
  resolvers,
});

const { url } = await startStandaloneServer(server, {
  context: async ({ req }) => ({
    token: getToken(req.headers.authentication),
    dataSources: {
      userApi: new UserAPI()
    }
  })
});

To learn more about manage connections to databases and other data sources, see Fetching Data.

For more information and examples, see Sharing context.

Return values

A resolver function's return value is treated differently by Apollo Server depending on its type:

Default resolvers

If you don't define a resolver for a particular schema field, Apollo Server defines a default resolver for it.

The default resolver function uses the following logic:

graph TB;
  parent("Does the parent argument have a
property with this resolver's exact name?");
  parent--No-->null("Return undefined");
  parent--Yes-->function("Is that property's value a function?");
  function--No-->return("Return the property's value");
  function--Yes-->call("Call the function and
return its return value");

As an example, consider the following schema excerpt:

type Book {
  title: String
}

type Author {
  books: [Book]
}

If the resolver for the books field returns an array of objects that each contain a title field, then you can use a default resolver for the title field. The default resolver will correctly return parent.title.

Resolving unions and interfaces

There are GraphQL types that enable you to define a field that returns one of multiple possible object types (i.e., unions and interfaces). To resolve a field that can return different object types, you must define a __resolveType function to inform Apollo Server which type of object is being returned.

See examples of the __resolveType function.

Resolving federated entities

See Resolving Entities.

Monitoring resolver performance

As with all code, a resolver's performance depends on its logic. It's important to understand which of your schema's fields are computationally expensive or otherwise slow to resolve, so that you can either improve their performance or make sure you only query them when necessary.

Apollo Studio integrates directly with Apollo Server to provide field-level metrics that help you understand the performance of your graph over time. For more information, see Analyzing performance.