shuttlepro-shared 1.1.68 → 1.1.70

package/config/index.js

@@ -2,10 +2,12 @@ const bullConfig = require("./bull");
 const redisConfig = require("./redis");
 const config = require("./config");
 const databaseConfig = require("./database");
+const socketConfig = require("./socket");
 
 module.exports = {
   bullConfig,
   redisConfig,
   config,
   databaseConfig,
+  socketConfig,
 };

package/config/redis.js

@@ -1,18 +1,40 @@
 const { createClient } = require("redis");
-const { redis } = require("./config");
+require("dotenv").config();
 
+const REDIS_URL = process.env.REDIS_URL || "redis://localhost:6379";
+
+// ✅ Create a single Redis client instance
 const client = createClient({
-  url: redis.url,
+  url: REDIS_URL,
+  socket: { reconnectStrategy: (retries) => Math.min(retries * 50, 1000) }, // Exponential backoff for reconnections
 });
-client.on("error", (err) => console.log("Redis Client Error", err));
 
+// ✅ Handle Redis Connection Events
+client.on("error", (err) => console.error("❌ Redis Error:", err));
+client.on("connect", () => console.log("✅ Redis Connected"));
+client.on("reconnecting", () => console.warn("⚠️ Redis Reconnecting..."));
+client.on("ready", () => console.log("🚀 Redis Ready to use"));
+client.on("end", () => console.log("❗ Redis Connection Closed"));
+
+// ✅ Ensure Redis is connected before performing operations
 const connectRedis = async () => {
   if (!client.isOpen) {
-    await client.connect();
+    try {
+      await client.connect();
+    } catch (err) {
+      console.error("❌ Failed to connect to Redis:", err);
+    }
   }
 };
 
