@budibase/server 2.6.19-alpha.3 → 2.6.19-alpha.30

package/src/websockets/builder.ts

@@ -0,0 +1,69 @@
+import authorized from "../middleware/authorized"
+import Socket from "./websocket"
+import { permissions } from "@budibase/backend-core"
+import http from "http"
+import Koa from "koa"
+import { Datasource, Table } from "@budibase/types"
+import { gridSocket } from "./index"
+import { clearLock } from "../utilities/redis"
+
+export default class BuilderSocket extends Socket {
+  constructor(app: Koa, server: http.Server) {
+    super(app, server, "/socket/builder", [authorized(permissions.BUILDER)])
+
+    this.io.on("connection", socket => {
+      // Join a room for this app
+      const user = socket.data.user
+      const appId = socket.data.appId
+      socket.join(appId)
+      socket.to(appId).emit("user-update", user)
+
+      // Initial identification of connected spreadsheet
+      socket.on("get-users", async (payload, callback) => {
+        const sockets = await this.io.in(appId).fetchSockets()
+        callback({
+          users: sockets.map(socket => socket.data.user),
+        })
+      })
+
+      // Disconnection cleanup
+      socket.on("disconnect", async () => {
+        socket.to(appId).emit("user-disconnect", user)
+
+        // Remove app lock from this user if they have no other connections
+        try {
+          const sockets = await this.io.in(appId).fetchSockets()
+          const hasOtherConnection = sockets.some(socket => {
+            const { _id, sessionId } = socket.data.user
+            return _id === user._id && sessionId !== user.sessionId
+          })
+          if (!hasOtherConnection) {
+            await clearLock(appId, user)
+          }
+        } catch (e) {
+          // This is fine, just means this user didn't hold the lock
+        }
+      })
+    })
+  }
+
+  emitTableUpdate(ctx: any, table: Table) {
+    this.io.in(ctx.appId).emit("table-change", { id: table._id, table })
+    gridSocket.emitTableUpdate(table)
+  }
+
+  emitTableDeletion(ctx: any, id: string) {
+    this.io.in(ctx.appId).emit("table-change", { id, table: null })
+    gridSocket.emitTableDeletion(id)
+  }
+
+  emitDatasourceUpdate(ctx: any, datasource: Datasource) {
+    this.io
+      .in(ctx.appId)
+      .emit("datasource-change", { id: datasource._id, datasource })
+  }
+
+  emitDatasourceDeletion(ctx: any, id: string) {
+    this.io.in(ctx.appId).emit("datasource-change", { id, datasource: null })
+  }
+}

package/src/websockets/grid.ts

@@ -3,6 +3,8 @@ import Socket from "./websocket"
 import { permissions } from "@budibase/backend-core"
 import http from "http"
 import Koa from "koa"
