DataLoader integration in NestJS - Mini Project: Build & Apply

DataLoader integration

📖 Scenario: You are building a NestJS backend that fetches user data from a database. To optimize performance and avoid redundant database calls, you want to integrate DataLoader to batch and cache requests efficiently.

🎯 Goal: Build a simple NestJS service that uses DataLoader to batch load users by their IDs. This will reduce duplicate database calls and improve performance.

📋 What You'll Learn

Create a basic users data array to simulate a database

Create a DataLoader instance to batch load users by IDs

Implement a service method that uses the DataLoader to fetch users

Integrate the DataLoader in a NestJS provider for reuse

💡 Why This Matters

🌍 Real World

DataLoader is commonly used in backend frameworks like NestJS to optimize database access by batching and caching requests, reducing redundant queries and improving performance.

💼 Career

Understanding DataLoader integration is valuable for backend developers working with GraphQL or REST APIs to build efficient, scalable services.

1

DATA SETUP: Create a users array

Create a constant array called users with these exact objects: { id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }, and { id: 3, name: 'Charlie' }.

NestJS

# Create the users array with three user objects
# Your code here

Hint

Use const users = [ ... ] with objects inside the array.

2

CONFIGURATION: Create a DataLoader instance

Create a constant called userLoader and assign it a new DataLoader instance. The batch loading function should accept an array of ids and return a Promise resolving to an array of users filtered from users matching those ids in the same order.

NestJS

const users = [
  { id: 1, name: 'Alice' },
  { id: 2, name: 'Bob' },
  { id: 3, name: 'Charlie' }
];

// Create DataLoader instance for users
# Your code here

Hint

Use new DataLoader(async (ids) => ...) and map ids to find matching users.

3

CORE LOGIC: Implement a service method using DataLoader

Create an async function called getUserById that takes a single parameter id. Inside, return the result of calling userLoader.load(id).

NestJS

import DataLoader from 'dataloader';

const users = [
  { id: 1, name: 'Alice' },
  { id: 2, name: 'Bob' },
  { id: 3, name: 'Charlie' }
];

const userLoader = new DataLoader(async (ids) => {
  return ids.map(id => users.find(user => user.id === id));
});

// Create async function getUserById using userLoader
# Your code here

Hint

Define async function getUserById(id) and return userLoader.load(id).

4

COMPLETION: Export the service method and DataLoader

Add export statements to export both getUserById and userLoader constants from the module.

NestJS

import DataLoader from 'dataloader';

const users = [
  { id: 1, name: 'Alice' },
  { id: 2, name: 'Bob' },
  { id: 3, name: 'Charlie' }
];

const userLoader = new DataLoader(async (ids) => {
  return ids.map(id => users.find(user => user.id === id));
});

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

// Export getUserById and userLoader
# Your code here

Hint

Use export { getUserById, userLoader }; to export both.

Practice

1. What is the main purpose of using DataLoader in a NestJS application?

easy

A. To handle HTTP routing and middleware

B. To serve static files efficiently

C. To manage database schema migrations

D. To batch and cache multiple data requests to improve performance

Solution

1. Step 1: Understand DataLoader's role

   DataLoader is designed to batch and cache data fetching operations to reduce redundant calls.

2. Step 2: Compare with other options

   Options A, C, and D relate to other NestJS features, not DataLoader's purpose.

3. Final Answer:

   To batch and cache multiple data requests to improve performance -> Option D

4. Quick Check:

   DataLoader = batch + cache [OK]

Hint: DataLoader batches requests to avoid repeated fetching [OK]

Common Mistakes:

• Confusing DataLoader with routing or middleware
• Thinking DataLoader manages database migrations
• Assuming DataLoader serves static files

2. Which of the following is the correct way to create a DataLoader instance inside a NestJS service?

easy

A. const loader = new DataLoader(batchFunction());

B. const loader = DataLoader.create(batchFunction);

