Async configuration in NestJS - Mini Project: Build & Apply

Async Configuration in NestJS

📖 Scenario: You are building a NestJS application that needs to load configuration settings asynchronously, such as from a remote server or environment variables that require async processing.This is common when your app depends on external services or secrets that are not immediately available at startup.

🎯 Goal: Build a NestJS module that loads configuration asynchronously using ConfigModule.forRootAsync() with a factory function.This will teach you how to set up async configuration providers in NestJS.

📋 What You'll Learn

Create an async configuration factory function that returns an object with a port property set to 3000

Use ConfigModule.forRootAsync() to load configuration asynchronously

Inject the configuration service into a sample service

Access the port value from the configuration service

💡 Why This Matters

🌍 Real World

Many real-world NestJS applications need to load configuration asynchronously, such as fetching secrets from a vault or remote config service before the app starts.

💼 Career

Understanding async configuration setup is essential for backend developers working with NestJS to build scalable and secure applications.

1

Create an async configuration factory function

Create an async function called asyncConfigFactory that returns an object with the property port set to 3000.

NestJS

# Your code here

Hint

Use async function asyncConfigFactory() and return an object with port: 3000.

2

Configure ConfigModule with forRootAsync

Import ConfigModule from @nestjs/config and configure it using ConfigModule.forRootAsync() with the useFactory option set to asyncConfigFactory.

NestJS

async function asyncConfigFactory() {
  return { port: 3000 };
}

// Your code here

Hint

Use ConfigModule.forRootAsync({ useFactory: asyncConfigFactory }) to load config asynchronously.

3

Inject ConfigService into a sample service

Create a class called SampleService that injects ConfigService from @nestjs/config via the constructor and stores it in a private readonly property called configService.

NestJS

import { ConfigModule, ConfigService } from '@nestjs/config';

async function asyncConfigFactory() {
  return { port: 3000 };
}

const AppConfigModule = ConfigModule.forRootAsync({
  useFactory: asyncConfigFactory
});

// Your code here

Hint

Use constructor injection with private readonly configService: ConfigService.

4

Access the port value from ConfigService

Inside SampleService, add a method called getPort that returns the port value from configService.get('port').

NestJS

import { ConfigModule, ConfigService } from '@nestjs/config';

async function asyncConfigFactory() {
  return { port: 3000 };
}

const AppConfigModule = ConfigModule.forRootAsync({
  useFactory: asyncConfigFactory
});

class SampleService {
  constructor(private readonly configService: ConfigService) {}

  // Add getPort method here
}

Hint

Define getPort() that returns this.configService.get('port').

Practice

1. What is the main purpose of using forRootAsync in NestJS configuration?

easy

A. To disable configuration loading in the app

B. To synchronously load configuration from a static file

C. To load configuration asynchronously, allowing external calls before app starts

D. To automatically reload configuration on every request

Solution

1. Step 1: Understand async config purpose

   forRootAsync is designed to load configuration that requires asynchronous operations like fetching from a remote service.

2. Step 2: Compare options

   Options A, B, and D do not describe asynchronous loading or external calls. Only To load configuration asynchronously, allowing external calls before app starts correctly states the purpose.

3. Final Answer:

   To load configuration asynchronously, allowing external calls before app starts -> Option C

4. Quick Check:

   Async config = forRootAsync usage [OK]

Hint: Async config means waiting for external data before app starts [OK]

Common Mistakes:

• Thinking forRootAsync loads config synchronously
• Confusing forRootAsync with auto-reload features
• Assuming it disables config loading

2. Which of the following is the correct syntax to use forRootAsync with a factory function in NestJS?

easy

A. ConfigModule.forRoot({ useFactory: () => ({ key: 'value' }) })

B. ConfigModule.forRootAsync({ useFactory: () => 'value' })

C. ConfigModule.forRootAsync({ factory: () => ({ key: 'value' }) })

D. ConfigModule.forRootAsync({ useFactory: async () => ({ key: 'value' }) })

Solution

1. Step 1: Identify correct method and property names

   The method is forRootAsync and the correct property for async config is useFactory.

