Custom configuration files in NestJS - Performance & Optimization

Performance: Custom configuration files

MEDIUM IMPACT

This affects the initial application startup time and memory usage by loading and parsing configuration files.

Loading configuration settings in a NestJS app

NestJS

import { ConfigModule } from '@nestjs/config';
@Module({
  imports: [ConfigModule.forRoot({
    load: [() => require('./custom-config')],
    isGlobal: true,
  })],
})
export class AppModule {}

Uses synchronous config loading with NestJS ConfigModule, avoiding blocking the event loop.

📈 Performance GainNon-blocking startup, reduces initial load delay by 50-100ms

Loading configuration settings in a NestJS app

NestJS

import * as fs from 'fs';
const config = JSON.parse(fs.readFileSync('config.json', 'utf-8'));
@Module({
  providers: [{ provide: 'CONFIG', useValue: config }],
})
export class AppModule {}

Synchronous file read blocks the event loop during startup, delaying app readiness.

📉 Performance CostBlocks rendering for 50-100ms depending on file size

Performance Comparison

Pattern	DOM Operations	Reflows	Paint Cost	Verdict
Synchronous config file read	N/A	N/A	Blocks event loop delaying LCP	[X] Bad
Asynchronous config loading with ConfigModule	N/A	N/A	Non-blocking startup improves LCP	[OK] Good

Rendering Pipeline

Configuration loading happens before the app serves requests, affecting the critical rendering path by delaying server readiness.

→Startup Initialization

→Module Resolution

⚠️ BottleneckSynchronous file I/O blocking event loop

Core Web Vital Affected

LCP

This affects the initial application startup time and memory usage by loading and parsing configuration files.

Optimization Tips

1Avoid synchronous file reads for config to prevent blocking startup.

2Use NestJS ConfigModule with asynchronous loading for better startup performance.

3Keep config files minimal and load only necessary settings to reduce parsing time.

Performance Quiz - 3 Questions

What is the main performance issue with synchronous config file reading in NestJS?

A It blocks the event loop delaying app startup

B It increases bundle size significantly

C It causes layout shifts in the browser

D It slows down database queries

DevTools: Performance

How to check: Record a startup profile and look for long tasks blocking the main thread before the app is ready.

What to look for: Long blocking tasks caused by synchronous file reads or heavy config parsing

Practice

1. What is the main purpose of using custom configuration files in a NestJS application?

easy

A. To write all logic inside configuration files

B. To keep app settings organized and separate from the main code

C. To replace the main app module

D. To store user data permanently

Solution

1. Step 1: Understand configuration role

   Custom configuration files are used to keep settings like API keys or database info separate from the main code.

2. Step 2: Identify the correct purpose

   This separation helps organize the app and makes it easier to change settings without touching code logic.

3. Final Answer:

   To keep app settings organized and separate from the main code -> Option B

4. Quick Check:

   Custom config files organize settings [OK]

Hint: Custom configs separate settings from code for clarity [OK]

Common Mistakes:

• Thinking config files hold app logic
• Confusing config files with database storage
• Assuming config files replace main modules

2. Which syntax correctly creates a named custom configuration file using registerAs in NestJS?

easy

A. export const config = registerAs('app', () => ({ port: 3000 }));

B. registerAs('app', { port: 3000 });

C. export default registerAs('app', () => ({ port: 3000 }));

D. registerAs('app', () => port: 3000);

Solution

1. Step 1: Understand registerAs usage

   The registerAs function takes a name and a function returning a config object.

2. Step 2: Check syntax correctness

   export const config = registerAs('app', () => ({ port: 3000 })); correctly exports a constant assigned to registerAs with a function returning an object.

3. Final Answer:

   export const config = registerAs('app', () => ({ port: 3000 })); -> Option A

4. Quick Check:

   registerAs needs a name and a function returning an object [OK]

Hint: Use export const with registerAs and a function returning an object [OK]

Common Mistakes:

• Omitting export or const keywords
• Passing object directly instead of a function
• Incorrect arrow function syntax

3. Given this custom config file:

export const databaseConfig = registerAs('database', () => ({ host: 'localhost', port: 5432 }));

And this module setup:

ConfigModule.forRoot({ load: [databaseConfig] })

What will configService.get('database.host') return?

medium

A. Error: Config not found

B. 'database.host'

C. undefined

D. 'localhost'

Solution

1. Step 1: Understand config loading

   The databaseConfig is loaded into ConfigModule with load, making its keys accessible.

2. Step 2: Access nested config value

   Using configService.get('database.host') accesses the 'host' key inside the 'database' config, which is 'localhost'.

3. Final Answer:

   'localhost' -> Option D

4. Quick Check:

   Nested config keys return their values [OK]

Hint: Use dot notation to get nested config values [OK]

Common Mistakes:

• Expecting the whole object instead of a value
• Using wrong key names
• Not loading config before accessing

4. What is wrong with this custom config file code?

export const appConfig = registerAs('app', () => { port: 3000 });

medium

A. The config name 'app' is invalid

B. Missing import of registerAs

C. The arrow function does not return the object properly

D. The port value must be a string

Solution

1. Step 1: Check arrow function return

   The arrow function uses curly braces without a return statement, so it returns undefined instead of the object.

2. Step 2: Correct syntax for returning object

   To return an object directly, wrap it in parentheses: () => ({ port: 3000 }).

3. Final Answer:

   The arrow function does not return the object properly -> Option C

4. Quick Check:

   Arrow functions need parentheses to return objects directly [OK]

Hint: Wrap object in parentheses to return from arrow function [OK]

Common Mistakes:

• Using curly braces without return in arrow functions
• Assuming config name must be special
• Thinking port must be string

5. You want to create two custom config files, appConfig and dbConfig, and load both in your NestJS app. Which setup correctly loads and accesses the dbConfig.username value?

hard

A. Load both configs in ConfigModule.forRoot({ load: [appConfig, dbConfig] }) and get with configService.get('dbConfig.username')

B. Load only appConfig and get dbConfig.username directly

C. Load both configs but access dbConfig.username with configService.get('username')

D. Load configs separately in different modules without forRoot

Solution

1. Step 1: Load multiple configs together

   Use ConfigModule.forRoot({ load: [appConfig, dbConfig] }) to load both custom configs at app start.

2. Step 2: Access nested config by namespace

   Access dbConfig.username using configService.get('dbConfig.username') because configs are namespaced by their registration name.

3. Final Answer:

   Load both configs in ConfigModule.forRoot({ load: [appConfig, dbConfig] }) and get with configService.get('dbConfig.username') -> Option A

4. Quick Check:

   Load all configs and use namespaced keys to access [OK]

Hint: Load all configs in forRoot and use dot keys to access [OK]

Common Mistakes:

• Loading only one config but accessing another
• Accessing keys without namespace prefix
• Trying to load configs outside forRoot