@budibase/server 2.5.6-alpha.6 → 2.5.6-alpha.8

package/dist/websockets/client.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const websocket_1 = __importDefault(require("./websocket"));
+const authorized_1 = __importDefault(require("../middleware/authorized"));
+const backend_core_1 = require("@budibase/backend-core");
+class ClientAppWebsocket extends websocket_1.default {
+    constructor(app, server) {
+        super(app, server, "/socket/client", [(0, authorized_1.default)(backend_core_1.permissions.BUILDER)]);
+    }
+}
+exports.default = ClientAppWebsocket;

package/dist/websockets/grid.js

@@ -0,0 +1,60 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const authorized_1 = __importDefault(require("../middleware/authorized"));
+const websocket_1 = __importDefault(require("./websocket"));
+const backend_core_1 = require("@budibase/backend-core");
+class GridSocket extends websocket_1.default {
+    constructor(app, server) {
+        super(app, server, "/socket/grid", [(0, authorized_1.default)(backend_core_1.permissions.BUILDER)]);
+        this.io.on("connection", socket => {
+            const user = socket.data.user;
+            console.log(`Spreadsheet user connected: ${user === null || user === void 0 ? void 0 : user.id}`);
+            // Socket state
+            let currentRoom;
+            // Initial identification of connected spreadsheet
+            socket.on("select-table", (tableId, callback) => __awaiter(this, void 0, void 0, function* () {
+                // Leave current room
+                if (currentRoom) {
+                    socket.to(currentRoom).emit("user-disconnect", socket.data.user);
+                    socket.leave(currentRoom);
+                }
+                // Join new room
+                currentRoom = tableId;
+                socket.join(currentRoom);
+                socket.to(currentRoom).emit("user-update", socket.data.user);
+                // Reply with all users in current room
+                const sockets = yield 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;
+                if (currentRoom) {
+                    socket.to(currentRoom).emit("user-update", socket.data.user);
+                }
+            });
+            // Disconnection cleanup
+            socket.on("disconnect", () => {
+                if (currentRoom) {
+                    socket.to(currentRoom).emit("user-disconnect", socket.data.user);
+                }
+            });
+        });
+    }
+}
+exports.default = GridSocket;

package/dist/websockets/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gridSocket = exports.clientAppSocket = exports.initialise = void 0;
+const grid_1 = __importDefault(require("./grid"));
+const client_1 = __importDefault(require("./client"));
+let clientAppSocket;
+exports.clientAppSocket = clientAppSocket;
+let gridSocket;
+exports.gridSocket = gridSocket;
+const initialise = (app, server) => {
+    exports.clientAppSocket = clientAppSocket = new client_1.default(app, server);
+    exports.gridSocket = gridSocket = new grid_1.default(app, server);
+};
+exports.initialise = initialise;

package/dist/websockets/websocket.js

@@ -0,0 +1,78 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const socket_io_1 = require("socket.io");
+const http_1 = __importDefault(require("http"));
+const cookies_1 = __importDefault(require("cookies"));
+const koa_useragent_1 = require("koa-useragent");
+const backend_core_1 = require("@budibase/backend-core");
+const currentapp_1 = __importDefault(require("../middleware/currentapp"));
+class Socket {
+    constructor(app, server, path, additionalMiddlewares) {
+        this.io = new socket_io_1.Server(server, {
+            path,
+        });
+        // Attach default middlewares
+        const authenticate = backend_core_1.auth.buildAuthMiddleware([], {
+            publicAllowed: true,
+        });
+        const middlewares = [
+            koa_useragent_1.userAgent,
+            authenticate,
+            currentapp_1.default,
+            ...(additionalMiddlewares || []),
+        ];
+        // Apply middlewares
+        this.io.use((socket, next) => __awaiter(this, void 0, void 0, function* () {
+            // Build fake koa context
+            const res = new http_1.default.ServerResponse(socket.request);
+            const ctx = Object.assign(Object.assign({}, app.createContext(socket.request, res)), { 
+                // Additional overrides needed to make our middlewares work with this
+                // fake koa context
+                cookies: new cookies_1.default(socket.request, res), get: (field) => socket.request.headers[field], throw: (code, message) => {
+                    throw new Error(message);
+                }, 
+                // Needed for koa-useragent middleware
+                headers: socket.request.headers, header: socket.request.headers, 
+                // We don't really care about the path since it will never contain
+                // an app ID
+                path: "/socket" });
+            // Run all koa middlewares
+            try {
+                for (let [idx, middleware] of middlewares.entries()) {
+                    yield middleware(ctx, () => {
+                        if (idx === middlewares.length - 1) {
+                            // Middlewares are finished.
+                            // Extract some data from our enriched koa context to persist
+                            // as metadata for the socket
+                            socket.data.user = {
+                                id: ctx.user._id,
+                                email: ctx.user.email,
+                            };
+                            next();
+                        }
+                    });
+                }
+            }
+            catch (error) {
+                next(error);
+            }
+        }));
+    }
+    // Emit an event to all sockets
+    emit(event, payload) {
+        this.io.sockets.emit(event, payload);
+    }
+}
+exports.default = Socket;

package/jest.config.ts

@@ -20,9 +20,9 @@ const baseConfig: Config.InitialProjectOptions = {
 }
 
 // add pro sources if they exist
-if (fs.existsSync("../../../budibase-pro")) {
-  baseConfig.moduleNameMapper["@budibase/pro"] =
-    "<rootDir>/../../../budibase-pro/packages/pro/src"
+if (fs.existsSync("../pro/packages")) {
+  baseConfig.moduleNameMapper!["@budibase/pro"] =
+    "<rootDir>/../pro/packages/pro/src"
 }
 
 const config: Config.InitialOptions = {

package/nodemon.json

@@ -1,6 +1,10 @@
 {
-  "watch": ["src", "../backend-core", "../../../budibase-pro/packages/pro"],
+  "watch": ["src", "../backend-core", "../pro/packages/pro"],
   "ext": "js,ts,json",
-  "ignore": ["src/**/*.spec.ts", "src/**/*.spec.js", "../backend-core/dist/**/*"],
+  "ignore": [
+    "src/**/*.spec.ts",
+    "src/**/*.spec.js",
+    "../backend-core/dist/**/*"
+  ],
   "exec": "ts-node src/index.ts"
-}
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/server",
   "email": "hi@budibase.com",
-  "version": "2.5.6-alpha.6",
+  "version": "2.5.6-alpha.8",
   "description": "Budibase Web Server",
   "main": "src/index.ts",
   "repository": {
@@ -45,12 +45,12 @@
   "license": "GPL-3.0",
   "dependencies": {
     "@apidevtools/swagger-parser": "10.0.3",
-    "@budibase/backend-core": "2.5.6-alpha.6",
-    "@budibase/client": "2.5.6-alpha.6",
-    "@budibase/pro": "2.5.6-alpha.5",
-    "@budibase/shared-core": "2.5.6-alpha.6",
-    "@budibase/string-templates": "2.5.6-alpha.6",
-    "@budibase/types": "2.5.6-alpha.6",
+    "@budibase/backend-core": "2.5.6-alpha.8",
+    "@budibase/client": "2.5.6-alpha.8",
+    "@budibase/pro": "2.5.6-alpha.6",
+    "@budibase/shared-core": "2.5.6-alpha.8",
+    "@budibase/string-templates": "2.5.6-alpha.8",
+    "@budibase/types": "2.5.6-alpha.8",
     "@bull-board/api": "3.7.0",
     "@bull-board/koa": "3.9.4",
     "@elastic/elasticsearch": "7.10.0",
@@ -65,6 +65,7 @@
     "bull": "4.10.1",
     "chmodr": "1.2.0",
     "chokidar": "3.5.3",
+    "cookies": "0.8.0",
     "csvtojson": "2.0.10",
     "curlconverter": "3.21.0",
     "dd-trace": "3.13.2",
@@ -108,7 +109,7 @@
     "redis": "4",
     "server-destroy": "1.0.1",
     "snowflake-promise": "^4.5.0",
-    "socket.io": "^4.5.1",
+    "socket.io": "4.6.1",
     "svelte": "3.49.0",
     "swagger-parser": "10.0.3",
     "tar": "6.1.11",
@@ -175,5 +176,5 @@
   "optionalDependencies": {
     "oracledb": "5.3.0"
   },
-  "gitHead": "38e1d3a3a0a70b4a55b3a1a790d46151057af3c2"
+  "gitHead": "e87d1692c387c3a26ecf37b07e69dc39c403e224"
 }

package/src/api/controllers/plugin/index.ts

@@ -2,7 +2,7 @@ import { npmUpload, urlUpload, githubUpload } from "./uploaders"
 import { plugins as pluginCore } from "@budibase/backend-core"
 import { PluginType, FileType, PluginSource } from "@budibase/types"
 import env from "../../../environment"
-import { ClientAppSocket } from "../../../websocket"
+import { clientAppSocket } from "../../../websockets"
 import sdk from "../../../sdk"
 import { sdk as pro } from "@budibase/pro"
 
@@ -71,7 +71,7 @@ export async function create(ctx: any) {
 
     const doc = await pro.plugins.storePlugin(metadata, directory, source)
 
-    ClientAppSocket.emit("plugins-update", { name, hash: doc.hash })
+    clientAppSocket.emit("plugins-update", { name, hash: doc.hash })
     ctx.body = {
       message: "Plugin uploaded successfully",
       plugins: [doc],

package/src/api/controllers/table/utils.ts

@@ -124,7 +124,8 @@ export function importToRows(
     for (const [fieldName, schema] of Object.entries(table.schema)) {
       // check whether the options need to be updated for inclusion as part of the data import
       if (
-        schema.type === FieldTypes.OPTIONS &&
+        (schema.type === FieldTypes.OPTIONS ||
+          schema.type === FieldTypes.ARRAY) &&
         row[fieldName] &&
         (!schema.constraints!.inclusion ||
           schema.constraints!.inclusion.indexOf(row[fieldName]) === -1)

package/src/app.ts

@@ -15,8 +15,8 @@ import * as api from "./api"
 import * as automations from "./automations"
 import { Thread } from "./threads"
 import * as redis from "./utilities/redis"
+import { initialise as initialiseWebsockets } from "./websockets"
 import { events, logging, middleware, timers } from "@budibase/backend-core"
-import { initialise as initialiseWebsockets } from "./websocket"
 import { startup } from "./startup"
 const Sentry = require("@sentry/node")
 const destroyable = require("server-destroy")
@@ -61,7 +61,7 @@ if (env.isProd()) {
 
 const server = http.createServer(app.callback())
 destroyable(server)
-initialiseWebsockets(server)
+initialiseWebsockets(app, server)
 
 let shuttingDown = false,
   errCode = 0

package/src/sdk/plugins/plugins.ts

@@ -7,7 +7,7 @@ import {
 } from "@budibase/backend-core"
 import { fileUpload } from "../../api/controllers/plugin/file"
 import env from "../../environment"
-import { ClientAppSocket } from "../../websocket"
+import { clientAppSocket } from "../../websockets"
 import { sdk as pro } from "@budibase/pro"
 
 export async function fetch(type?: PluginType) {
@@ -36,6 +36,6 @@ export async function processUploaded(plugin: FileType, source?: PluginSource) {
   }
 
   const doc = await pro.plugins.storePlugin(metadata, directory, source)
-  ClientAppSocket.emit("plugin-update", { name: doc.name, hash: doc.hash })
+  clientAppSocket.emit("plugin-update", { name: doc.name, hash: doc.hash })
   return doc
 }

package/src/websockets/client.ts

@@ -0,0 +1,11 @@
+import Socket from "./websocket"
+import authorized from "../middleware/authorized"
+import http from "http"
+import Koa from "koa"
+import { permissions } from "@budibase/backend-core"
+
+export default class ClientAppWebsocket extends Socket {
+  constructor(app: Koa, server: http.Server) {
+    super(app, server, "/socket/client", [authorized(permissions.BUILDER)])
+  }
+}

package/src/websockets/grid.ts

@@ -0,0 +1,55 @@
+import authorized from "../middleware/authorized"
+import Socket from "./websocket"
+import { permissions } from "@budibase/backend-core"
+import http from "http"
+import Koa from "koa"
+
+export default class GridSocket extends Socket {
+  constructor(app: Koa, server: http.Server) {
+    super(app, server, "/socket/grid", [authorized(permissions.BUILDER)])
+
+    this.io.on("connection", socket => {
+      const user = socket.data.user
+      console.log(`Spreadsheet user connected: ${user?.id}`)
+
+      // Socket state
+      let currentRoom: string
+
+      // Initial identification of connected spreadsheet
+      socket.on("select-table", async (tableId, callback) => {
+        // Leave current room
+        if (currentRoom) {
+          socket.to(currentRoom).emit("user-disconnect", socket.data.user)
+          socket.leave(currentRoom)
+        }
+
+        // Join new room
+        currentRoom = tableId
+        socket.join(currentRoom)
+        socket.to(currentRoom).emit("user-update", socket.data.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
+        if (currentRoom) {
+          socket.to(currentRoom).emit("user-update", socket.data.user)
+        }
+      })
+
+      // Disconnection cleanup
+      socket.on("disconnect", () => {
+        if (currentRoom) {
+          socket.to(currentRoom).emit("user-disconnect", socket.data.user)
+        }
+      })
+    })
+  }
+}

package/src/websockets/index.ts

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

package/src/websockets/websocket.ts

@@ -0,0 +1,83 @@
+import { Server } from "socket.io"
+import http from "http"
+import Koa from "koa"
+import Cookies from "cookies"
+import { userAgent } from "koa-useragent"
+import { auth } from "@budibase/backend-core"
+import currentApp from "../middleware/currentapp"
+
+export default class Socket {
+  io: Server
+
+  constructor(
+    app: Koa,
+    server: http.Server,
+    path: string,
+    additionalMiddlewares?: any[]
+  ) {
+    this.io = new Server(server, {
+      path,
+    })
+
+    // Attach default middlewares
+    const authenticate = auth.buildAuthMiddleware([], {
+      publicAllowed: true,
+    })
+    const middlewares = [
+      userAgent,
+      authenticate,
+      currentApp,
+      ...(additionalMiddlewares || []),
+    ]
+
+    // Apply middlewares
+    this.io.use(async (socket, next) => {
+      // Build fake koa context
+      const res = new http.ServerResponse(socket.request)
+      const ctx: any = {
+        ...app.createContext(socket.request, res),
+
+        // Additional overrides needed to make our middlewares work with this
+        // fake koa context
+        cookies: new Cookies(socket.request, res),
+        get: (field: string) => socket.request.headers[field],
+        throw: (code: number, message: string) => {
+          throw new Error(message)
+        },
+
+        // Needed for koa-useragent middleware
+        headers: socket.request.headers,
+        header: socket.request.headers,
+
+        // We don't really care about the path since it will never contain
+        // an app ID
+        path: "/socket",
+      }
+
+      // Run all koa middlewares
+      try {
+        for (let [idx, middleware] of middlewares.entries()) {
+          await middleware(ctx, () => {
+            if (idx === middlewares.length - 1) {
+              // Middlewares are finished.
+              // Extract some data from our enriched koa context to persist
+              // as metadata for the socket
+              socket.data.user = {
+                id: ctx.user._id,
+                email: ctx.user.email,
+              }
+              next()
+            }
+          })
+        }
+      } catch (error: any) {
+        next(error)
+      }
+    })
+  }
+
+  // Emit an event to all sockets
+  emit(event: string, payload: any) {
+    this.io.sockets.emit(event, payload)
+  }
+}

package/tsconfig.json

@@ -10,19 +10,13 @@
       "@budibase/backend-core": ["../backend-core/src"],
       "@budibase/backend-core/*": ["../backend-core/*"],
       "@budibase/shared-core": ["../shared-core/src"],
-      "@budibase/pro": ["../../../budibase-pro/packages/pro/src"]
+      "@budibase/pro": ["../pro/packages/pro/src"]
     }
   },
   "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", "package.json"],
   "exclude": ["node_modules", "dist"]
 }