Implement private user rooms (#4)

Co-authored-by: bastien ollier <bastien.ollier@etu.uca.fr>
Reviewed-on: #4
Reviewed-by: Clément FRÉVILLE <clement.freville2@etu.uca.fr>
Co-authored-by: Bastien OLLIER <bastien.ollier@noreply.codefirst.iut.uca.fr>
Co-committed-by: Bastien OLLIER <bastien.ollier@noreply.codefirst.iut.uca.fr>

package.json

@@ -18,6 +18,7 @@
     "@fastify/type-provider-typebox": "^4.0.0",
     "@fastify/websocket": "^10.0.1",
     "@sinclair/typebox": "^0.32.9",
+    "dprint": "^0.46.1",
     "fastify": "^4.27.0",
     "nanoid": "^5.0.4",
     "sqlite3": "^5.1.7",

src/database.ts

@@ -10,7 +10,7 @@ const dbFilePath = `${dbDirectory}/database.db`;
 export function runDB(
   db: sqlite3.Database,
   query: string,
-  params: any[]
+  params: any[],
 ): Promise<void> {
   return new Promise((resolve, reject) => {
     db.run(query, params, (err) => {
@@ -26,7 +26,7 @@ export function runDB(
 /* Fonction pour récupérer plusieurs lignes de la base de données */
 export function allDB<T>(
   db: sqlite3.Database,
-  query: string
+  query: string,
 ): Promise<unknown[]> {
   return new Promise((resolve, reject) => {
     db.all(query, (err, rows) => {
@@ -43,7 +43,7 @@ export function allDB<T>(
 export function getDB<T>(
   db: sqlite3.Database,
   query: string,
-  params: any[]
+  params: any[],
 ): Promise<T[]> {
   return new Promise((resolve, reject) => {
     db.get(query, params, (err, row: any) => {
@@ -73,7 +73,7 @@ export function openDatabase() {
     sqlite3.OPEN_READWRITE | sqlite3.OPEN_CREATE,
     (err: Error | null) => {
       if (err) console.error(err.message);
-    }
+    },
   );
 }
 
@@ -105,7 +105,8 @@ export function createTables(db: sqlite3.Database) {
 
 /* Créer la table registered_user dans la base de données */
 export function createRegisteredUserTable(db: sqlite3.Database): Promise<void> {
-  const tableRegisteredUser = `CREATE TABLE IF NOT EXISTS registered_user (id_user INTEGER PRIMARY KEY AUTOINCREMENT, login TEXT NOT NULL, password TEXT NOT NULL, permissions INTEGER NOT NULL, UNIQUE (login))`;
+  const tableRegisteredUser =
+    `CREATE TABLE IF NOT EXISTS registered_user (id_user INTEGER PRIMARY KEY AUTOINCREMENT, login TEXT NOT NULL, password TEXT NOT NULL, permissions INTEGER NOT NULL, UNIQUE (login))`;
 
   return runDB(db, tableRegisteredUser, []);
 }
@@ -115,7 +116,7 @@ export function insertUser(
   db: sqlite3.Database,
   login: string,
   password: string,
-  permissions: number
+  permissions: number,
 ) {
   const insertUserQuery = `INSERT INTO registered_user (login, password, permissions) VALUES (?, ?, ?)`;
 
@@ -126,7 +127,7 @@ export function insertUser(
 export function updateUserLogin(
   db: sqlite3.Database,
   id: number,
-  newLogin: string
+  newLogin: string,
 ) {
   const updateUserLoginQuery = `UPDATE registered_user SET login = ? WHERE id_user = ?`;
 
@@ -137,7 +138,7 @@ export function updateUserLogin(
 export function updateUserPassword(
   db: sqlite3.Database,
   id: number,
-  newPassword: string
+  newPassword: string,
 ) {
   const updateUserPasswordQuery = `UPDATE registered_user SET password = ? WHERE id_user = ?`;
 
@@ -148,7 +149,7 @@ export function updateUserPassword(
 export function updateUserPermissions(
   db: sqlite3.Database,
   id: number,
-  newPermissions: number
+  newPermissions: number,
 ) {
   const updateUserPermissionsQuery = `UPDATE registered_user SET permissions = ? WHERE id_user = ?`;
 
@@ -206,7 +207,8 @@ export function selectUserById(db: sqlite3.Database, id: number) {
 
 /* Créer la table language dans la base de données */
 export function createLanguageTable(db: sqlite3.Database): Promise<void> {
-  const tableLanguage = `CREATE TABLE IF NOT EXISTS language (id_language INTEGER PRIMARY KEY AUTOINCREMENT, designation TEXT NOT NULL, version INTEGER NOT NULL)`;
+  const tableLanguage =
+    `CREATE TABLE IF NOT EXISTS language (id_language INTEGER PRIMARY KEY AUTOINCREMENT, designation TEXT NOT NULL, version INTEGER NOT NULL)`;
   return runDB(db, tableLanguage, []);
 }
 
@@ -214,7 +216,7 @@ export function createLanguageTable(db: sqlite3.Database): Promise<void> {
 export function insertLanguage(
   db: sqlite3.Database,
   designation: string,
-  version: number
+  version: number,
 ) {
   const insertLanguageQuery = `INSERT INTO language (designation, version) VALUES (?, ?)`;
 
@@ -225,7 +227,7 @@ export function insertLanguage(
 export function updateLanguageDesignation(
   db: sqlite3.Database,
   id: number,
-  newDesignation: string
+  newDesignation: string,
 ) {
   const updateLanguageDesignationQuery = `UPDATE language SET designation = ? WHERE id_language = ?`;
 
@@ -236,7 +238,7 @@ export function updateLanguageDesignation(
 export function updateLanguageVersion(
   db: sqlite3.Database,
   id: number,
-  newVersion: number
+  newVersion: number,
 ) {
   const updateLanguageVersionQuery = `UPDATE language SET version = ? WHERE id_language = ?`;
 
@@ -282,7 +284,8 @@ export function selectLanguageById(db: sqlite3.Database, id: number) {
 
 /* Créer la table work dans la base de données */
 export function createWorkTable(db: sqlite3.Database): Promise<void> {
-  const tableWork = `CREATE TABLE IF NOT EXISTS work (id_work INTEGER PRIMARY KEY AUTOINCREMENT, link CHAR(36) NOT NULL, user_id INTEGER REFERENCES registered_user(id_user), language_id INTEGER NOT NULL REFERENCES language(id_language), content TEXT NOT NULL)`;
+  const tableWork =
+    `CREATE TABLE IF NOT EXISTS work (id_work INTEGER PRIMARY KEY AUTOINCREMENT, link CHAR(36) NOT NULL, user_id INTEGER REFERENCES registered_user(id_user), language_id INTEGER NOT NULL REFERENCES language(id_language), content TEXT NOT NULL)`;
   return runDB(db, tableWork, []);
 }
 
@@ -292,7 +295,7 @@ export function insertWork(
   link: string,
   user_id: number,
   language_id: number,
-  content: string
+  content: string,
 ) {
   const insertWorkQuery = `INSERT INTO work (link, user_id, language_id, content) VALUES (?, ?, ?, ?)`;
 

src/runner.ts

@@ -19,11 +19,11 @@ export const IMAGES = {
 export function allocateBuffer(
   jobId: string,
   code: string,
-  image: string
+  image: string,
 ): Buffer {
   let cur = 0;
   const buffer = Buffer.allocUnsafe(
-    jobId.length + image.length + code.length + 9
+    jobId.length + image.length + code.length + 9,
   );
   cur = buffer.writeUInt8(0, cur);
   cur += buffer.write(jobId, cur);

src/server.ts

@@ -1,12 +1,12 @@
+import { rebaseUpdates, Update } from "@codemirror/collab";
+import { ChangeSet, Text } from "@codemirror/state";
 import cors from "@fastify/cors";
-import websocket, { WebSocket } from '@fastify/websocket';
 import { Type, TypeBoxTypeProvider } from "@fastify/type-provider-typebox";
+import websocket, { WebSocket } from "@fastify/websocket";
 import Fastify, { FastifyReply } from "fastify";
 import { nanoid } from "nanoid";
 import { allocateBuffer, getRunner } from "runner";
 import { Pull, Push } from "zeromq";
-import { ChangeSet, Text } from "@codemirror/state";
-import { Update, rebaseUpdates } from "@codemirror/collab";
 import * as db from "./database";
 
 const sender = new Push();
@@ -14,17 +14,25 @@ await sender.bind(`tcp://127.0.0.1:5557`);
 const receiver = new Pull();
 await receiver.bind(`tcp://127.0.0.1:5558`);
 
+
 const clients: Record<string, FastifyReply> = {};
 const generateId = () => nanoid(32);
 
-let updates: Update[] = [];
+//let updates: Update[] = [];
-let doc = Text.of(['']);
+//let doc = Text.of(["foo"]);
-const liveClients: WebSocket[] = [];
+
+type Room = {
+  sockets: WebSocket[];
+  updates: Update[];
+  doc: Text;
+}
+
+const rooms: Record<string, Room> = {};
 
 function send(socket: WebSocket, requestId: number, payload: unknown) {
   const response = {
     _request: requestId,
-    payload
+    payload,
   };
   socket.send(JSON.stringify(response));
 }
@@ -32,39 +40,79 @@ function send(socket: WebSocket, requestId: number, payload: unknown) {
 const fastify = Fastify({
   logger: true,
 }).withTypeProvider<TypeBoxTypeProvider>();
+type Fastify = typeof fastify;
 await fastify.register(cors, {
-  origin: process.env.ALLOW_ORIGIN || '*',
+  origin: process.env.ALLOW_ORIGIN || "*",
 });
 fastify.register(websocket);
-fastify.get("/live", { websocket: true }, (socket, req) => {
+
-  liveClients.push(socket);
+
-  socket.on("message", message => {
+fastify.register(async function (fastify: Fastify) {
-    const data = JSON.parse(message.toString());
+  fastify.get(
-    const requestId = data._request;
+    "/live/:roomId",
-    if (data.type === "pullUpdates") {
+    {
-      send(socket, requestId, updates.slice(data.version))
+      schema: {
-    } else if (data.type === "pushUpdates") {
+          params: Type.Object({
-      let received = data.updates.map((json: any) => ({
+            roomId: Type.String(),
-        clientID: json.clientID,
+          })
-        changes: ChangeSet.fromJSON(json.changes)
+      },
-      }))
+      websocket: true
-      if (data.version != updates.length) {
+    },
-        received = rebaseUpdates(received, updates.slice(data.version))
+    (socket, request) => {
-      }
+      const { roomId } = request.params;
-      for (let update of received) {
+      let room = rooms[roomId];
-        updates.push(update)
+      if(!room){
-        doc = update.changes.apply(doc)
+        room = {
+          sockets: [],
+          updates: [],
+          doc: Text.of([''])
+        };
+        rooms[roomId] = room;
       }
-      send(socket, requestId, received.map((update: any) => ({
+      room.sockets.push(socket);
-        clientID: update.clientID,
+      socket.on("message", message => {
-        changes: update.changes.toJSON()
+        const data = JSON.parse(message.toString());
-      })));
+        const requestId = data._request;
-    } else if (data.type == "getDocument") {
+
-      send(socket, requestId, {version: updates.length, doc: doc.toString()})
+        if (data.type === "pullUpdates") {
-    }
+          send(socket, requestId, room.updates.slice(data.version));
-  })
+        } else if (data.type === "pushUpdates") {
+          let received = data.updates.map((json: any) => ({
+            clientID: json.clientID,
+            changes: ChangeSet.fromJSON(json.changes),
+          }));
+
+          if (data.version != room.updates.length) {
+            received = rebaseUpdates(received, room.updates.slice(data.version));
+          }
+
+          for (let update of received) {
+            room.updates.push(update);
+            room.doc = update.changes.apply(room.doc);
+          }
+          send(
+            socket,
+            requestId,
+            received.map((update: any) => ({
+              clientID: update.clientID,
+              changes: update.changes.toJSON(),
+            })),
+          );
+        } else if (data.type === "getDocument") {
+          send(socket, requestId, { version: room.updates.length, doc: room.doc.toString() });
+        }
+      });
+  });
 })
 
+/* Route pour créer une room */
+fastify.post(
+  "/live",
+  async (request, reply) => {
+    return generateId();
+  },
+);
+
 fastify.post("/run", {
   schema: {
     body: Type.Object({
@@ -122,7 +170,7 @@ fastify.post(
     const { login, password, permissions } = request.body;
     db.insertUser(database, login, password, permissions);
     reply.send({ success: true });
-  }
+  },
 );
 
 /* Route pour mettre à jour le login d'un utilisateur */
@@ -145,7 +193,7 @@ fastify.put(
     const { newLogin } = request.body;
     db.updateUserLogin(database, id, newLogin);
     reply.send({ success: true });
-  }
+  },
 );
 
 /* Route pour mettre à jour le mot de passe d'un utilisateur */
@@ -168,7 +216,7 @@ fastify.put(
     const { newPassword } = request.body;
     db.updateUserPassword(database, id, newPassword);
     reply.send({ success: true });
-  }
+  },
 );
 
 /* Route pour mettre à jour les permissions d'un utilisateur */
@@ -191,7 +239,7 @@ fastify.put(
     const { newPermissions } = request.body;
     await db.updateUserPermissions(database, id, newPermissions);
     reply.send({ success: true });
-  }
+  },
 );
 
 /* Route pour supprimer un utilisateur par son ID */
@@ -210,7 +258,7 @@ fastify.delete(
     const { id } = request.params;
     await db.deleteUserById(database, id);
     reply.send({ success: true });
-  }
+  },
 );
 
 /* Route pour supprimer un utilisateur par son login */
@@ -227,7 +275,7 @@ fastify.delete(
     const { login } = request.params;
     await db.deleteUserByLogin(database, login);
     reply.send({ success: true });
-  }
+  },
 );
 
 /* Route pour supprimer tous les utilisateurs */
@@ -258,7 +306,7 @@ fastify.get(
     const { id } = request.params;
     const user = await db.selectUserById(database, id);
     reply.send(user);
-  }
+  },
 );
 
 /* Route pour récupérer un utilisateur par son login */
@@ -275,7 +323,7 @@ fastify.get(
     const { login } = request.params;
     const user = await db.selectUserByLogin(database, login);
     reply.send(user);
-  }
+  },
 );
 
 /* Route pour créer un language */
@@ -293,7 +341,7 @@ fastify.post(
     const { designation, version } = request.body;
     db.insertLanguage(database, designation, version);
     reply.send({ success: true });
-  }
+  },
 );
 
 /* Route pour mettre à jour la désignation d'un language */
@@ -316,7 +364,7 @@ fastify.put(
     const { newDesignation } = request.body;
     db.updateLanguageDesignation(database, id, newDesignation);
     reply.send({ success: true });
-  }
+  },
 );
 
 /* Route pour mettre à jour la version d'un language */
@@ -339,7 +387,7 @@ fastify.put(
     const { newVersion } = request.body;
     db.updateLanguageVersion(database, id, newVersion);
     reply.send({ success: true });
-  }
+  },
 );
 
 /* Route pour supprimer un language */
@@ -358,7 +406,7 @@ fastify.delete(
     const { id } = request.params;
     db.deleteLanguage(database, id);
     reply.send({ success: true });
-  }
+  },
 );
 
 /* Route pour supprimer tous les languages */
@@ -383,7 +431,7 @@ fastify.get(
     const { id } = request.params;
     const language = await db.selectLanguageById(database, id);
     reply.send(language);
-  }
+  },
 );
 
 /* Route pour récupérer tous les languages */
@@ -409,7 +457,7 @@ fastify.post(
     const { id_user, link, id_language, code } = request.body;
     db.insertWork(database, link, id_user, id_language, code);
     reply.send({ success: true });
-  }
+  },
 );
 
 /* Route pour récupérer tous les works */
@@ -440,7 +488,7 @@ fastify.delete(
     const { id } = request.params;
     db.deleteWork(database, id);
     reply.send({ success: true });
-  }
+  },
 );
 
 /* Route pour récupérer un work par son ID */
@@ -459,7 +507,7 @@ fastify.get(
     const { id } = request.params;
     const work = await db.selectWorkById(database, id);
     reply.send(work);
-  }
+  },
 );
 
 /* Forward output est une fonction asynchrone qui permet de récupérer les messages envoyés par le container et de les renvoyer au client */