@budibase/server 2.6.19-alpha.37 → 2.6.19-alpha.39

package/dist/index.js

@@ -763,6 +763,12 @@ var init_cli = __esm({
   }
 });
 
+// ../types/src/sdk/websocket.ts
+var init_websocket = __esm({
+  "../types/src/sdk/websocket.ts"() {
+  }
+});
+
 // ../types/src/sdk/index.ts
 var init_sdk = __esm({
   "../types/src/sdk/index.ts"() {
@@ -785,6 +791,7 @@ var init_sdk = __esm({
     init_sso();
     init_user2();
     init_cli();
+    init_websocket();
   }
 });
 
@@ -2649,7 +2656,7 @@ var init_utils2 = __esm({
     })(Databases || {});
     SelectableDatabase = /* @__PURE__ */ ((SelectableDatabase2) => {
       SelectableDatabase2[SelectableDatabase2["DEFAULT"] = 0] = "DEFAULT";
-      SelectableDatabase2[SelectableDatabase2["WRITE_THROUGH"] = 1] = "WRITE_THROUGH";
+      SelectableDatabase2[SelectableDatabase2["SOCKET_IO"] = 1] = "SOCKET_IO";
       SelectableDatabase2[SelectableDatabase2["UNUSED_1"] = 2] = "UNUSED_1";
       SelectableDatabase2[SelectableDatabase2["UNUSED_2"] = 3] = "UNUSED_2";
       SelectableDatabase2[SelectableDatabase2["UNUSED_3"] = 4] = "UNUSED_3";
@@ -2846,6 +2853,9 @@ var init_redis = __esm({
         CLOSED = false;
         init2(this._select);
         await waitForConnection(this._select);
+        if (this._select && !environment_default.isTest()) {
+          this.getClient().select(this._select);
+        }
         return this;
       }
       async finish() {
@@ -2868,6 +2878,10 @@ var init_redis = __esm({
         const db2 = this._db;
         return this.getClient().keys(addDbPrefix(db2, pattern));
       }
+      async exists(key) {
+        const db2 = this._db;
+        return await this.getClient().exists(addDbPrefix(db2, key));
+      }
       async get(key) {
         const db2 = this._db;
         let response2 = await this.getClient().get(addDbPrefix(db2, key));
@@ -2948,6 +2962,7 @@ __export(init_exports, {
   getCacheClient: () => getCacheClient,
   getLockClient: () => getLockClient,
   getSessionClient: () => getSessionClient,
+  getSocketClient: () => getSocketClient,
   getUserClient: () => getUserClient,
   getWritethroughClient: () => getWritethroughClient,
   shutdown: () => shutdown
@@ -2958,9 +2973,10 @@ async function init3() {
   appClient = await new redis_default("appMetadata" /* APP_METADATA */).init();
   cacheClient = await new redis_default("data_cache" /* GENERIC_CACHE */).init();
   lockClient = await new redis_default("locks" /* LOCKS */).init();
-  writethroughClient = await new redis_default(
-    "writeThrough" /* WRITE_THROUGH */,
-    1 /* WRITE_THROUGH */
+  writethroughClient = await new redis_default("writeThrough" /* WRITE_THROUGH */).init();
+  socketClient = await new redis_default(
+    "socket_io" /* SOCKET_IO */,
+    1 /* SOCKET_IO */
   ).init();
 }
 async function shutdown() {
@@ -2976,6 +2992,8 @@ async function shutdown() {
     await writethroughClient.finish();
   if (lockClient)
     await lockClient.finish();
+  if (socketClient)
+    await socketClient.finish();
 }
 async function getUserClient() {
   if (!userClient) {
@@ -3013,7 +3031,13 @@ async function getLockClient() {
   }
   return lockClient;
 }
-var userClient, sessionClient, appClient, cacheClient, writethroughClient, lockClient;
+async function getSocketClient() {
+  if (!socketClient) {
+    await init3();
+  }
+  return socketClient;
+}
+var userClient, sessionClient, appClient, cacheClient, writethroughClient, lockClient, socketClient;
 var init_init = __esm({
   "../backend-core/src/redis/init.ts"() {
     init_redis();
@@ -19578,7 +19602,7 @@ var init_users9 = __esm({
 });
 
 // ../shared-core/src/constants.ts
-var OperatorOptions, SqlNumberTypeRangeMap;
+var OperatorOptions, SqlNumberTypeRangeMap, SocketSessionTTL;
 var init_constants6 = __esm({
   "../shared-core/src/constants.ts"() {
     OperatorOptions = {
@@ -19649,6 +19673,7 @@ var init_constants6 = __esm({
         min: -8388608
       }
     };
+    SocketSessionTTL = 60;
   }
 });
 
@@ -21783,22 +21808,20 @@ async function init17() {
   devAppClient = new redis_exports.Client(redis_exports.utils.Databases.DEV_LOCKS);
   debounceClient = new redis_exports.Client(redis_exports.utils.Databases.DEBOUNCE);
   flagClient = new redis_exports.Client(redis_exports.utils.Databases.FLAGS);
-  socketClient = new redis_exports.Client(redis_exports.utils.Databases.SOCKET_IO);
   await devAppClient.init();
   await debounceClient.init();
   await flagClient.init();
-  await socketClient.init();
-  socketSubClient = socketClient.getClient().duplicate();
+  socketClient2 = await redis_exports.clients.getSocketClient();
+  socketSubClient = socketClient2.getClient().duplicate();
 }
 async function shutdown6() {
+  console.log("REDIS SHUTDOWN");
   if (devAppClient)
     await devAppClient.finish();
   if (debounceClient)
     await debounceClient.finish();
   if (flagClient)
     await flagClient.finish();
-  if (socketClient)
-    await socketClient.finish();
   if (socketSubClient)
     socketSubClient.disconnect();
   await redis_exports.clients.shutdown();
@@ -21855,11 +21878,11 @@ async function clearTestFlag(id) {
 }
 function getSocketPubSubClients() {
   return {
-    pub: socketClient.getClient(),
+    pub: socketClient2.getClient(),
     sub: socketSubClient
   };
 }
-var APP_DEV_LOCK_SECONDS, AUTOMATION_TEST_FLAG_SECONDS, devAppClient, debounceClient, flagClient, socketClient, socketSubClient;
+var APP_DEV_LOCK_SECONDS, AUTOMATION_TEST_FLAG_SECONDS, devAppClient, debounceClient, flagClient, socketClient2, socketSubClient;
 var init_redis4 = __esm({
   "src/utilities/redis.ts"() {
     init_src2();
@@ -31046,8 +31069,8 @@ var init_file = __esm({
 });
 
 // src/websockets/websocket.ts
-var import_socket, import_http, import_cookies, import_koa_useragent, import_redis_adapter, import_uuid4, Socket;
-var init_websocket = __esm({
+var import_socket, import_http, import_cookies, import_koa_useragent, import_redis_adapter, BaseSocket;
+var init_websocket2 = __esm({
   "src/websockets/websocket.ts"() {
     import_socket = require("socket.io");
     import_http = __toESM(require("http"));
@@ -31057,9 +31080,10 @@ var init_websocket = __esm({
     init_currentapp();
     import_redis_adapter = require("@socket.io/redis-adapter");
     init_redis4();
-    import_uuid4 = __toESM(require("uuid"));
-    Socket = class {
+    init_src3();
+    BaseSocket = class {
       constructor(app2, server2, path5 = "/", additionalMiddlewares) {
+        this.path = path5;
         this.io = new import_socket.Server(server2, {
           path: path5
         });
@@ -31095,14 +31119,13 @@ var init_websocket = __esm({
               await middleware2(ctx, () => {
                 if (idx === middlewares.length - 1) {
                   const { _id, email, firstName, lastName } = ctx.user;
-                  socket.data.user = {
+                  socket.data = {
                     _id,
                     email,
                     firstName,
                     lastName,
-                    sessionId: import_uuid4.default.v4()
+                    sessionId: socket.id
                   };
-                  socket.data.appId = ctx.appId;
                   next();
                 }
               });
@@ -31111,9 +31134,141 @@ var init_websocket = __esm({
             next(error2);
           }
         });
+        this.initialise().then(() => {
+          this.io.on("connection", async (socket) => {
+            socket.on("Heartbeat" /* Heartbeat */, async () => {
+              console.log(socket.data.email, "heartbeat received");
+              await this.extendSessionTTL(socket.data.sessionId);
+            });
+            socket.on("disconnect", async () => {
+              await this.onDisconnect(socket);
+              await this.leaveRoom(socket);
+            });
+            await this.onConnect(socket);
+          });
+        });
+      }
+      async initialise() {
         const { pub, sub } = getSocketPubSubClients();
-        const opts = { key: `socket.io-${path5}` };
+        const opts = {
+          key: `${redis_exports.utils.Databases.SOCKET_IO}-${this.path}-pubsub`
+        };
         this.io.adapter((0, import_redis_adapter.createAdapter)(pub, sub, opts));
+        this.redisClient = await redis_exports.clients.getSocketClient();
+      }
+      // Gets the redis key for a certain session ID
+      getSessionKey(sessionId) {
+        return `${this.path}-session:${sessionId}`;
+      }
+      // Gets the redis key for certain room name
+      getRoomKey(room) {
+        return `${this.path}-room:${room}`;
+      }
+      async extendSessionTTL(sessionId) {
+        var _a2;
+        const key = this.getSessionKey(sessionId);
+        await ((_a2 = this.redisClient) == null ? void 0 : _a2.setExpiry(key, SocketSessionTTL));
+      }
+      // Gets an array of all redis keys of users inside a certain room
+      async getRoomSessionIds(room) {
+        var _a2;
+        const keys2 = await ((_a2 = this.redisClient) == null ? void 0 : _a2.get(this.getRoomKey(room)));
+        return keys2 || [];
+      }
+      // Sets the list of redis keys for users inside a certain room.
+      // There is no TTL on the actual room key map itself.
+      async setRoomSessionIds(room, ids) {
+        var _a2;
+        await ((_a2 = this.redisClient) == null ? void 0 : _a2.store(this.getRoomKey(room), ids));
+      }
+      // Gets a list of all users inside a certain room
+      async getRoomSessions(room) {
+        var _a2;
+        if (room) {
+          const sessionIds = await this.getRoomSessionIds(room);
+          const keys2 = sessionIds.map(this.getSessionKey.bind(this));
+          const sessions = await ((_a2 = this.redisClient) == null ? void 0 : _a2.bulkGet(keys2));
+          return Object.values(sessions || {});
+        } else {
+          return [];
+        }
+      }
+      // Detects keys which have been pruned from redis due to TTL expiry in a certain
+      // room and broadcasts disconnection messages to ensure clients are aware
+      async pruneRoom(room) {
+        const sessionIds = await this.getRoomSessionIds(room);
+        const sessionsExist = await Promise.all(
+          sessionIds.map((id) => {
+            var _a2;
+            return (_a2 = this.redisClient) == null ? void 0 : _a2.exists(this.getSessionKey(id));
+          })
+        );
+        const prunedSessionIds = sessionIds.filter((id, idx) => {
+          if (!sessionsExist[idx]) {
+            this.io.to(room).emit("UserDisconnect" /* UserDisconnect */, sessionIds[idx]);
+            return false;
+          }
+          return true;
+        });
+        await this.setRoomSessionIds(room, prunedSessionIds);
+      }
+      // Adds a user to a certain room
+      async joinRoom(socket, room) {
+        var _a2;
+        if (!room) {
+          return;
+        }
+        await this.pruneRoom(room);
+        const oldRoom = socket.data.room;
+        if (oldRoom && oldRoom !== room) {
+          await this.leaveRoom(socket);
+        }
+        if (!oldRoom || oldRoom !== room) {
+          socket.join(room);
+          socket.data.room = room;
+        }
+        let user2 = socket.data;
+        const { sessionId } = user2;
+        const key = this.getSessionKey(sessionId);
+        await ((_a2 = this.redisClient) == null ? void 0 : _a2.store(key, user2, SocketSessionTTL));
+        const sessionIds = await this.getRoomSessionIds(room);
+        if (!sessionIds.includes(sessionId)) {
+          await this.setRoomSessionIds(room, [...sessionIds, sessionId]);
+        }
+        socket.to(room).emit("UserUpdate" /* UserUpdate */, user2);
+      }
+      // Disconnects a socket from its current room
+      async leaveRoom(socket) {
+        var _a2;
+        let user2 = socket.data;
+        const { room, sessionId } = user2;
+        if (!room) {
+          return;
+        }
+        socket.leave(room);
+        socket.data.room = void 0;
+        const key = this.getSessionKey(sessionId);
+        await ((_a2 = this.redisClient) == null ? void 0 : _a2.delete(key));
+        const sessionIds = await this.getRoomSessionIds(room);
+        await this.setRoomSessionIds(
+          room,
+          sessionIds.filter((id) => id !== sessionId)
+        );
+        socket.to(room).emit("UserDisconnect" /* UserDisconnect */, sessionId);
+      }
+      // Updates a connected user's metadata, assuming a room change is not required.
+      async updateUser(socket, patch4) {
+        socket.data = {
+          ...socket.data,
+          ...patch4
+        };
+        if (socket.data.room) {
+          await this.joinRoom(socket, socket.data.room);
+        }
+      }
+      async onConnect(socket) {
+      }
+      async onDisconnect(socket) {
       }
       // Emit an event to all sockets
       emit(event, payload) {
@@ -31127,10 +31282,10 @@ var init_websocket = __esm({
 var ClientAppWebsocket;
 var init_client2 = __esm({
   "src/websockets/client.ts"() {
-    init_websocket();
+    init_websocket2();
     init_authorized();
     init_src2();
-    ClientAppWebsocket = class extends Socket {
+    ClientAppWebsocket = class extends BaseSocket {
       constructor(app2, server2) {
         super(app2, server2, "/socket/client", [authorized_default(permissions_exports.BUILDER)]);
       }
@@ -31447,54 +31602,37 @@ var GridSocket;
 var init_grid = __esm({
   "src/websockets/grid.ts"() {
     init_authorized();
-    init_websocket();
+    init_websocket2();
     init_src2();
     init_utils24();
-    GridSocket = class extends Socket {
+    init_src3();
+    GridSocket = class extends BaseSocket {
       constructor(app2, server2) {
         super(app2, server2, "/socket/grid", [authorized_default(permissions_exports.BUILDER)]);
-        this.io.on("connection", (socket) => {
-          const user2 = socket.data.user;
-          let currentRoom;
-          socket.on("select-table", async (tableId, callback) => {
-            if (currentRoom) {
-              socket.to(currentRoom).emit("user-disconnect", user2);
-              socket.leave(currentRoom);
-            }
-            currentRoom = tableId;
-            socket.join(currentRoom);
-            socket.to(currentRoom).emit("user-update", user2);
-            const sockets = await this.io.in(currentRoom).fetchSockets();
-            callback({
-              users: sockets.map((socket2) => socket2.data.user)
-            });
-          });
-          socket.on("select-cell", (cellId) => {
-            socket.data.user.focusedCellId = cellId;
-            if (currentRoom) {
-              socket.to(currentRoom).emit("user-update", user2);
-            }
-          });
-          socket.on("disconnect", () => {
-            if (currentRoom) {
-              socket.to(currentRoom).emit("user-disconnect", user2);
-            }
-          });
+      }
+      async onConnect(socket) {
+        socket.on("SelectTable" /* SelectTable */, async (tableId, callback) => {
+          await this.joinRoom(socket, tableId);
+          const sessions = await this.getRoomSessions(tableId);
+          callback({ users: sessions });
+        });
+        socket.on("SelectCell" /* SelectCell */, (cellId) => {
+          this.updateUser(socket, { focusedCellId: cellId });
         });
       }
       emitRowUpdate(ctx, row2) {
         const tableId = getTableId(ctx);
-        this.io.in(tableId).emit("row-change", { id: row2._id, row: row2 });
+        this.io.in(tableId).emit("RowChange" /* RowChange */, { id: row2._id, row: row2 });
       }
       emitRowDeletion(ctx, id) {
         const tableId = getTableId(ctx);
-        this.io.in(tableId).emit("row-change", { id, row: null });
+        this.io.in(tableId).emit("RowChange" /* RowChange */, { id, row: null });
       }
       emitTableUpdate(table2) {
-        this.io.in(table2._id).emit("table-change", { id: table2._id, table: table2 });
+        this.io.in(table2._id).emit("TableChange" /* TableChange */, { id: table2._id, table: table2 });
       }
       emitTableDeletion(id) {
-        this.io.in(id).emit("table-change", { id, table: null });
+        this.io.in(id).emit("TableChange" /* TableChange */, { id, table: null });
       }
     };
   }
@@ -31505,53 +31643,53 @@ var BuilderSocket;
 var init_builder2 = __esm({
   "src/websockets/builder.ts"() {
     init_authorized();
-    init_websocket();
+    init_websocket2();
     init_src2();
     init_websockets();
     init_redis4();
-    BuilderSocket = class extends Socket {
+    init_src3();
+    BuilderSocket = class extends BaseSocket {
       constructor(app2, server2) {
         super(app2, server2, "/socket/builder", [authorized_default(permissions_exports.BUILDER)]);
-        this.io.on("connection", (socket) => {
-          const user2 = socket.data.user;
-          const appId = socket.data.appId;
-          socket.join(appId);
-          socket.to(appId).emit("user-update", user2);
-          socket.on("get-users", async (payload, callback) => {
-            const sockets = await this.io.in(appId).fetchSockets();
-            callback({
-              users: sockets.map((socket2) => socket2.data.user)
-            });
-          });
-          socket.on("disconnect", async () => {
-            socket.to(appId).emit("user-disconnect", user2);
-            try {
-              const sockets = await this.io.in(appId).fetchSockets();
-              const hasOtherConnection = sockets.some((socket2) => {
-                const { _id, sessionId } = socket2.data.user;
-                return _id === user2._id && sessionId !== user2.sessionId;
-              });
-              if (!hasOtherConnection) {
-                await clearLock(appId, user2);
-              }
-            } catch (e) {
-            }
-          });
+      }
+      async onConnect(socket) {
+        socket.on("SelectApp" /* SelectApp */, async (appId, callback) => {
+          await this.joinRoom(socket, appId);
+          const sessions = await this.getRoomSessions(appId);
+          callback({ users: sessions });
         });
       }
+      async onDisconnect(socket) {
+        try {
+          const session = socket.data;
+          const { _id, sessionId, room } = session;
+          const sessions = await this.getRoomSessions(room);
+          const hasOtherSession = sessions.some((otherSession) => {
+            return _id === otherSession._id && sessionId !== otherSession.sessionId;
+          });
+          if (!hasOtherSession && room) {
+            const user2 = { _id: socket.data._id };
+            await clearLock(room, user2);
+          }
+        } catch (e) {
+        }
+      }
       emitTableUpdate(ctx, table2) {
-        this.io.in(ctx.appId).emit("table-change", { id: table2._id, table: table2 });
+        this.io.in(ctx.appId).emit("TableChange" /* TableChange */, { id: table2._id, table: table2 });
         gridSocket.emitTableUpdate(table2);
       }
       emitTableDeletion(ctx, id) {
-        this.io.in(ctx.appId).emit("table-change", { id, table: null });
+        this.io.in(ctx.appId).emit("TableChange" /* TableChange */, { id, table: null });
         gridSocket.emitTableDeletion(id);
       }
       emitDatasourceUpdate(ctx, datasource2) {
-        this.io.in(ctx.appId).emit("datasource-change", { id: datasource2._id, datasource: datasource2 });
+        this.io.in(ctx.appId).emit("DatasourceChange" /* DatasourceChange */, {
+          id: datasource2._id,
+          datasource: datasource2
+        });
       }
       emitDatasourceDeletion(ctx, id) {
-        this.io.in(ctx.appId).emit("datasource-change", { id, datasource: null });
+        this.io.in(ctx.appId).emit("DatasourceChange" /* DatasourceChange */, { id, datasource: null });
       }
     };
   }
@@ -42981,7 +43119,7 @@ async function prepareUpload({ s3Key, bucket, metadata, file }) {
     key: response2.Key
   };
 }
-var import_string_templates10, import_aws_sdk4, import_fs15, uuid6, send2, toggleBetaUiFeature, serveBuilder, uploadFile, deleteObjects, serveApp, serveBuilderPreview, serveClientLibrary, getSignedUploadURL;
+var import_string_templates10, import_aws_sdk4, import_fs15, uuid5, send2, toggleBetaUiFeature, serveBuilder, uploadFile, deleteObjects, serveApp, serveBuilderPreview, serveClientLibrary, getSignedUploadURL;
 var init_static = __esm({
   "src/api/controllers/static/index.ts"() {
     init_centralPath();
@@ -42996,7 +43134,7 @@ var init_static = __esm({
     init_sdk3();
     init_src4();
     require("svelte/register");
-    uuid6 = require("uuid");
+    uuid5 = require("uuid");
     send2 = require("koa-send");
     toggleBetaUiFeature = async function(ctx) {
       const cookieName = `beta:${ctx.params.feature}`;
@@ -43028,7 +43166,7 @@ var init_static = __esm({
       let files = ctx.request.files.file.length > 1 ? Array.from(ctx.request.files.file) : [ctx.request.files.file];
       const uploads = files.map(async (file) => {
         const fileExtension = [...file.name.split(".")].pop();
-        const processedFileName = `${uuid6.v4()}.${fileExtension}`;
+        const processedFileName = `${uuid5.v4()}.${fileExtension}`;
         return prepareUpload({
           file,
           s3Key: `${context_exports.getProdAppId()}/attachments/${processedFileName}`,