DataLoader batching and caching in GraphQL - Mini Project: Build & Apply

DataLoader Batching and Caching with GraphQL

📖 Scenario: You are building a GraphQL API for a simple blog. The API needs to fetch user data efficiently when resolving posts. To avoid fetching the same user multiple times and to reduce database calls, you will use DataLoader for batching and caching user requests.

🎯 Goal: Build a DataLoader instance that batches multiple user ID requests into a single database call and caches the results to avoid duplicate fetches during a GraphQL query.

📋 What You'll Learn

Create a DataLoader instance for users

Batch user ID requests into a single database call

Cache user data to prevent duplicate fetches

Use the DataLoader in a GraphQL resolver to fetch users by ID

💡 Why This Matters

🌍 Real World

DataLoader is commonly used in GraphQL APIs to optimize database access by batching multiple requests into one and caching results to improve performance.

💼 Career

Understanding DataLoader batching and caching is essential for backend developers working with GraphQL to build efficient and scalable APIs.

1

Setup a mock database function

Create a function called batchGetUsers that takes a list called userIds and returns a Promise resolving to a list of user objects with id and name properties. The function should simulate fetching users from a database by returning users with names like 'User 1', 'User 2', etc., matching the IDs.

GraphQL

# Your code here

Hint

Use userIds.map to create user objects and wrap the result in a Promise.

2

Create a DataLoader instance

Create a constant called userLoader and assign it a new DataLoader instance that uses the batchGetUsers function as its batch loading function.

GraphQL

function batchGetUsers(userIds) {
  return new Promise((resolve) => {
    const users = userIds.map(id => ({ id, name: `User ${id}` }));
    resolve(users);
  });
}

// Your code here

Hint

Use new DataLoader(batchGetUsers) to create the loader.

3

Use DataLoader in a GraphQL resolver

Create a resolver function called getUserById that takes id as an argument and returns the result of calling userLoader.load(id).

GraphQL

import DataLoader from 'dataloader';

function batchGetUsers(userIds) {
  return new Promise((resolve) => {
    const users = userIds.map(id => ({ id, name: `User ${id}` }));
    resolve(users);
  });
}

const userLoader = new DataLoader(batchGetUsers);

// Your code here

Hint

Use userLoader.load(id) inside the resolver function.

4

Complete the GraphQL resolver integration

Export an object called resolvers with a User field containing a user resolver function that takes parent and returns getUserById(parent.userId).

GraphQL

import DataLoader from 'dataloader';

function batchGetUsers(userIds) {
  return new Promise((resolve) => {
    const users = userIds.map(id => ({ id, name: `User ${id}` }));
    resolve(users);
  });
}

const userLoader = new DataLoader(batchGetUsers);

function getUserById(id) {
  return userLoader.load(id);
}

// Your code here

Hint

Define resolvers with a User field and a user resolver that calls getUserById(parent.userId).

Practice

1. What is the main purpose of using DataLoader in a GraphQL server?

easy

A. To batch multiple data requests into a single request and cache results during one operation

B. To replace the database with an in-memory store

C. To generate GraphQL schema automatically

D. To handle user authentication and authorization

Solution

1. Step 1: Understand DataLoader's role in GraphQL

   DataLoader groups many small data requests into fewer big ones to reduce database calls.

2. Step 2: Identify caching behavior

   It also caches results during one operation to avoid duplicate requests for the same data.

3. Final Answer:

   To batch multiple data requests into a single request and cache results during one operation -> Option A

4. Quick Check:

   Batching + caching = To batch multiple data requests into a single request and cache results during one operation [OK]

Hint: Remember: DataLoader batches and caches requests [OK]

Common Mistakes:

• Thinking DataLoader replaces the database
• Confusing DataLoader with schema generation tools
• Assuming it handles authentication

2. Which of the following is the correct way to create a new DataLoader instance in JavaScript?

easy

A. const loader = DataLoader(batchLoadFn);

B. const loader = new DataLoader(batchLoadFn);

C. const loader = DataLoader.new(batchLoadFn);

D. const loader = new DataLoader.load(batchLoadFn);

Solution

