Merge branch 'development' into feat/users

Author: nicolelim02

README.md

@@ -28,4 +28,5 @@ docker-compose down
 
 - User Service: http://localhost:3001
 - Question Service: http://localhost:3000
+- Matching Service: http://localhost:3002
 - Frontend: http://localhost:5173

backend/README.md

@@ -6,6 +6,8 @@
 
 2. Set-up Firebase.
 
+3. Follow the instructions [here](https://nodejs.org/en/download/package-manager) to set up Node v20.
+
 ## Setting-up local MongoDB (only if you are using Docker)
 
 1. In the `backend` directory, create a copy of the `.env.sample` file and name it `.env`.

backend/matching-service/README.md

@@ -1,25 +1,24 @@
-# Matching Service
+# Matching Service Guide
+
+> Please ensure that you have completed the backend set-up [here](../README.md) before proceeding.
 
 ## Setting-up Matching Service
 
 1. In the `matching-service` directory, create a copy of the `.env.sample` file and name it `.env`. If you are looking to run matching service with the other services using docker-compose, comment out the variable `RABBITMQ_ADDR` under use case (1) in the .env file. Otherwise, if you are looking to run matching service individually, comment out the variables `RABBITMQ_DEFAULT_USER`, `RABBITMQ_DEFAULT_PASS` and `RABBITMQ_ADDR` under use case (2) in the .env file.
 
-2. If you are running matching service together with other services using docker-compose, to set up credentials for RabbitMq, update the RabbitMq variables in the `.env` file. Update `RABBITMQ_DEFAULT_USER` and `RABBITMQ_DEFAULT_PASS` to what you want, then update `RABBITMQ_ADDR` to be `amqp://<RABBITMQ_DEFAULT_USER>:<RABBITMQ_DEFAULT_PASS>@rabbitmq:5672`.
-You can access RabbitMq management user interface locally with the username in `RABBITMQ_DEFAULT_USER` and password in `RABBITMQ_DEFAULT_PASS` at http://localhost:15672.
+2. If you are running matching service together with other services using docker-compose, to set up credentials for RabbitMq, update the RabbitMq variables in the `.env` file. Update `RABBITMQ_DEFAULT_USER` and `RABBITMQ_DEFAULT_PASS` to what you want, then update `RABBITMQ_ADDR` to be `amqp://<RABBITMQ_DEFAULT_USER>:<RABBITMQ_DEFAULT_PASS>@rabbitmq:5672`. You can access RabbitMq management user interface locally with the username in `RABBITMQ_DEFAULT_USER` and password in `RABBITMQ_DEFAULT_PASS` at http://localhost:15672.
 
 3. If you are running matching service individually, you do not need to make any changes to `RABBITMQ_ADDR`. You can access RabbitMq management user interface locally with the username `guest` and password `guest` at http://localhost:15672.
 
 ## Running Matching Service Individually with Docker
 
 1. Set up and run RabbitMq locally on your computer with the command `docker run -it --rm --name rabbitmq -p 5672:5672 -p 15672:15672 rabbitmq:4.0-management`.
 
-2. Follow the instructions [here](https://nodejs.org/en/download/package-manager) to set up Node v20.
-
-3. Open Command Line/Terminal and navigate into the `matching-service` directory.
+2. Open Command Line/Terminal and navigate into the `matching-service` directory.
 
-4. Run the command: `npm install`. This will install all the necessary dependencies.
+3. Run the command: `npm install`. This will install all the necessary dependencies.
 
-5. Run the command `npm start` to start the Matching Service in production mode, or use `npm run dev` for development mode, which includes features like automatic server restart when you make code changes.
+4. Run the command `npm start` to start the Matching Service in production mode, or use `npm run dev` for development mode, which includes features like automatic server restart when you make code changes. If you encounter connection errors, please wait for a few minutes before running `npm start` again as RabbitMq may take some time to start up.
 
 ## After running
 

backend/matching-service/app.ts

@@ -9,7 +9,7 @@ import matchingRoutes from "./src/routes/matchingRoutes.ts";
 
 dotenv.config();
 
-const allowedOrigins = process.env.ORIGINS
+export const allowedOrigins = process.env.ORIGINS
   ? process.env.ORIGINS.split(",")
   : ["http://localhost:5173", "http://127.0.0.1:5173"];
 

backend/matching-service/config/rabbitmq.ts

@@ -1,6 +1,7 @@
 import amqplib, { Connection } from "amqplib";
 import dotenv from "dotenv";
-import { matchUsers } from "../utils/mq_utils";
+import { matchUsers } from "../src/utils/mq_utils";
+import { MatchRequestItem } from "../src/handlers/matchHandler";
 
 dotenv.config();
 
@@ -13,13 +14,9 @@ export const connectRabbitMq = async () => {
     const consumerChannel = await mrConnection.createChannel();
     await consumerChannel.assertQueue(queue);
 
-    consumerChannel.consume(queue, async (msg) => {
+    consumerChannel.consume(queue, (msg) => {
       if (msg !== null) {
-        try {
-          await matchUsers(msg.content.toString());
-        } catch (error) {
-          console.error(error);
-        }
+        matchUsers(msg.content.toString());
         consumerChannel.ack(msg);
       }
     });
@@ -29,20 +26,15 @@ export const connectRabbitMq = async () => {
   }
 };
 
-type MatchRequestMessage = {
-  userId: string;
-  categories: string[] | string;
-  complexities: string[] | string;
-  sentTimestamp: number;
-  ttlInSecs: number;
-};
-
-export const sendRabbitMq = async (data: MatchRequestMessage) => {
+export const sendRabbitMq = async (
+  data: MatchRequestItem
+): Promise<boolean> => {
   try {
     const senderChannel = await mrConnection.createChannel();
     senderChannel.sendToQueue(queue, Buffer.from(JSON.stringify(data)));
+    return true;
   } catch (error) {
     console.log(error);
-    throw new Error("Failed to send match request");
+    return false;
   }
 };