Added mongo config + minor changes

Author: c0dewriter

.env.sample

@@ -56,6 +56,25 @@ export REDIS_RESTART_POLICY='unless-stopped'
 export REDIS_STOP_GRACE_PERIOD='1m00s'
 export REDIS_HOST_SERVICE_DIR='./services/redis'
 
+# ======================================================================= #
+#                                  Mongo                                  #
+# ======================================================================= #
+export MONGO_CONNECTION_SCHEME='mongodb'
+export MONGO_HOST='127.0.0.1'
+export MONGO_INITDB_ROOT_USERNAME='mongo'
+export MONGO_INITDB_ROOT_PASSWORD='mongo'
+export MONGO_INITDB_DATABASE='boilerplate-primary'
+
+# Container-Related
+export MONGO_SERVICE_NAME=mongo
+export MONGO_RESTART_POLICY='unless-stopped'
+export MONGO_SERVICE_PORT_MAP='27017:27017'
+export MONGO_SERVICE_PORT_EXPOSE='27017'
+export MONGO_STOP_GRACE_PERIOD='3m30s'
+export MONGO_SERVICE_DIR_NAME='mongo'
+export MONGO_HOST_SERVICE_DIR='./services/mongo'
+
+
 # ======================================================================= #
 #                          Password Hash: Argon2                          #
 # ======================================================================= #

package.json

@@ -30,6 +30,7 @@
     "@nestjs/common": "^10.0.0",
     "@nestjs/config": "^3.2.2",
     "@nestjs/core": "^10.0.0",
+    "@nestjs/mongoose": "^10.0.6",
     "@nestjs/platform-express": "^10.0.0",
     "@nestjs/swagger": "^7.3.1",
     "@nestjs/typeorm": "^10.0.2",
@@ -42,6 +43,7 @@
     "helmet": "^7.1.0",
     "ioredis": "^5.4.1",
     "joi": "^17.13.1",
+    "mongoose": "^8.4.0",
     "nestjs-i18n": "^10.4.5",
     "pg": "^8.11.5",
     "reflect-metadata": "^0.2.0",

src/app.module.ts

@@ -7,9 +7,9 @@ import { ClassifiedExceptionFilter } from "@/base/filters/classified.exception.f
 import { OutInterceptor } from "@/base/interceptors/out.interceptor";
 import developmentSchema from "@/config/env/schema.development";
 import productionSchema from "@/config/env/schema.production";