+import { getTableId } from "../api/controllers/row/utils"
+import { Row, Table } from "@budibase/types"
 
 export default class GridSocket extends Socket {
   constructor(app: Koa, server: http.Server) {
@@ -10,7 +12,6 @@ export default class GridSocket extends Socket {
 
     this.io.on("connection", socket => {
       const user = socket.data.user
-      console.log(`Spreadsheet user connected: ${user?.id}`)
 
       // Socket state
       let currentRoom: string
@@ -19,37 +20,54 @@ export default class GridSocket extends Socket {
       socket.on("select-table", async (tableId, callback) => {
         // Leave current room
         if (currentRoom) {
-          socket.to(currentRoom).emit("user-disconnect", socket.data.user)
+          socket.to(currentRoom).emit("user-disconnect", user)
           socket.leave(currentRoom)
         }
 
         // Join new room
         currentRoom = tableId
         socket.join(currentRoom)
-        socket.to(currentRoom).emit("user-update", socket.data.user)
+        socket.to(currentRoom).emit("user-update", user)
 
         // Reply with all users in current room
         const sockets = await this.io.in(currentRoom).fetchSockets()
         callback({
           users: sockets.map(socket => socket.data.user),
-          id: user.id,
         })
       })
 
       // Handle users selecting a new cell
       socket.on("select-cell", cellId => {
-        socket.data.user.selectedCellId = cellId
+        socket.data.user.focusedCellId = cellId
         if (currentRoom) {
-          socket.to(currentRoom).emit("user-update", socket.data.user)
+          socket.to(currentRoom).emit("user-update", user)
         }
       })
 
       // Disconnection cleanup
       socket.on("disconnect", () => {
         if (currentRoom) {
-          socket.to(currentRoom).emit("user-disconnect", socket.data.user)
+          socket.to(currentRoom).emit("user-disconnect", user)
         }
       })
     })
   }
+
+  emitRowUpdate(ctx: any, row: Row) {
+    const tableId = getTableId(ctx)
+    this.io.in(tableId).emit("row-change", { id: row._id, row })
+  }
+
+  emitRowDeletion(ctx: any, id: string) {
+    const tableId = getTableId(ctx)
+    this.io.in(tableId).emit("row-change", { id, row: null })
+  }
+
+  emitTableUpdate(table: Table) {
+    this.io.in(table._id!).emit("table-change", { id: table._id, table })
+  }
+
+  emitTableDeletion(id: string) {
+    this.io.in(id).emit("table-change", { id, table: null })
+  }
 }

package/src/websockets/index.ts

@@ -1,14 +1,17 @@
 import http from "http"
 import Koa from "koa"
-import GridSocket from "./grid"
 import ClientAppSocket from "./client"
+import GridSocket from "./grid"
+import BuilderSocket from "./builder"
 
 let clientAppSocket: ClientAppSocket
 let gridSocket: GridSocket
+let builderSocket: BuilderSocket
 
 export const initialise = (app: Koa, server: http.Server) => {
   clientAppSocket = new ClientAppSocket(app, server)
   gridSocket = new GridSocket(app, server)
+  builderSocket = new BuilderSocket(app, server)
 }
 
-export { clientAppSocket, gridSocket }
+export { clientAppSocket, gridSocket, builderSocket }

package/src/websockets/websocket.ts

@@ -5,6 +5,9 @@ import Cookies from "cookies"
 import { userAgent } from "koa-useragent"
 import { auth } from "@budibase/backend-core"
 import currentApp from "../middleware/currentapp"
+import { createAdapter } from "@socket.io/redis-adapter"
+import { getSocketPubSubClients } from "../utilities/redis"
+import uuid from "uuid"
 
 export default class Socket {
   io: Server
@@ -12,7 +15,7 @@ export default class Socket {
   constructor(
     app: Koa,
     server: http.Server,
-    path: string,
+    path: string = "/",
     additionalMiddlewares?: any[]
   ) {
     this.io = new Server(server, {
@@ -59,13 +62,21 @@ export default class Socket {
         for (let [idx, middleware] of middlewares.entries()) {
           await middleware(ctx, () => {
             if (idx === middlewares.length - 1) {
-              // Middlewares are finished.
+              // Middlewares are finished
               // Extract some data from our enriched koa context to persist
               // as metadata for the socket
+              // Add user info, including a deterministic color and label
+              const { _id, email, firstName, lastName } = ctx.user
               socket.data.user = {
-                id: ctx.user._id,
-                email: ctx.user.email,
+                _id,
+                email,
+                firstName,
+                lastName,
+                sessionId: uuid.v4(),
               }
+
+              // Add app ID to help split sockets into rooms
+              socket.data.appId = ctx.appId
               next()
             }
           })
@@ -74,6 +85,11 @@ export default class Socket {
         next(error)
       }
     })
+
+    // Instantiate redis adapter
+    const { pub, sub } = getSocketPubSubClients()
+    const opts = { key: `socket.io-${path}` }
+    this.io.adapter(createAdapter(pub, sub, opts))
   }
 
   // Emit an event to all sockets

package/tsconfig.build.json

@@ -10,7 +10,15 @@
     "incremental": true,
     "types": ["node", "jest"],
     "outDir": "dist/src",
-    "skipLibCheck": true
+    "skipLibCheck": true,
+    "baseUrl": ".",
+    "paths": {
+      "@budibase/types": ["../types/src"],
+      "@budibase/backend-core": ["../backend-core/src"],
+      "@budibase/backend-core/*": ["../backend-core/*"],
+      "@budibase/shared-core": ["../shared-core/src"],
+      "@budibase/pro": ["../pro/packages/pro/src"]
+    }
   },
   "include": ["src/**/*"],
   "exclude": [

package/tsconfig.json

@@ -5,25 +5,12 @@
     "declaration": true,
     "sourceMap": true,
     "baseUrl": ".",
-    "outDir": "dist",
-    "paths": {
-      "@budibase/types": ["../types/src"],
-      "@budibase/backend-core": ["../backend-core/src"],
-      "@budibase/backend-core/*": ["../backend-core/*"],
-      "@budibase/shared-core": ["../shared-core/src"],
-      "@budibase/pro": ["../pro/packages/pro/src"]
-    }
+    "outDir": "dist"
   },
   "ts-node": {
     "require": ["tsconfig-paths/register"],
     "swc": true
   },
-  "references": [
-    { "path": "../types" },
-    { "path": "../backend-core" },
-    { "path": "../shared-core" },
-    { "path": "../../../budibase-pro/packages/pro" }
-  ],
   "include": ["src/**/*", "specs"],
   "exclude": ["node_modules", "dist"]
 }

package/dist/api/controllers/analytics.js

@@ -1,46 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ping = exports.isEnabled = void 0;
-const backend_core_1 = require("@budibase/backend-core");
-const types_1 = require("@budibase/types");
-const utils_1 = require("../../db/utils");
-const backend_core_2 = require("@budibase/backend-core");
-const isEnabled = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
-    const enabled = yield backend_core_1.events.analytics.enabled();
-    ctx.body = {
-        enabled,
-    };
-});
-exports.isEnabled = isEnabled;
-const ping = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
-    const body = ctx.request.body;
-    switch (body.source) {
-        case types_1.PingSource.APP: {
-            const db = backend_core_2.context.getAppDB({ skip_setup: true });
-            const appInfo = yield db.get(utils_1.DocumentType.APP_METADATA);
-            let appId = backend_core_2.context.getAppId();
-            if ((0, utils_1.isDevAppID)(appId)) {
-                yield backend_core_1.events.serve.servedAppPreview(appInfo, body.timezone);
-            }
-            else {
-                yield backend_core_1.events.serve.servedApp(appInfo, body.timezone);
-            }
-            break;
-        }
-        case types_1.PingSource.BUILDER: {
-            yield backend_core_1.events.serve.servedBuilder(body.timezone);
-            break;
-        }
-    }
-    ctx.status = 200;
-});
-exports.ping = ping;

