ft(socket):Add socket to handle realtime notification

package.json

@@ -52,6 +52,7 @@
     "pg": "^8.9.0",
     "pg-hstore": "^2.3.4",
     "sequelize": "^6.29.0",
+    "socket.io": "^4.7.5",
     "source-map": "^0.7.4",
     "swagger-ui-express": "^4.6.1"
   },

src/app.js

@@ -1,5 +1,6 @@
 /* eslint-disable no-undef */
 import express from "express";
+import * as http from "http";
 import session from "express-session";
 import dotenv from "dotenv";
 import cors from "cors";
@@ -12,12 +13,16 @@ import {
   listenToUserProjectAssigned,
   listenToLeadProjectAssigned,
 } from "./system/utils/listenToEvent";
+import { SocketUtil } from "./system/utils/SocketUtil";
 import cronJob from "./system/utils/cronjob";
+
 dotenv.config();
 
 const PORT = process.env.PORT || 4000;
 
 const app = express();
+const server = http.createServer(app);
+SocketUtil.config(server);
 cronJob();
 app.use(express.urlencoded({ extended: false }));
 app.use(cors());
@@ -51,7 +56,7 @@ const initializeDatabase = async () => {
 const start = () => {
   try {
     initializeDatabase();
-    app.listen({ port: PORT }, () =>
+    server.listen({ port: PORT }, () =>
       process.stdout.write(`http://localhost:${PORT} \n`)
     );
   } catch (error) {

src/documentation/notification/index.js

@@ -3,7 +3,7 @@ import responses from "../responses";
 const notification = {
   "/notification": {
     get: {
-      tags: ["Notification"],
+      tags: ["Notifications"],
       security: [{ JWT: [] }],
       summary: "get notifications",
       parameters: [
@@ -29,6 +29,28 @@ const notification = {
       responses,
     },
   },
+
+  "/notification/{notificationId}": {
+    patch: {
+      tags: ["Notifications"],
+      security: [{ JWT: [] }],
+      summary: "Update User notifications",
+      parameters: [
+        {
+          name: "notificationId",
+          in: "path",
+          description: "Id of the notification to be updated",
+          required: true,
+          schema: {
+            type: "string",
+            format: "uuid",
+          },
+        },
+      ],
+      consumes: ["application/json"],
+      responses,
+    },
+  },
 };
 
 export default notification;

src/restful/controllers/NotificationController.js

@@ -1,4 +1,7 @@
 import NotificationService from "../../services/notificationService";
+import { knownEvents, subscribe } from "../../system/utils/event.util";
+
+// subscribe(knownEvents.)
 
 export default class NotificationController {
   static async getNotifications(req, res) {
@@ -19,4 +22,22 @@ export default class NotificationController {
       });
     }
   }
+
+  static async markOneNotification(req, res) {
+    try {
+      await NotificationService.updateNotifications(
+        { read: true },
+        { id: req.params.notificationId, userId: req.user.id }
+      );
+
+      return res
+        .status(200)
+        .json({ message: "Marked one notification as read" });
+    } catch (err) {
+      return res.status(500).json({
+        error: err.message,
+        message: "Failed to update the notification",
+      });
+    }
+  }
 }

src/restful/middlewares/notificationMiddleware.js

@@ -1,7 +1,23 @@
+import NotificationService from "../../services/notificationService";
+
 export const receivedPaginationFormat = async (req, res, next) => {
   req.query = {
     limit: req.query["limit"] || "10",
     page: req.query["page"] || "1",
   };
   next();
 };
+
+export const checkIfHasNotificationId = async (req, res, next) => {
+  const notification = await NotificationService.getNotifications(
+    {
+      id: req.params.notificationId,
+    },
+    null,
+    null
+  );
+  if (notification.rows.length === 0) {
+    return res.status(404).json({ message: "Notification not found" });
+  }
+  next();
+};

src/restful/routes/notificationRoutes.js

@@ -3,7 +3,10 @@ import NotificationController from "../controllers/NotificationController";
 
 import protect from "../middlewares";
 import { validatePagination } from "../../validations/notification.validation";
-import { receivedPaginationFormat } from "../middlewares/notificationMiddleware";
+import {
+  checkIfHasNotificationId,
+  receivedPaginationFormat,
+} from "../middlewares/notificationMiddleware";
 
 const notificationRouter = express.Router();
 
@@ -15,4 +18,10 @@ notificationRouter.get(
   NotificationController.getNotifications
 );
 
+notificationRouter.patch(
+  "/:notificationId",
+  protect,
+  checkIfHasNotificationId,
+  NotificationController.markOneNotification
+);
 export default notificationRouter;

src/services/notificationService.js

@@ -20,6 +20,10 @@ export default class NotificationService {
     }
   }
 
+  static async updateNotifications(field, query) {
+    return await Notification.update(field, { where: query });
+  }
+
   static async getNotifications(query, limit, page) {
     const offset = (page - 1) * limit;
 

src/system/utils/SocketUtil.js

@@ -0,0 +1,23 @@
+import { Server } from "socket.io";
+
+export class SocketUtil {
+  static io;
+  static socketEmit(key, data) {
+    SocketUtil.io.sockets.emit(key, data);
+  }
+
+  static config(server) {
+    SocketUtil.io = new Server(server, { cors: { origin: "*" } });
+
+    SocketUtil.io.on("connection", (socket) => {
+      console.log("Connected", socket.id);
+      socket.on("join_room", (data) => {
+        socket.join(data);
+      });
+    });
+  }
+}
+
+export const knownSockets = {
+  notification: "notification",
+};