1. Step 1: Recall DataLoader instantiation syntax

   DataLoader is a class and must be instantiated with the new keyword.

2. Step 2: Check method usage

   The constructor takes a batch loading function as argument, so new DataLoader(batchLoadFn) is correct.

3. Final Answer:

   const loader = new DataLoader(batchLoadFn); -> Option B

4. Quick Check:

   Use new with DataLoader class [OK]

Hint: Always use 'new' keyword to create DataLoader [OK]

Common Mistakes:

• Omitting 'new' keyword
• Using incorrect method calls like .new or .load
• Calling DataLoader as a function without 'new'

3. Given the following DataLoader usage, what will be the output?

const DataLoader = require('dataloader');

const batchLoadFn = async keys => keys.map(key => key * 2);
const loader = new DataLoader(batchLoadFn);

(async () => {
  const result1 = await loader.load(2);
  const result2 = await loader.load(3);
  console.log([result1, result2]);
})();

medium

A. [4, 6]

B. [2, 3]

C. [NaN, NaN]

D. [undefined, undefined]

Solution

1. Step 1: Understand batchLoadFn behavior

   The batch function doubles each key: for key 2 returns 4, for key 3 returns 6.

2. Step 2: Analyze loader.load calls

   Calling loader.load(2) and loader.load(3) triggers batchLoadFn with keys [2,3], returning [4,6].

3. Final Answer:

   [4, 6] -> Option A

4. Quick Check:

   Keys doubled = [4, 6] [OK]

Hint: Batch function maps keys to doubled values [OK]

Common Mistakes:

• Expecting original keys as output
• Confusing async behavior with undefined
• Ignoring batch function logic

4. Identify the error in this DataLoader usage code snippet:

const DataLoader = require('dataloader');

const batchLoadFn = async keys => {
  return keys.map(key => fetchUserFromDB(key));
};

const loader = new DataLoader(batchLoadFn);

loader.load(1).then(user => console.log(user));

Assuming fetchUserFromDB returns a Promise resolving to user data.

medium

A. DataLoader must be called without 'new' keyword

B. fetchUserFromDB should not return a Promise

C. loader.load should be called with an array of keys, not a single key

D. batchLoadFn should return a Promise resolving to an array, but it returns an array of Promises

Solution

1. Step 1: Check batchLoadFn return type

   batchLoadFn returns an array of Promises because fetchUserFromDB returns a Promise for each key.

2. Step 2: Understand DataLoader batch function requirement

   DataLoader expects batchLoadFn to return a single Promise resolving to an array of results, not an array of Promises.

3. Final Answer:

   batchLoadFn should return a Promise resolving to an array, but it returns an array of Promises -> Option D

4. Quick Check:

   Return a Promise of array, not array of Promises [OK]

Hint: Batch function must return Promise resolving array, not array of Promises [OK]

Common Mistakes:

• Returning array of Promises instead of Promise of array
• Misusing 'new' keyword with DataLoader
• Passing single key instead of array to batch function

5. You want to optimize a GraphQL server that fetches posts and their authors. You use DataLoader for users and posts. Which approach best uses DataLoader's batching and caching to avoid redundant database calls?

hard

A. Create a new DataLoader instance for each field resolver call

B. Create a global DataLoader instance shared across all requests to cache all users and posts forever

C. Create one DataLoader instance per request for users and posts, and use load for each user or post ID

D. Call database queries directly without DataLoader to avoid complexity

Solution

1. Step 1: Understand DataLoader lifecycle

   DataLoader instances should be created per request to cache data only during that request and avoid stale data.

2. Step 2: Use DataLoader to batch and cache IDs

   Using load for each user or post ID lets DataLoader batch requests and cache results within the request.

3. Final Answer:

   Create one DataLoader instance per request for users and posts, and use load for each user or post ID -> Option C

4. Quick Check:

   Per-request DataLoader + load calls = Create one DataLoader instance per request for users and posts, and use load for each user or post ID [OK]

Hint: Create DataLoader per request, not globally or per field [OK]

Common Mistakes:

• Sharing DataLoader globally causing stale cache
• Creating new DataLoader per field causing no batching
• Skipping DataLoader and querying DB repeatedly