clean up code

Author: TabrizPlv

backend/collaboration/src/config.ts

@@ -4,4 +4,10 @@ export const UI_HOST = process.env.PEERPREP_UI_HOST!;
 
 export const EXPRESS_PORT = process.env.EXPRESS_PORT;
 
-export const WEBSOCKET_PORT = process.env.WEBSOCKET_PORT;
+export const dbConfig = {
+  host: process.env.EXPRESS_DB_HOST!,
+  port: Number.parseInt(process.env.EXPRESS_DB_PORT!),
+  database: process.env.POSTGRES_DB!,
+  user: process.env.POSTGRES_USER,
+  password: process.env.POSTGRES_PASSWORD,
+};

backend/collaboration/src/index.ts

@@ -1,14 +1,12 @@
 import { EXPRESS_PORT } from '@/config';
 import { logger } from '@/lib/utils/logger';
 import { dbHealthCheck } from '@/server';
-import server from '@/websocket';
+import server from '@/server';
 
 const port = Number.parseInt(EXPRESS_PORT || '8001');
-const wsPort = Number.parseInt(WEBSOCKET_PORT || '8002');
 
 const listenMessage = `App listening on port: ${port}`;
 server.listen(port, () => {
   void dbHealthCheck();
   logger.info(listenMessage);
 });
-server.listen(wsPort, () => logger.info(`WebSocket listening on port: ${wsPort}`));

backend/collaboration/src/server.ts

@@ -10,7 +10,13 @@ import { config, db } from '@/lib/db';
 import { logger } from '@/lib/utils';
 import roomRoutes from '@/routes/room';
 
+import { WebSocketServer } from 'ws';
+import { createServer } from 'http';
+import { setupWSConnection } from './y-postgresql-util/utils';
+import { setUpPersistence } from './y-postgresql-util/persistence';
 const app = express();
+const server = createServer(app);
+
 app.use(pino());
 app.use(json());
 app.use(
@@ -25,6 +31,10 @@ app.use('/room', roomRoutes);
 // Health Check for Docker
 app.get('/health', (_req, res) => res.status(StatusCodes.OK).send('OK'));
 
+// y-websocket server
+const wss = new WebSocketServer({ server });
+wss.on('connection', setupWSConnection);
+setUpPersistence();
 export const dbHealthCheck = async () => {
   try {
     await db`SELECT 1`;
@@ -42,4 +52,5 @@ app.get('/test-db', async (_req, res) => {
   await dbHealthCheck();
   res.json({ message: 'OK ' });
 });
-export default app;
+
+export default server;

backend/collaboration/src/y-postgresql-util/interfaces.ts renamed to backend/collaboration/src/types/interfaces.ts

@@ -0,0 +1,35 @@
+import * as Y from 'yjs';
+import { setPersistence } from '@/y-postgresql-util/utils';
+import { IWSSharedDoc } from '@/types/interfaces';
+import { PostgresqlPersistence } from 'y-postgresql';
+import { dbConfig } from '@/config';
+
+export const setUpPersistence = async () => {
+  const pgdb = await PostgresqlPersistence.build(dbConfig);
+  setPersistence({
+    bindState: async (docName: string, ydoc: IWSSharedDoc) => {
+      // Get the persisted document from PostgreSQL
+      const persistedYdoc = await pgdb.getYDoc(docName);
+
+      // Apply the current state from the database to the Yjs document
+      Y.applyUpdate(ydoc, Y.encodeStateAsUpdate(persistedYdoc));
+
+      // Merge new updates with the persisted state and store
+      ydoc.on('update', async (update: Uint8Array) => {
+        const currentUpdates = await pgdb.getYDoc(docName);
+        const mergedUpdates = Y.mergeUpdates([Y.encodeStateAsUpdate(currentUpdates), update]);
+        //Remove the previous entry from the database
+        await pgdb.clearDocument(docName);
+        // Store the merged updates in the database
+        await pgdb.storeUpdate(docName, mergedUpdates);
+      });
+    },
+
+    // This function is called to write the final state (when the document is closed)
+    writeState: (__docName: string, __ydoc: IWSSharedDoc) => {
+      return new Promise((resolve) => {
+        resolve(true);
+      });
+    },
+  });
+};

backend/collaboration/src/websocket.ts

@@ -1,3 +1,7 @@
+/*
+Implementation from yjs-websocket/bin/utils.js
+Copied here for safe referencing
+*/
 import * as Y from 'yjs';
 import * as syncProtocol from 'y-protocols/sync';
 import * as awarenessProtocol from 'y-protocols/awareness';
@@ -6,7 +10,7 @@ import * as encoding from 'lib0/encoding';
 import * as decoding from 'lib0/decoding';
 import * as map from 'lib0/map';
 
-import { IPersistence, IWSSharedDoc } from '@/y-postgresql-util/interfaces';
+import { IPersistence, IWSSharedDoc } from '@/types/interfaces';
 
 const wsReadyStateConnecting = 0;
 const wsReadyStateOpen = 1;