refactor(env-vars): add validation

.github/workflows/ci.yml

@@ -32,7 +32,7 @@ jobs:
         run: pnpm run compose:up
       - name: Running API Tests
         working-directory: ./apps/api
-        run: pnpm run test
+        run: pnpm run test && pnpm run test:e2e
       - name: Upload results to Codecov
         uses: codecov/codecov-action@v4
         with:

apps/api/.env.sample

@@ -1,4 +1,16 @@
+# Server
+PORT=3000
+NODE_ENV=development
+
+# Database
 DATABASE_URL=postgres://postgres:pass1234@localhost:5432/disworse
 POSTGRES_DB=disworse
 POSTGRES_USER=postgres
 POSTGRES_PASSWORD=pass1234
+
+# Redis
+REDIS_URL=redis://localhost:6379
+
+# Auth
+SESSION_SECRET=secret
+COOKIE_MAX_AGE=604800000

apps/api/src/app.module.ts

@@ -10,12 +10,14 @@ import { AppService } from "./app.service";
 import { AuthenticatedGuard } from "./common/guards/auth.guard";
 import { DrizzleModule } from "./drizzle/drizzle.module";
 import { AuthModule } from "./modules/auth/auth.module";
+import { validate } from "./utils/env.validate";
 
 @Module({
     imports: [
         ConfigModule.forRoot({
             isGlobal: true,
-            envFilePath: "../../../.env.backend",
+            envFilePath: ".env",
+            validate,
         }),
         GraphQLModule.forRoot<ApolloDriverConfig>({
             driver: ApolloDriver,

apps/api/src/main.ts

@@ -1,4 +1,5 @@
 import { ValidationPipe } from "@nestjs/common";
+import { ConfigService } from "@nestjs/config";
 import { NestFactory } from "@nestjs/core";
 import RedisStore from "connect-redis";
 import * as session from "express-session";
@@ -8,7 +9,8 @@ import { AppModule } from "./app.module";
 
 async function bootstrap() {
     const app = await NestFactory.create(AppModule);
-    app.setGlobalPrefix("api");
+    const configService = app.get(ConfigService);
+
     app.useGlobalPipes(
         new ValidationPipe({
             transform: true,
@@ -17,16 +19,16 @@ async function bootstrap() {
     );
 
     const redisClient = await createClient({
-        url: String(process.env.REDIS_URL),
+        url: String(configService.getOrThrow("REDIS_URL")),
     }).connect();
 
     app.use(
         session({
-            secret: String(process.env.SESSION_SECRET),
+            secret: configService.getOrThrow<string>("SESSION_SECRET"),
             resave: false,
             saveUninitialized: false,
             cookie: {
-                maxAge: Number(process.env.COOKIE_MAX_AGE),
+                maxAge: configService.getOrThrow<number>("COOKIE_MAX_AGE"),
                 httpOnly: true,
             },
             store: new RedisStore({
@@ -37,8 +39,8 @@ async function bootstrap() {
 
     app.use(passport.initialize());
     app.use(passport.session());
-
     app.enableCors();
-    await app.listen(process.env.PORT || 3333);
+
+    await app.listen(configService.get("PORT") || 3333);
 }
 bootstrap();

apps/api/src/utils/env.validate.ts

@@ -0,0 +1,61 @@
+import { plainToInstance } from "class-transformer";
+import {
+    IsBoolean,
+    IsEnum,
+    IsNumber,
+    IsString,
+    Max,
+    Min,
+    validateSync,
+} from "class-validator";
+
+enum Environment {
+    Development = "development",
+    Production = "production",
+    Test = "test",
+}
+
+export class EnvironmentVariables {
+    @IsEnum(Environment)
+    NODE_ENV: Environment;
+
+    @IsNumber()
+    @Min(0)
+    @Max(65535)
+    PORT: number;
+
+    @IsString()
+    DATABASE_URL: string;
+
+    @IsString()
+    POSTGRES_DB: string;
+
+    @IsString()
+    POSTGRES_USER: string;
+
+    @IsString()
+    POSTGRES_PASSWORD: string;
+
+    @IsString()
+    REDIS_URL: string;
+
+    @IsString()
+    SESSION_SECRET: string;
+
+    @IsNumber()
+    COOKIE_MAX_AGE: number;
+}
+
+export function validate(config: Record<string, unknown>) {
+    const validatedConfig = plainToInstance(EnvironmentVariables, config, {
+        enableImplicitConversion: true,
+    });
+    const errors = validateSync(validatedConfig, {
+        skipMissingProperties: false,
+    });
+
+    if (errors.length > 0) {
+        throw new Error(errors.toString());
+    }
+    return validatedConfig;
+}

docker-compose.dev.yml

@@ -0,0 +1,16 @@
+services:
+    pg:
+        image: postgres:15-alpine
+        container_name: postgres-dev
+        restart: always
+        ports:
+            - 5432:5432
+        env_file:
+            - ./apps/api/.env
+
+    cache:
+        image: redis:7.2.4-alpine
+        container_name: cache-dev
+        restart: always
+        ports:
+            - 6379:6379

package.json

@@ -11,7 +11,7 @@
         "lint:fix:unsafe": "biome check . --write --unsafe",
         "prepare": "husky",
         "commitlint": "commitlint --edit",
-        "compose:up": "docker compose up -d --build",
+        "compose:up": "docker compose -f docker-compose.dev.yml up -d --build",
         "compose:down": "docker compose down -v"
     },
     "lint-staged": {