-exports.setRedisData = async (
+/**
+ * ✅ Set Data in Redis (Supports String & Hash)
+ * @param {string} key - The Redis key
+ * @param {any} value - The value to store
+ * @param {string|null} field - Optional field for Hash storage
+ * @param {number} expiryInSeconds - Expiry time in seconds (default: 3600)
+ */
+const setRedisData = async (
   key,
   value,
   field = null,
@@ -20,59 +42,78 @@ exports.setRedisData = async (
 ) => {
   try {
     await connectRedis();
-    let resp;
+    let result;
     if (field) {
-      resp = await client.hSet(key, field, JSON.stringify(value));
+      result = await client.hSet(key, field, JSON.stringify(value));
     } else {
-      resp = await client.set(key, JSON.stringify(value));
+      result = await client.set(key, JSON.stringify(value), {
+        EX: expiryInSeconds,
+      });
     }
-    await client.expire(key, expiryInSeconds); // Set expiry for the key
-    return resp;
+    return result;
   } catch (err) {
-    console.error("Error setting Redis data:", err);
+    console.error("❌ Error setting Redis data:", err);
     throw err;
   }
 };
 
-exports.getRedisData = async (key, field = null) => {
+/**
+ * ✅ Get Data from Redis (Supports String & Hash)
+ * @param {string} key - The Redis key
+ * @param {string|null} field - Optional field for Hash retrieval
+ */
+const getRedisData = async (key, field = null) => {
   try {
     await connectRedis();
-    let resp;
-    if (field) {
-      resp = await client.hGet(key, field);
-    } else {
-      resp = await client.get(key);
-    }
-    return resp ? JSON.parse(resp) : null;
+    let result = field ? await client.hGet(key, field) : await client.get(key);
+    return result ? JSON.parse(result) : null;
   } catch (err) {
-    console.error("Error getting Redis data:", err);
+    console.error("❌ Error getting Redis data:", err);
     throw err;
   }
 };
 
-exports.deleteRedisData = async (key) => {
+/**
+ * ✅ Delete Data from Redis (Supports String & Hash)
+ * @param {string} key - The Redis key
+ * @param {string|null} field - Optional field for Hash deletion
+ */
+const deleteRedisData = async (key, field = null) => {
   try {
     await connectRedis();
-    return await client.del(key);
+    return field ? await client.hDel(key, field) : await client.del(key);
   } catch (err) {
-    console.error("Error deleting Redis data:", err);
+    console.error("❌ Error deleting Redis data:", err);
     throw err;
   }
 };
 
-// Ensure the Redis client is closed when the application exits
-const closeClient = () => {
+/**
+ * ✅ Graceful Shutdown Handling
+ */
+const closeClient = async () => {
   if (client.isOpen) {
-    client.quit();
+    await client.quit();
+    console.log("❗ Redis Disconnected Gracefully");
   }
 };
 
+// ✅ Ensure Redis disconnects properly on process exit
 process.on("exit", closeClient);
-process.on("SIGINT", () => {
-  closeClient();
+process.on("SIGINT", async () => {
+  await closeClient();
   process.exit();
 });
-process.on("SIGTERM", () => {
-  closeClient();
+process.on("SIGTERM", async () => {
+  await closeClient();
   process.exit();
 });
+
+// ✅ Export Functions
+module.exports = {
+  client, // Export Redis client for reuse
+  setRedisData,
+  getRedisData,
+  deleteRedisData,
+  connectRedis,
+};

package/config/socket.js

@@ -0,0 +1,116 @@
+const { Server } = require("socket.io");
+const { client: redisClient, connectRedis } = require("./redis");
+const { createClient } = require("redis");
+require("dotenv").config();
+
+let io;
+
+/**
+ * ✅ Initialize WebSocket Server with Redis Pub/Sub
+ * @param {Object} server - HTTP Server instance
+ * @param {string|null} namespace - Optional namespace (passed from `index.js`)
+ * @param {string} [redisChannel="socket_events"] - Custom Redis Pub/Sub Channel
+ */
+const initializeSocket = async (
+  server,
+  namespace = null,
+  redisChannel = "socket_events"
+) => {
+  await connectRedis(); // Ensure Redis is connected
+
+  io = new Server(server, {
+    cors: { origin: "*" },
+  });
+
+  console.log(
+    `✅ WebSocket Server Initialized ${
+      namespace ? `with namespace: ${namespace}` : "globally"
+    }, using Redis channel: ${redisChannel}`
+  );
+
+  // Create Redis Pub/Sub Clients
+  const pubClient = redisClient;
+  const subClient = createClient({ url: process.env.REDIS_URL });
+  await subClient.connect();
+
+  // ✅ Subscribe to the dynamic Redis channel
+  await subClient.subscribe(redisChannel, (message) => {
+    const { workspaceId, event, data } = JSON.parse(message);
+
+    if (namespace) {
+      io.of(namespace).to(workspaceId).emit(event, data);
+    } else {
+      io.to(workspaceId).emit(event, data);
+    }
+  });
+
+  // ✅ Handle WebSocket Connection (Global or Namespace)
+  const socketServer = namespace ? io.of(namespace) : io;
+  socketServer.on("connection", (socket) =>
+    handleConnection(socket, namespace)
+  );
+};
+
+/**
+ * ✅ Handle WebSocket Connection
+ * @param {Object} socket - WebSocket client socket
+ * @param {string} [namespace] - Optional namespace
+ */
+const handleConnection = async (socket, namespace = null) => {
+  const { workspaceId } = socket.handshake.query;
+
+  if (!workspaceId) {
+    console.warn(`❌ Client ${socket.id} rejected due to missing workspaceId`);
+    socket.disconnect(true);
+    return;
+  }
+
+  console.log(
+    `✅ Client connected: ${socket.id} (Workspace: ${workspaceId}) Namespace: ${
+      namespace || "Global"
+    }`
+  );
+
+  await redisClient.hSet(
+    `${workspaceId}:sockets`,
+    socket.id,
+    JSON.stringify({
+      id: socket.id,
+      workspaceId,
+      namespace,
+      connectedAt: new Date().toISOString(),
+    })
+  );
+
+  // ✅ Handle Disconnection
+  socket.on("disconnect", async () => {
+    console.log(
+      `❌ Client disconnected: ${socket.id} (Workspace: ${workspaceId})`
+    );
+    await redisClient.hDel(`${workspaceId}:sockets`, socket.id);
+  });
+};
+
+/**
+ * ✅ Publish WebSocket Events via Redis
+ * @param {string} workspaceId - Target workspace ID
+ * @param {string} event - Event name
+ * @param {Object} data - Event payload
+ * @param {string} [redisChannel="socket_events"] - Custom Redis Pub/Sub Channel
+ */
+const sendEventToServer = async ({
+  workspaceId,
+  event,
+  data,
+  redisChannel = "socket_events",
+}) => {
+  await redisClient.publish(
+    redisChannel,
+    JSON.stringify({ workspaceId, event, data })
+  );
+};
+
+module.exports = {
+  initializeSocket,
+  sendEventToServer,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shuttlepro-shared",
-  "version": "1.1.68",
+  "version": "1.1.70",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -22,6 +22,7 @@
     "mongoose": "^8.7.1",
     "cors": "^2.8.5",
     "helmet": "^8.0.0",
-    "bull": "^4.10.4"
+    "bull": "^4.10.4",
+    "socket.io": "^4.8.1"
   }
 }