package/dist/api/controllers/apikeys.js

@@ -1,72 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.update = exports.fetch = void 0;
-const backend_core_1 = require("@budibase/backend-core");
-const KEYS_DOC = backend_core_1.db.StaticDatabases.GLOBAL.docs.apiKeys;
-function getBuilderMainDoc() {
-    return __awaiter(this, void 0, void 0, function* () {
-        const db = backend_core_1.tenancy.getGlobalDB();
-        try {
-            return yield db.get(KEYS_DOC);
-        }
-        catch (err) {
-            // doesn't exist yet, nothing to get
-            return {
-                _id: KEYS_DOC,
-            };
-        }
-    });
-}
-function setBuilderMainDoc(doc) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // make sure to override the ID
-        doc._id = KEYS_DOC;
-        const db = backend_core_1.tenancy.getGlobalDB();
-        return db.put(doc);
-    });
-}
-function fetch(ctx) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            const mainDoc = yield getBuilderMainDoc();
-            ctx.body = mainDoc.apiKeys ? mainDoc.apiKeys : {};
-        }
-        catch (err) {
-            /* istanbul ignore next */
-            ctx.throw(400, err);
-        }
-    });
-}
-exports.fetch = fetch;
-function update(ctx) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const key = ctx.params.key;
-        const value = ctx.request.body.value;
-        try {
-            const mainDoc = yield getBuilderMainDoc();
-            if (mainDoc.apiKeys == null) {
-                mainDoc.apiKeys = {};
-            }
-            mainDoc.apiKeys[key] = value;
-            const resp = yield setBuilderMainDoc(mainDoc);
-            ctx.body = {
-                _id: resp.id,
-                _rev: resp.rev,
-            };
-        }
-        catch (err) {
-            /* istanbul ignore next */
-            ctx.throw(400, err);
-        }
-    });
-}
-exports.update = update;