DataLoader integration in NestJS - Step-by-Step Execution

Concept Flow - DataLoader integration

Request received

↓

Create DataLoader instance

↓

Batch multiple requests

↓

Send batched query to database

↓

Receive batched results

↓

Distribute results to individual requests

↓

Return responses

↓

Request complete

DataLoader batches multiple data requests into one query, then splits results back to each request.

Execution Sample

NestJS

const loader = new DataLoader(keys => batchLoadFn(keys));
const p1 = loader.load('id1');
const p2 = loader.load('id2');
const result1 = await p1;
const result2 = await p2;
// batchLoadFn called once with ['id1', 'id2']

This code creates a DataLoader, loads two keys, and batches them into one database call.

Execution Table

Step	Action	Input Keys	Batch Function Called?	Batch Function Input	Batch Function Output	Individual Result Returned
1	Create DataLoader instance	-	No	-	-	-
2	Call loader.load('id1')	['id1']	No	-	-	Promise pending
3	Call loader.load('id2')	['id1','id2']	No	-	-	Promise pending
4	End of event loop tick triggers batch	['id1','id2']	Yes	['id1','id2']	[result1, result2]	-
5	Resolve promise for 'id1'	-	No	-	-	result1
6	Resolve promise for 'id2'	-	No	-	-	result2
7	All requests resolved	-	No	-	-	-

💡 Batch function called once with all keys; individual promises resolved with corresponding results.

Variable Tracker

Variable	Start	After Step 2	After Step 3	After Step 4	After Step 6	Final
loader.pendingKeys	[]	['id1']	['id1','id2']	[]	[]	[]
loader.promises	{}	{id1: Promise}	{id1: Promise, id2: Promise}	{id1: Resolved, id2: Resolved}	{id1: Resolved, id2: Resolved}	{}

Key Moments - 2 Insights

Why does DataLoader wait before calling the batch function?

DataLoader waits until the end of the event loop tick to collect all load calls (see steps 2 and 3) so it can batch them together in one call (step 4).

How does DataLoader know which result belongs to which request?

The batch function returns results in the same order as the input keys (step 4), so DataLoader matches each result to the corresponding promise (steps 5 and 6).

Visual Quiz - 3 Questions

Look at the execution table, at which step is the batch function called?

A Step 4

B Step 5

C Step 2

D Step 6

💡 Hint

Check the 'Batch Function Called?' column in the execution table.

According to the variable tracker, what is the state of loader.pendingKeys after step 3?

A []

B ['id1']

C ['id1','id2']

D ['id2']

💡 Hint

Look at the 'loader.pendingKeys' row and the 'After Step 3' column.

If you call loader.load('id3') before the batch function runs, what happens to the batch input?

A Batch input remains ['id1','id2']

B Batch input includes ['id1','id2','id3']

C Batch input is only ['id3']

D Batch function is called twice

💡 Hint

DataLoader batches all keys requested in the same event loop tick (see concept flow).

Concept Snapshot

DataLoader integration in NestJS:
- Create a DataLoader instance with a batch function.
- Calls to load() queue keys during the event loop tick.
- Batch function runs once per tick with all keys.
- Results returned in order, matched to requests.
- Improves performance by reducing duplicate queries.

Full Transcript

DataLoader integration batches multiple data requests into a single database query. When a request comes in, a DataLoader instance is created. Calls to loader.load() queue keys but do not immediately call the batch function. At the end of the event loop tick, DataLoader calls the batch function once with all queued keys. The batch function returns results in the same order as keys. DataLoader then resolves each individual promise with its corresponding result. This reduces duplicate database queries and improves performance in NestJS applications.

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