@budibase/server 2.5.6-alpha.3 → 2.5.6-alpha.31

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.build.json

@@ -8,13 +8,11 @@
     "esModuleInterop": true,
     "resolveJsonModule": true,
     "incremental": true,
-    "types": [ "node", "jest" ],
-    "outDir": "dist",
+    "types": ["node", "jest"],
+    "outDir": "dist/src",
     "skipLibCheck": true
   },
-  "include": [
-    "src/**/*"
-  ],
+  "include": ["src/**/*"],
   "exclude": [
     "node_modules",
     "dist",

package/tsconfig.json

@@ -5,6 +5,7 @@
     "declaration": true,
     "sourceMap": true,
     "baseUrl": ".",
+    "outDir": "dist",
     "paths": {
       "@budibase/types": ["../types/src"],
       "@budibase/backend-core": ["../backend-core/src"],
@@ -23,6 +24,6 @@
     { "path": "../shared-core" },
     { "path": "../../../budibase-pro/packages/pro" }
   ],
-  "include": ["src/**/*", "specs", "package.json"],
+  "include": ["src/**/*", "specs"],
   "exclude": ["node_modules", "dist"]
 }