Async configuration in NestJS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is async configuration in NestJS?

Async configuration allows you to load module settings asynchronously, for example, from a database or remote service, before the module initializes.

beginner

Which method is commonly used to provide async configuration in a NestJS module?

The forRootAsync() method is used to provide asynchronous configuration for modules in NestJS.

intermediate

What are the common ways to supply async configuration in NestJS modules?

You can use <code>useFactory</code> with async functions, <code>useClass</code> with a class implementing <code>ConfigFactory</code>, or <code>useExisting</code> to reuse an existing provider.

beginner

Why is async configuration useful in real-life NestJS apps?

It helps load settings from external sources like environment files, databases, or APIs before the app starts, making apps flexible and secure.

intermediate

Show a simple example of async configuration using useFactory in NestJS.

Example:

ConfigModule.forRootAsync({
  useFactory: async () => ({
    apiKey: await fetchApiKeyFromRemote(),
  }),
})

Which method allows asynchronous configuration in a NestJS module?

A asyncConfig()

B forRoot()

C configureAsync()

D forRootAsync()

forRootAsync() is the standard method to provide async configuration in NestJS modules.

What does useFactory do in async configuration?

A Defines a function that returns configuration asynchronously

B Creates a new class for configuration

C Imports configuration from another module

D Directly injects configuration values

useFactory lets you define an async function that returns config values.

Which of these is NOT a valid way to provide async config in NestJS?

A useFactory

B useExisting

C useStatic

D useClass

useStatic is not a valid option for async config in NestJS.

Why might you want to load config asynchronously?

A To speed up app startup by skipping config

B To fetch secrets or settings from remote sources before app starts

C To avoid using environment variables

D To hardcode config values

Async config helps load dynamic or secret data before the app runs.

In async config, what does useClass do?

A Uses a class that implements a factory to provide config

B Creates a new instance of the module

C Imports config from a static file

D Runs a function to get config

useClass lets you specify a class that returns config asynchronously.

Explain how async configuration works in NestJS and why it is useful.

Think about loading config from a database or API before app starts.

Describe a simple example of using async configuration with useFactory in NestJS.

Imagine fetching an API key from a remote service.

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