Async configuration in NestJS

Introduction

Async configuration lets you set up your app using data that might come from slow sources like databases or remote servers. This helps your app start only after it has all the needed settings.

When you need to load configuration from a database before the app starts.

When fetching secrets or API keys from a remote vault service asynchronously.

When configuration depends on environment variables that require async processing.

When you want to delay configuration until some async initialization completes.

Syntax

NestJS

ConfigModule.forRootAsync({
  imports: [OtherModule],
  useFactory: async (dependency) => ({
    key: await dependency.getValue(),
  }),
  inject: [Dependency],
  isGlobal: true,
})

useFactory is an async function that returns the config object.

inject lists dependencies to pass into the factory function.

Examples

Loads config asynchronously without dependencies.

NestJS

ConfigModule.forRootAsync({
  useFactory: async () => ({
    databaseHost: await getHostFromRemote(),
  }),
})

Loads config using a service from another module.

NestJS

ConfigModule.forRootAsync({
  imports: [SecretsModule],
  useFactory: async (secretsService) => ({
    apiKey: await secretsService.getApiKey(),
  }),
  inject: [SecretsService],
})

Sample Program

This example shows how to load configuration asynchronously from a service that simulates fetching data remotely. The app waits for the config before starting.

NestJS

import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { NestFactory } from '@nestjs/core';

class RemoteConfigService {
  async getConfig() {
    // Simulate async config fetch
    return new Promise(resolve => setTimeout(() => resolve({ port: 3000 }), 100));
  }
}

@Module({
  providers: [RemoteConfigService],
  exports: [RemoteConfigService],
})
class RemoteConfigModule {}

@Module({
  imports: [
    RemoteConfigModule,
    ConfigModule.forRootAsync({
      imports: [RemoteConfigModule],
      useFactory: async (remoteConfigService: RemoteConfigService) => {
        const config = await remoteConfigService.getConfig();
        return {
          port: config.port,
        };
      },
      inject: [RemoteConfigService],
      isGlobal: true,
    }),
  ],
})
export class AppModule {}

// Usage example
async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  const configService = app.get(ConfigService);
  console.log('Port:', configService.get('port'));
  await app.close();
}

bootstrap();

Important Notes

Async config helps when config values are not immediately available.

Always inject needed services in inject array to use them in useFactory.

Set isGlobal: true to make config available everywhere without importing repeatedly.

Summary

Async configuration loads settings that need time or external calls.

Use forRootAsync with useFactory and inject to set it up.

This ensures your app starts with all config ready.

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