C. const loader = new DataLoader(keys => batchFunction(keys));

D. const loader = DataLoader(batchFunction);

Solution

1. Step 1: Recall DataLoader instantiation syntax

   DataLoader is instantiated with new DataLoader(batchFunction), where batchFunction is a function receiving keys.

2. Step 2: Analyze options

   const loader = new DataLoader(keys => batchFunction(keys)); correctly uses new DataLoader(keys => batchFunction(keys)). Options B, C, and D use incorrect syntax or call batchFunction immediately.

3. Final Answer:

   const loader = new DataLoader(keys => batchFunction(keys)); -> Option C

4. Quick Check:

   Use new DataLoader(batchFunction) [OK]

Hint: Use 'new DataLoader' with a batch function callback [OK]

Common Mistakes:

• Calling batchFunction immediately instead of passing it
• Using DataLoader as a function without 'new'
• Using a non-function argument

3. Given the following batch function in a NestJS DataLoader service:

async function batchUsers(ids: readonly number[]) {
  return ids.map(id => ({ id, name: `User${id}` }));
}

What will be the output of await loader.load(2) if loader is created with this batch function?

medium

A. { id: 2, name: 'User2' }

B. [{ id: 2, name: 'User2' }]

C. undefined

D. Error: batch function must return array of same length

Solution

1. Step 1: Understand batch function output

   The batch function returns an array of user objects matching the input ids in order.

2. Step 2: Understand loader.load behavior

   loader.load(2) returns a single user object corresponding to id 2, not an array.

3. Final Answer:

   { id: 2, name: 'User2' } -> Option A

4. Quick Check:

   load(id) returns single item from batch array [OK]

Hint: load() returns one item, batch returns array [OK]

Common Mistakes:

• Expecting load() to return an array
• Confusing batch function return with load return
• Assuming batch function returns undefined

4. You wrote this batch function for DataLoader:

async function batchPosts(ids: readonly number[]) {
  const posts = await getPostsByIds(ids);
  return posts;
}

But you get wrong results when loading posts. What is the likely problem?

medium

A. The returned array posts is not in the same order as ids

B. The batch function should not be async

C. You must return a Map instead of an array

D. The function should return a Promise of a single post, not an array

Solution

1. Step 1: Check batch function contract

   DataLoader requires the batch function to return results in the same order as the keys array.

2. Step 2: Analyze getPostsByIds behavior

   If getPostsByIds returns posts unordered, the batch function breaks this contract causing wrong results.

3. Final Answer:

   The returned array posts is not in the same order as ids -> Option A

4. Quick Check:

   Batch function must preserve order [OK]

Hint: Batch function output order must match input keys order [OK]

Common Mistakes:

• Ignoring order of returned array
• Thinking batch function can't be async
• Returning Map instead of array

5. In a NestJS GraphQL resolver, you want to integrate DataLoader to batch user requests per HTTP request. Which approach correctly ensures a new DataLoader instance is created for each request to avoid caching issues across users?

hard

A. Create a DataLoader instance once in the module constructor

B. Create a DataLoader instance inside a request-scoped provider injected into the resolver

C. Create a single global DataLoader instance as a singleton service

D. Use a static DataLoader instance shared across all requests

Solution

1. Step 1: Understand DataLoader caching scope

   DataLoader caches results per instance, so sharing one instance globally causes cross-request data leaks.

2. Step 2: Use request-scoped provider

   Creating a DataLoader instance per request via a request-scoped provider ensures isolated caches per user request.

3. Final Answer:

   Create a DataLoader instance inside a request-scoped provider injected into the resolver -> Option B

4. Quick Check:

   Request-scoped DataLoader avoids cross-request cache [OK]

Hint: Use request-scoped provider for per-request DataLoader [OK]

Common Mistakes:

• Using singleton DataLoader causing shared cache
• Creating DataLoader once in module constructor
• Using static instance shared globally