Merge pull request #176 from lil-lab/recnet-api/add-config-service

[recnet-api] Add config service

apps/recnet-api/src/app.module.ts

@@ -1,10 +1,21 @@
 import { Module } from "@nestjs/common";
+import { ConfigModule } from "@nestjs/config";
 
 import { HealthModule } from "./modules/health/health.module";
 import { UserModule } from "./modules/user/user.module";
+import * as CommonConfigs from "./config/common.config";
+import { parseEnv } from "./config/env.schema";
 
 @Module({
-  imports: [HealthModule, UserModule],
+  imports: [
+    ConfigModule.forRoot({
+      isGlobal: true,
+      validate: (env) => parseEnv(env),
+      load: [...Object.values(CommonConfigs)],
+    }),
+    HealthModule,
+    UserModule,
+  ],
   controllers: [],
   providers: [],
 })

apps/recnet-api/src/config/common.config.ts

@@ -0,0 +1,18 @@
+import { registerAs } from "@nestjs/config";
+
+import { parseEnv } from "./env.schema";
+
+const parsedEnv = parseEnv(process.env);
+
+export const DBConfig = registerAs("db", () => ({
+  host: parsedEnv.RDS_HOSTNAME,
+  port: parsedEnv.RDS_PORT,
+  database: parsedEnv.RDS_DB_NAME,
+  username: parsedEnv.RDS_USERNAME,
+  password: parsedEnv.RDS_PASSWORD,
+}));
+
+export const PrismaConfig = registerAs("prisma", () => ({
+  schema: parsedEnv.PRISMA_SCHEMA,
+  migrate: parsedEnv.DB_MIGRATE,
+}));

apps/recnet-api/src/config/env.schema.ts

@@ -0,0 +1,22 @@
+import { z } from "zod";
+
+const nodeEnv = z.enum(["development", "production", "local", "test"]);
+
+export const EnvSchema = z.object({
+  PORT: z.coerce.number().optional().default(3000),
+  NODE_ENV: nodeEnv.default("development"),
+  // db config
+  RDS_HOSTNAME: z.string().optional().default("localhost"),
+  RDS_PORT: z.coerce.number().optional().default(5432),
+  RDS_DB_NAME: z.string(),
+  RDS_USERNAME: z.string(),
+  RDS_PASSWORD: z.string(),
+  // prisma config
+  PRISMA_SCHEMA: z.string().optional().default("prisma/schema.prisma"),
+  DB_MIGRATE: z.coerce.boolean().optional().default(false),
+});
+
+export const parseEnv = (env: Record<string, string>) => {
+  const parsedEnv = EnvSchema.parse(env);
+  return parsedEnv;
+};

apps/recnet-api/src/database/prisma/prisma.connection.provider.ts

@@ -1,15 +1,9 @@
 import { execSync } from "child_process";
 
-import { Injectable, OnModuleInit } from "@nestjs/common";
+import { Inject, Injectable, OnModuleInit } from "@nestjs/common";
+import { ConfigType } from "@nestjs/config";
 import { PrismaClient } from "@prisma/client";
-
-const postgresConfig = {
-  host: process.env.RDS_HOSTNAME,
-  port: parseInt(process.env.RDS_PORT, 10),
-  database: process.env.RDS_DB_NAME,
-  username: process.env.RDS_USERNAME,
-  password: process.env.RDS_PASSWORD,
-};
+import { DBConfig, PrismaConfig } from "src/config/common.config";
 
 @Injectable()
 export class PrismaConnectionProvider
@@ -18,12 +12,16 @@ export class PrismaConnectionProvider
 {
   private prismaUrl: string;
 
-  constructor() {
-    const connectionUrl = `postgresql://${postgresConfig.username}:${encodeURIComponent(
-      postgresConfig.password
-    )}@${postgresConfig.host}:${postgresConfig.port}/${
-      postgresConfig.database
-    }?schema=recnet`;
+  constructor(
+    @Inject(DBConfig.KEY)
+    private dbConfig: ConfigType<typeof DBConfig>,
+    @Inject(PrismaConfig.KEY)
+    private prismaConfig: ConfigType<typeof PrismaConfig>
+  ) {
+    const { host, port, database, username, password } = dbConfig;
+    const connectionUrl = `postgresql://${username}:${encodeURIComponent(
+      password
+    )}@${host}:${port}/${database}?schema=recnet`;
 
     super({
       datasources: {
@@ -39,11 +37,9 @@ export class PrismaConnectionProvider
   async onModuleInit() {
     await this.$connect();
 
-    const prismaSchema = process.env.PRISMA_SCHEMA || "prisma/schema.prisma";
-
-    if (process.env.DB_MIGRATE === "true") {
+    if (this.prismaConfig.migrate) {
       execSync(
-        `export PRISMA_DATABASE_URL=${this.prismaUrl} && npx prisma migrate deploy --schema=${prismaSchema}`,
+        `export PRISMA_DATABASE_URL=${this.prismaUrl} && npx prisma migrate deploy --schema=${this.prismaConfig.schema}`,
         { stdio: "inherit" }
       );
     }

package.json

@@ -9,6 +9,7 @@
   "dependencies": {
     "@hookform/resolvers": "^3.3.4",
     "@nestjs/common": "^10.0.2",
+    "@nestjs/config": "^3.2.0",
     "@nestjs/core": "^10.0.2",
     "@nestjs/platform-express": "^10.0.2",
     "@nestjs/swagger": "^7.3.0",
@@ -65,8 +66,8 @@
     "@nx/js": "18.0.4",
     "@nx/nest": "18.0.4",
     "@nx/next": "18.0.4",
-    "@nx/vite": "18.0.4",
     "@nx/node": "18.0.4",
+    "@nx/vite": "18.0.4",
     "@nx/web": "18.0.4",
     "@nx/webpack": "18.0.4",
     "@nx/workspace": "18.0.4",