Database per service pattern (#85)

* Remove use of username and password

The username and password will be embedded within the URI

* Remove use of DB

The database will be specified in the URI

* Standardise env files

* Edit .env.sample

* Fix typo

Co-authored-by: McNaBry <[email protected]>

---------

Co-authored-by: McNaBry <[email protected]>

Author: samuelim01

.env.sample

@@ -1,28 +1,23 @@
+# This is a sample environment configuration file.
+# Copy this file to .env and replace the placeholder values with your own.
+
 # Question Service
 QUESTION_DB_CLOUD_URI=<FILL-THIS-IN>
 QUESTION_DB_LOCAL_URI=mongodb://question-db:27017/question
-QUESTION_DB_USERNAME=user
-QUESTION_DB_PASSWORD=password
 
 # User Service
 USER_DB_CLOUD_URI=<FILL-THIS-IN>
 USER_DB_LOCAL_URI=mongodb://user-db:27017/user
-USER_DB_USERNAME=user
-USER_DB_PASSWORD=password
 
 # Match Service
 MATCH_DB_CLOUD_URI=<FILL-THIS-IN>
 MATCH_DB_LOCAL_URI=mongodb://match-db:27017/match
-MATCH_DB_USERNAME=user
-MATCH_DB_PASSWORD=password
-
-# Room Service
-COLLAB_DB_CLOUD_URI=mongodb+srv://<username>:<password>@cluster0.h5ukw.mongodb.net/collaboration-service?retryWrites=true&w=majority&appName=Cluster0
-COLLAB_DB_LOCAL_URI=mongodb://collaboration-db:27017/collaboration-service
 
-# Collaboration Service (Yjs Documents)
-YJS_DB_CLOUD_URI=mongodb+srv://<username>:<password>@cluster0.h5ukw.mongodb.net/yjs-documents?retryWrites=true&w=majority&appName=Cluster0
-YJS_DB_LOCAL_URI=mongodb://collaboration-db:27017/yjs-documents
+# Collaboration Service
+COLLAB_DB_CLOUD_URI=<FILL-THIS-IN>
+COLLAB_DB_LOCAL_URI=mongodb://collaboration-db:27017/collaboration
+YJS_DB_CLOUD_URI=<FILL-THIS-IN>
+YJS_DB_LOCAL_URI=mongodb://collaboration-db:27017/room
 
 # History Service
 HISTORY_DB_CLOUD_URI=<FILL-THIS-IN>

compose.yml

@@ -50,8 +50,6 @@ services:
     environment:
       DB_CLOUD_URI: ${QUESTION_DB_CLOUD_URI}
       DB_LOCAL_URI: ${QUESTION_DB_LOCAL_URI}
-      DB_USERNAME: ${QUESTION_DB_USERNAME}
-      DB_PASSWORD: ${QUESTION_DB_PASSWORD}
       BROKER_URL: ${BROKER_URL}
       JWT_SECRET: ${JWT_SECRET}
     depends_on:
@@ -65,12 +63,8 @@ services:
   question-db:
     container_name: question-db
     image: mongo:7.0.14
-    environment:
-      MONGO_INITDB_ROOT_USERNAME: ${QUESTION_DB_USERNAME}
-      MONGO_INITDB_ROOT_PASSWORD: ${QUESTION_DB_PASSWORD}
     volumes:
       - question-db:/data/db
-      - ./services/question/init-mongo/init-mongo.js:/docker-entrypoint-initdb.d/init-mongo.js
     networks:
       - question-db-network
     command: --quiet
@@ -85,8 +79,6 @@ services:
     environment:
       DB_CLOUD_URI: ${USER_DB_CLOUD_URI}
       DB_LOCAL_URI: ${USER_DB_LOCAL_URI}
-      DB_USERNAME: ${USER_DB_USERNAME}
-      DB_PASSWORD: ${USER_DB_PASSWORD}
       JWT_SECRET: ${JWT_SECRET}
     networks:
       - gateway-network
@@ -96,9 +88,6 @@ services:
   user-db:
     container_name: user-db
     image: mongo:7.0.14
-    environment:
-      MONGO_INITDB_ROOT_USERNAME: ${USER_DB_USERNAME}
-      MONGO_INITDB_ROOT_PASSWORD: ${USER_DB_PASSWORD}
     volumes:
       - user-db:/data/db
     networks:
@@ -115,8 +104,6 @@ services:
     environment:
       DB_CLOUD_URI: ${MATCH_DB_CLOUD_URI}
       DB_LOCAL_URI: ${MATCH_DB_LOCAL_URI}
-      DB_USERNAME: ${MATCH_DB_USERNAME}
-      DB_PASSWORD: ${MATCH_DB_PASSWORD}
       JWT_SECRET: ${JWT_SECRET}
       BROKER_URL: ${BROKER_URL}
     depends_on:
@@ -130,9 +117,6 @@ services:
   match-db:
     container_name: match-db
     image: mongo:7.0.14
-    environment:
-      MONGO_INITDB_ROOT_USERNAME: ${MATCH_DB_USERNAME}
-      MONGO_INITDB_ROOT_PASSWORD: ${MATCH_DB_PASSWORD}
     volumes:
       - match-db:/data/db
     networks:

services/collaboration/.env.sample

@@ -1,22 +1,11 @@
-# MongoDB Cloud URI for the room service. Replace the placeholders with your MongoDB username, password, and cluster details.
-COLLAB_DB_CLOUD_URI=mongodb+srv://<username>:<password>@cluster0.h5ukw.mongodb.net/collaboration-service?retryWrites=true&w=majority&appName=Cluster0
-COLLAB_DB_LOCAL_URI=mongodb://collaboration-db:27017/collaboration-service
-
-# MongoDB Cloud URI for Yjs documents. Replace the placeholders with your MongoDB username, password, and cluster details.
-YJS_DB_CLOUD_URI=mongodb+srv://<username>:<password>@cluster0.h5ukw.mongodb.net/yjs-documents?retryWrites=true&w=majority&appName=Cluster0
-YJS_DB_LOCAL_URI=mongodb://collaboration-db:27017/yjs-documents
-
-# Broker Service
+# This is a sample environment configuration file.
+# Copy this file to .env and replace the placeholder values with your own.
+COLLAB_DB_CLOUD_URI=<FILL-THIS-IN>
+COLLAB_DB_LOCAL_URI=mongodb://collaboration-db:27017/collaboration
+YJS_DB_CLOUD_URI=<FILL-THIS-IN>
+YJS_DB_LOCAL_URI=mongodb://collaboration-db:27017/room
 BROKER_URL=amqp://broker:5672
-
-# CORS origin configuration
 CORS_ORIGIN=*
-
-# Port
 PORT=8084
-
-# Secret for creating JWT signature
 JWT_SECRET=you-can-replace-this-with-your-own-secret
-
-# Node environment
-ENV=development
+NODE_ENV=development

services/collaboration/README.md

@@ -65,8 +65,6 @@ Here are the key environment variables used in the `.env` file:
 | `COLLAB_LOCAL_MONGO_URI` | URI for connecting to the local MongoDB database for the collaboration service (room) |
 | `YJS_CLOUD_MONGO_URI`    | URI for connecting to the MongoDB Atlas database for Yjs document persistence         |
 | `YJS_LOCAL_MONGO_URI`    | URI for connecting to the local MongoDB database for Yjs document persistence         |
-| `DB_USERNAME`            | Username for the MongoDB databases (for both cloud and local environments)            |
-| `DB_PASSWORD`            | Password for the MongoDB databases (for both cloud and local environments)            |
 | `CORS_ORIGIN`            | Allowed origins for CORS (default: * to allow all origins)                            |
 | `PORT`                   | Port for the Room and Collaboration Service (default: 8084)                           |
 | `ENV`                    | Environment setting (`development` or `production`)                                   |

services/collaboration/src/services/mongodbService.ts

@@ -18,7 +18,7 @@ const connectToRoomDB = async (): Promise<Db> => {
         if (!roomDb) {
             const client = new MongoClient(config.COLLAB_DB_URI);
             await client.connect();
-            roomDb = client.db('collaboration-service');
+            roomDb = client.db();
             console.log('Connected to the collaboration-service (room) database');
         }
         return roomDb;
@@ -41,7 +41,7 @@ const connectToYJSDB = async (): Promise<Db> => {
 
             const client = new MongoClient(config.YJS_DB_URI);
             await client.connect();
-            yjsDb = client.db('yjs-documents');
+            yjsDb = client.db();
             console.log('Connected to the YJS database');
         }
         return yjsDb;

services/history/.env.sample

@@ -2,8 +2,8 @@
 # Copy this file to .env and replace the placeholder values with your own.
 DB_CLOUD_URI=<FILL-THIS-IN>
 DB_LOCAL_URI=mongodb://history-db:27017/history
-JWT_SECRET=you-can-replace-this-with-your-own-secret
 BROKER_URL=amqp://broker:5672
 CORS_ORIGIN=*
 PORT=8086
+JWT_SECRET=you-can-replace-this-with-your-own-secret
 NODE_ENV=development

services/match/.env.sample

@@ -2,9 +2,8 @@
 # Copy this file to .env and replace the placeholder values with your own.
 DB_CLOUD_URI=<FILL-THIS-IN>
 DB_LOCAL_URI=mongodb://match-db:27017/match
-DB_USERNAME=user
-DB_PASSWORD=password
 BROKER_URL=amqp://broker:5672
-JWT_SECRET=you-can-replace-this-with-your-own-secret
+CORS_ORIGIN=*
 PORT=8083
+JWT_SECRET=you-can-replace-this-with-your-own-secret
 NODE_ENV=development

services/match/src/config.ts

@@ -2,8 +2,6 @@ import { z } from 'zod';
 
 const envSchema = z
     .object({
-        DB_USERNAME: z.string().trim().min(1),
-        DB_PASSWORD: z.string().trim().min(1),
         DB_CLOUD_URI: z.string().trim().optional(),
         DB_LOCAL_URI: z.string().trim().optional(),
         BROKER_URL: z.string().url(),

services/match/src/models/repository.ts

@@ -5,11 +5,7 @@ import config from '../config';
 import { IdType } from '../types/request';
 
 export async function connectToDB() {
-    await mongoose.connect(config.DB_URI, {
-        authSource: 'admin',
-        user: config.DB_USERNAME,
-        pass: config.DB_PASSWORD,
-    });
+    await mongoose.connect(config.DB_URI);
 }
 
 export async function createMatchRequest(userId: IdType, username: string, topics: string[], difficulty: Difficulty) {

services/question/.env.sample

@@ -2,10 +2,8 @@
 # Copy this file to .env and replace the placeholder values with your own.
 DB_CLOUD_URI=<FILL-THIS-IN>
 DB_LOCAL_URI=mongodb://question-db:27017/question
-DB_USERNAME=user
-DB_PASSWORD=password
 BROKER_URL=amqp://broker:5672
-JWT_SECRET=you-can-replace-this-with-your-own-secret
 CORS_ORIGIN=*
 PORT=8081
+JWT_SECRET=you-can-replace-this-with-your-own-secret
 NODE_ENV=development