Merge pull request #238 from abdeljalil-salhi/237-add-shared-and-priority-queues

Add shared and priority queues logic

Author: abdeljalil-salhi

backend-nestjs/package-lock.json

@@ -46,7 +46,8 @@
     "qrcode": "^1.5.3",
     "reflect-metadata": "^0.2.1",
     "rxjs": "^7.8.1",
-    "socket-io": "^1.0.0"
+    "socket-io": "^1.0.0",
+    "uuid": "^9.0.1"
   },
   "devDependencies": {
     "@nestjs/cli": "^10.0.0",
@@ -59,6 +60,7 @@
     "@types/nodemailer": "^6.4.15",
     "@types/passport-jwt": "^4.0.1",
     "@types/supertest": "^6.0.2",
+    "@types/uuid": "^9.0.8",
     "@typescript-eslint/eslint-plugin": "^7.2.0",
     "@typescript-eslint/parser": "^7.2.0",
     "eslint": "^8.42.0",

backend-nestjs/package.json

@@ -0,0 +1,12 @@
+// Dependencies
+import { Socket } from 'socket.io';
+
+/**
+ * Type of the SocketIO middleware function.
+ *
+ * @export
+ * @type {SocketIOMiddleware}
+ */
+export type SocketIOMiddleware = {
+  (client: Socket, next: (err?: Error) => void): void;
+};

backend-nestjs/src/auth/middlewares/socket-io.middleware.ts

@@ -3,16 +3,8 @@ import { Socket } from 'socket.io';
 
 // Guards
 import { WebsocketGuard } from '../guards/websocket.guard';
-
-/**
- * Type of the SocketIO middleware function.
- *
- * @export
- * @type {SocketIOMiddleware}
- */
-export type SocketIOMiddleware = {
-  (client: Socket, next: (err?: Error) => void): void;
-};
+// Middlewares
+import { SocketIOMiddleware } from './socket-io.middleware';
 
 /**
  * Middleware to protect websockets by checking the validity of the access token.

backend-nestjs/src/auth/middlewares/websocket.middleware.ts

@@ -0,0 +1,17 @@
+// Dependencies
+import { Socket } from 'socket.io';
+
+/**
+ * Interface of the queue member.
+ *
+ * @export
+ * @interface QueueMember
+ * @property {string} instanceId - The instance ID.
+ * @property {Socket} client - The socket client.
+ * @property {string} userId - The user ID.
+ */
+export interface QueueMember {
+  instanceId: string;
+  client: Socket;
+  userId: string;
+}

backend-nestjs/src/socket/interfaces/client-user.interface.ts

@@ -0,0 +1,12 @@
+/**
+ * Interface for the socket user client.
+ *
+ * @export
+ * @interface SocketUserClient
+ * @property {string} userId - The user ID
+ * @property {string[]} socketIds - The user's socket IDs
+ */
+export interface SocketUserClient {
+  userId: string;
+  socketIds: string[];
+}

backend-nestjs/src/socket/interfaces/socket-user-client.interface.ts

@@ -0,0 +1,91 @@
+/**
+ * Queue data structure
+ *
+ * @export
+ * @class Queue
+ * @template T
+ * @description
+ * A queue is a data structure that follows the FIFO (First In First Out) principle.
+ * This means that the first element added to the queue will be the first one to be removed.
+ *
+ * @example
+ * const queue = new Queue<number>();
+ * queue.enqueue(1);
+ * queue.enqueue(2);
+ * queue.enqueue(3);
+ *
+ * console.log(queue.dequeue()); // 1
+ * console.log(queue.dequeue()); // 2
+ * console.log(queue.dequeue()); // 3
+ */
+export class Queue<T> {
+  /**
+   * The items in the queue
+   * @type {Array<T>}
+   */
+  private items: Array<T> = new Array<T>();
+
+  /**
+   * Creates an instance of the Queue class.
+   *
+   * @param {Array<T>} [content=[]] - The items to add to the queue
+   */
+  constructor(content: Array<T> = new Array<T>()) {
+    this.items = content;
+  }
+
+  /**
+   * Adds an item to the queue
+   *
+   * @param {T} item - The item to add
+   * @returns {void}
+   */
+  public enqueue(item: T): void {
+    this.items.push(item);
+  }
+
+  /**
+   * Removes an item from the queue
+   *
+   * @returns {T | undefined} - The item removed from the queue
+   */
+  public dequeue(): T | undefined {
+    return this.items.shift();
+  }
+
+  /**
+   * Returns the size of the queue
+   *
+   * @returns {number} - The size of the queue
+   */
+  public size(): number {
+    return this.items.length;
+  }
+
+  /**
+   * Checks if the queue is empty
+   *
+   * @returns {boolean} - True if the queue is empty, false otherwise
+   */
+  public isEmpty(): boolean {
+    return this.items.length === 0;
+  }
+
+  /**
+   * Returns the first item in the queue
+   *
+   * @returns {T | undefined} - The first item in the queue
+   */
+  public peek(): T | undefined {
+    return this.items[0];
+  }
+
+  /**
+   * Returns the items in the queue
+   *
+   * @returns {T[]} - The items in the queue
+   */
+  public getItems(): T[] {
+    return this.items;
+  }
+}