-
-import { PostgresConfigModule } from "./config/postgres/postgres.config.module";
-import { RedisConfigModule } from "./config/redis/redis.config.module";
+import { MongoConfigModule } from "@/config/mongo/mongo.config.module";
+import { PostgresConfigModule } from "@/config/postgres/postgres.config.module";
+import { RedisConfigModule } from "@/config/redis/redis.config.module";
 
 @Module({
   imports: [
@@ -36,6 +36,7 @@ import { RedisConfigModule } from "./config/redis/redis.config.module";
     // ** =============================================================== ** //
     PostgresConfigModule,
     RedisConfigModule,
+    MongoConfigModule,
   ],
   controllers: [],
   providers: [

src/base/.keep

@@ -23,4 +23,13 @@ export default Joi.object({
   REDIS_CACHE_DB_NUMBER: Joi.number(),
   REDIS_USERNAME: Joi.string().allow(""),
   REDIS_PASSWORD: Joi.string(),
+
+  // ** ============================ Mongo ============================ ** //
+  MONGO_CONNECTION_SCHEME: Joi.string().valid("mongodb", "mongodb+srv"),
+  MONGO_HOST: Joi.string().valid("localhost", "127.0.0.1"),
+  MONGO_INITDB_ROOT_USERNAME: Joi.string(),
+  MONGO_INITDB_ROOT_PASSWORD: Joi.string(),
+  MONGO_INITDB_DATABASE: Joi.string(),
+  MONGO_SERVICE_PORT_MAP: Joi.string().pattern(SERVICE_PORT_MAP_REGEX),
+  MONGO_SERVICE_PORT_EXPOSE: Joi.number().greater(1023),
 });

src/config/env/schema.development.ts

@@ -1,5 +1,17 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 namespace NodeJS {
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  interface ProcessEnv {}
+  interface ProcessEnv {
+    MONGO_CONNECTION_SCHEME: string;
+    MONGO_HOST: string;
+    MONGO_INITDB_ROOT_USERNAME: string;
+    MONGO_INITDB_ROOT_PASSWORD: string;
+    MONGO_INITDB_DATABASE: string;
+
+    MONGO_SERVICE_NAME: string;
+    MONGO_RESTART_POLICY: string;
+    MONGO_SERVICE_PORT_MAP: string;
+    MONGO_SERVICE_PORT_EXPOSE: string;
+    MONGO_SERVICE_DIR_NAME: string;
+  }
 }

src/config/mongo/.keep

@@ -0,0 +1,39 @@
+import { Logger, Module, OnModuleInit } from "@nestjs/common";
+import { InjectConnection, MongooseModule } from "@nestjs/mongoose";
+import { Connection } from "mongoose";
+
+import {
+  MONGO_CONFIG_MODULE_CONTEXT,
+  MongoConfigService,
+} from "@/config/mongo/mongo.config.service";
+
+@Module({
+  imports: [
+    MongooseModule.forRootAsync({
+      imports: [MongoConfigModule],
+      inject: [MongoConfigService],
+      useFactory: async (config: MongoConfigService) => ({
+        uri: config.uriWithoutUserPass,
+        dbName: config.database,
+        user: config.username,
+        pass: config.password,
+        appName: config.database,
+        autoIndex: process.env.NODE_ENV === "development",
+        maxPoolSize: 100, // * This is the default
+      }),
+    }),
+  ],
+  providers: [MongoConfigService],
+  exports: [MongoConfigService],
+})
+export class MongoConfigModule implements OnModuleInit {
+  constructor(
+    @InjectConnection()
+    private readonly connection: Connection,
+  ) {}
+
+  async onModuleInit() {
+    await this.connection.db.stats();
+    Logger.log("Connected to Mongo", MONGO_CONFIG_MODULE_CONTEXT);
+  }
+}

src/config/mongo/environment.d.ts

@@ -0,0 +1,20 @@
+import { Injectable } from "@nestjs/common";
+
+export const MONGO_CONFIG_MODULE_CONTEXT = "Mongo";
+
+@Injectable()
+export class MongoConfigService {
+  public readonly scheme = process.env.MONGO_CONNECTION_SCHEME;
+
+  public readonly username = process.env.MONGO_INITDB_ROOT_USERNAME;
+  public readonly password = process.env.MONGO_INITDB_ROOT_PASSWORD;
+
+  public readonly host = process.env.MONGO_HOST;
+  public readonly port =
+    process.env.MONGO_SERVICE_PORT_EXPOSE ??
+    process.env.MONGO_SERVICE_PORT_MAP.split(":")[0];
+
+  public readonly database = process.env.MONGO_INITDB_DATABASE;
+
+  public readonly uriWithoutUserPass = `${this.scheme}://${this.host}:${this.port}/`;
+}

src/config/mongo/mongo.config.module.ts

@@ -2,9 +2,10 @@ import { Logger, Module, OnModuleInit } from "@nestjs/common";
 import { InjectDataSource, TypeOrmModule } from "@nestjs/typeorm";
 import { DataSource } from "typeorm";
 
-import { PostgresConfigService } from "./postgres.config.service";
+import { PostgresConfigService } from "@/config/postgres/postgres.config.service";
 
 export const POSTGRES_CONFIG_MODULE_CONTEXT = "Postgres";
+
 @Module({
   imports: [
     TypeOrmModule.forRootAsync({