Environment-based configuration in NestJS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is environment-based configuration in NestJS?

It is a way to set different settings for your app depending on where it runs, like development, testing, or production. NestJS uses environment variables to manage these settings.

beginner

How do you load environment variables in a NestJS application?

You use the ConfigModule from '@nestjs/config' and call ConfigModule.forRoot() in your root module. This loads variables from a .env file into your app.

beginner

Why should you avoid hardcoding configuration values in your NestJS app?

Hardcoding makes it hard to change settings for different environments and can expose sensitive info. Using environment variables keeps config flexible and secure.

intermediate

How can you access environment variables inside a NestJS service?

Inject the ConfigService from '@nestjs/config' into your service, then use configService.get('VARIABLE_NAME') to get the value.

intermediate

What is the benefit of using validation with environment variables in NestJS?

Validation ensures required variables exist and have correct formats, preventing runtime errors and making your app more reliable.

Which NestJS module is used to load environment variables?

A HttpModule

B LoggerModule

C DatabaseModule

D ConfigModule

ConfigModule is designed to load and manage environment variables in NestJS.

Where do you typically store environment variables for local development?

A package.json

B .env file

C main.ts

D README.md

The .env file is the standard place to store environment variables locally.

How do you access an environment variable named 'PORT' inside a NestJS service?

A configService.get('PORT')

B ConfigModule.PORT

C this.PORT

D process.env.PORT

Using configService.get('PORT') is the recommended way to access env variables in NestJS services.

What is a key advantage of using environment-based configuration?

A Hardcoding values

B Ignoring security

C Changing settings without code changes

D Increasing app size

Environment-based config lets you change settings like database URLs without changing code.

Which method validates environment variables in NestJS?

A Using Joi schema with ConfigModule

B Using console.log

C Using process.exit()

D Using HttpModule

Joi schema validation can be integrated with ConfigModule to check env variables.

Explain how to set up environment-based configuration in a NestJS app.

Think about loading, storing, and accessing environment variables.

Describe why environment-based configuration is important for different deployment stages.

Consider how apps behave differently in various environments.

Practice

1. What is the main purpose of using environment-based configuration in a NestJS application?

easy

A. To write more complex code logic

B. To hardcode all secrets inside the source files

C. To increase the size of the application

D. To change app settings without modifying the code

Solution

1. Step 1: Understand environment-based configuration

   It allows changing settings like database URLs or API keys without changing the app code.

2. Step 2: Identify the correct purpose

   Changing settings without code changes helps adapt the app to different environments easily.

3. Final Answer:

   To change app settings without modifying the code -> Option D

4. Quick Check:

   Environment config = change settings without code [OK]

Hint: Think: config changes without touching code [OK]

Common Mistakes:

• Confusing config with code logic
• Assuming config increases app size
• Hardcoding secrets inside source files

2. Which NestJS module is used to load environment variables for configuration?

easy

A. ConfigModule

B. DatabaseModule

C. HttpModule

D. LoggerModule

Solution

1. Step 1: Recall NestJS modules for config

   The ConfigModule is designed to load and manage environment variables.

2. Step 2: Match module to purpose

   HttpModule handles HTTP, DatabaseModule handles DB, LoggerModule handles logs, so ConfigModule is correct.

3. Final Answer:

   ConfigModule -> Option A

4. Quick Check:

   ConfigModule loads env variables [OK]

Hint: ConfigModule = environment variables loader [OK]

Common Mistakes:

• Choosing unrelated modules like HttpModule
• Confusing ConfigModule with DatabaseModule
• Assuming LoggerModule manages config

3. Given this code snippet in a NestJS service:

constructor(private configService: ConfigService) {}

getDbHost() {
  return this.configService.get('DATABASE_HOST');
}

What will getDbHost() return if the environment variable DATABASE_HOST is set to localhost?

medium

A. DATABASE_HOST

B. undefined

C. localhost

D. null

Solution

1. Step 1: Understand ConfigService.get()

   This method returns the value of the environment variable key passed, here 'DATABASE_HOST'.

2. Step 2: Check environment variable value

   The variable DATABASE_HOST is set to 'localhost', so get() returns 'localhost'.

3. Final Answer:

   localhost -> Option C

4. Quick Check:

   ConfigService.get('DATABASE_HOST') = 'localhost' [OK]

Hint: ConfigService.get returns env var value [OK]

Common Mistakes:

• Expecting the key name instead of its value
• Assuming undefined if variable exists
• Confusing null with undefined

4. You wrote this code to load environment variables in NestJS:

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

@Module({
  imports: [ConfigModule.forRoot()],
})
export class AppModule {}

But your app crashes with an error saying environment variables are undefined. What is the likely cause?

medium

A. You must call ConfigService.get() inside main.ts only

B. You forgot to create a .env file or set environment variables

C. You need to import HttpModule as well

D. ConfigModule.forRoot() should be called inside a service, not module

Solution

1. Step 1: Check environment variable source

   ConfigModule loads variables from .env file or system environment. If missing, variables are undefined.

2. Step 2: Identify common mistake

   Not having a .env file or not setting variables causes undefined values and app crash.

3. Final Answer:

   You forgot to create a .env file or set environment variables -> Option B

4. Quick Check:

   Missing .env file = undefined env vars [OK]

Hint: Always create .env file or set env vars [OK]

Common Mistakes:

• Thinking ConfigModule.forRoot() is misplaced
• Assuming HttpModule is needed for config
• Calling ConfigService.get() only in main.ts

5. You want to load different database URLs for development and production in NestJS using environment variables. Which approach correctly uses ConfigModule to load .env.development or .env.production based on NODE_ENV?

hard

A. ConfigModule.forRoot({ envFilePath: `.env.${process.env.NODE_ENV}` })

B. ConfigModule.forRoot({ envFilePath: '.env' })

C. ConfigModule.forRoot({ envFilePath: '.env.production' }) always

D. ConfigModule.forRoot({ envFilePath: '.env.development' }) always

Solution

1. Step 1: Understand dynamic env file loading

   Using envFilePath with template string allows loading .env files based on NODE_ENV value.

2. Step 2: Check options

   ConfigModule.forRoot({ envFilePath: `.env.${process.env.NODE_ENV}` }) dynamically loads .env.development or .env.production depending on NODE_ENV, others load fixed files.

3. Final Answer:

   ConfigModule.forRoot({ envFilePath: `.env.${process.env.NODE_ENV}` }) -> Option A

4. Quick Check:

   Dynamic envFilePath = correct multi-env config [OK]

Hint: Use template string with NODE_ENV for envFilePath [OK]

Common Mistakes:

• Hardcoding envFilePath to one file always
• Not using process.env.NODE_ENV in path
• Assuming default .env handles all environments