2. Step 2: Check syntax correctness

   ConfigModule.forRootAsync({ useFactory: async () => ({ key: 'value' }) }) uses forRootAsync with useFactory returning an object asynchronously, which is correct. ConfigModule.forRoot({ useFactory: () => ({ key: 'value' }) }) uses forRoot which is synchronous. ConfigModule.forRootAsync({ factory: () => ({ key: 'value' }) }) uses wrong property factory. ConfigModule.forRootAsync({ useFactory: () => 'value' }) returns a string instead of an object.

3. Final Answer:

   ConfigModule.forRootAsync({ useFactory: async () => ({ key: 'value' }) }) -> Option D

4. Quick Check:

   Correct syntax = ConfigModule.forRootAsync({ useFactory: async () => ({ key: 'value' }) }) [OK]

Hint: Use forRootAsync with useFactory returning config object [OK]

Common Mistakes:

• Using forRoot instead of forRootAsync
• Using wrong property name like 'factory'
• Returning non-object from factory

3. Given this NestJS async config snippet, what will be the resolved configuration object?

ConfigModule.forRootAsync({
  useFactory: async () => {
    const apiKey = await Promise.resolve('12345');
    return { apiKey };
  }
})

medium

A. { apiKey: '12345' }

B. { apiKey: Promise }

C. undefined

D. Throws runtime error

Solution

1. Step 1: Understand async factory behavior

   The factory function awaits a resolved promise returning '12345' and returns an object with apiKey property.

2. Step 2: Determine final config object

   The returned object is { apiKey: '12345' }, not a promise or undefined, and no error is thrown.

3. Final Answer:

   { apiKey: '12345' } -> Option A

4. Quick Check:

   Async factory returns resolved object [OK]

Hint: Async factory returns awaited object, not promise [OK]

Common Mistakes:

• Thinking config is a Promise object
• Assuming undefined because of async
• Expecting runtime errors from await

4. Identify the error in this async configuration setup:

ConfigModule.forRootAsync({
  useFactory: () => {
    const secret = fetchSecret();
    return { secret };
  }
})

async function fetchSecret() {
  return 'topsecret';
}

medium

A. useFactory must be async to await fetchSecret

B. fetchSecret should not be async

C. Return value must be a string, not object

D. No error, code is correct

Solution

1. Step 1: Analyze async function usage

   fetchSecret is async and returns a Promise. useFactory calls it but does not await, so secret is a Promise, not the resolved value.

2. Step 2: Fix the factory function

   useFactory must be declared async and await fetchSecret to get the actual secret string before returning the config object.

3. Final Answer:

   useFactory must be async to await fetchSecret -> Option A

4. Quick Check:

   Async calls need await in factory [OK]

Hint: Async calls inside factory require async/await [OK]

Common Mistakes:

• Forgetting to mark useFactory async
• Returning unresolved Promise as config value
• Assuming fetchSecret sync

5. You want to load configuration asynchronously from a database service in NestJS. Which setup correctly injects the service and uses it in forRootAsync?

hard

A. ConfigModule.forRootAsync({ useFactory: () => dbService.getConfig(), inject: [DatabaseService] })

B. ConfigModule.forRootAsync({ useFactory: async (dbService) => await dbService.getConfig(), inject: [DatabaseService] })

C. ConfigModule.forRootAsync({ useFactory: async () => await dbService.getConfig() })

D. ConfigModule.forRoot({ useFactory: async (dbService) => await dbService.getConfig(), inject: [DatabaseService] })

Solution

1. Step 1: Understand dependency injection in async config

   To use a service inside useFactory, it must be injected via the inject array and passed as a parameter.

2. Step 2: Check async usage and method call

   ConfigModule.forRootAsync({ useFactory: async (dbService) => await dbService.getConfig(), inject: [DatabaseService] }) correctly marks useFactory async, injects DatabaseService, and awaits getConfig(). Options B and C miss injection or async. ConfigModule.forRoot({ useFactory: async (dbService) => await dbService.getConfig(), inject: [DatabaseService] }) uses forRoot which is synchronous.

3. Final Answer:

   ConfigModule.forRootAsync({ useFactory: async (dbService) => await dbService.getConfig(), inject: [DatabaseService] }) -> Option B

4. Quick Check:

   Inject services and await async calls in forRootAsync [OK]

Hint: Inject services and await async calls in useFactory [OK]

Common Mistakes:

• Not injecting the service in inject array
• Using forRoot instead of forRootAsync
• Not marking useFactory async when awaiting