payload-socket-plugin 1.1.4 → 1.1.5

package/README.md

@@ -434,6 +434,43 @@ import type {
 - Check that your `tsconfig.json` includes the plugin's types
 - Verify Payload CMS version compatibility (>= 2.0.0)
 
+## Multi-Instance Deployments with Redis
+
+When using Redis adapter for multi-instance deployments, user data is automatically synchronized across all server instances:
+
+- **`socket.data.user`**: Automatically synchronized across servers via Redis adapter
+- **`socket.user`**: Only available on the local server where the socket connected (backward compatibility)
+
+### Accessing User Data in Custom Handlers
+
+```typescript
+socketPlugin({
+  onSocketConnection: (socket, io, payload) => {
+    socket.on("get-active-users", async (roomName) => {
+      const sockets = await io.in(roomName).fetchSockets();
+
+      const users = sockets.map((s) => {
+        // Use socket.data.user for Redis compatibility (works across all servers)
+        // Fallback to socket.user for local connections
+        const user = s.data.user || (s as any).user;
+        return {
+          id: user?.id,
+          email: user?.email,
+        };
+      });
+
+      socket.emit("active-users", users);
+    });
+  },
+});
+```
+
+**Important**: When using `io.in(room).fetchSockets()` with Redis adapter:
+
+- Remote sockets (from other servers) will have `socket.data.user` populated
+- Local sockets will have both `socket.data.user` and `socket.user` populated
+- Always check `socket.data.user` first for Redis compatibility
+
 ## Performance Considerations
 
 - **Redis**: Highly recommended for production multi-instance deployments

package/dist/socketManager.js

@@ -100,13 +100,17 @@ class SocketIOManager {
                     if (!userDoc) {
                         return next(new Error("User not found"));
                     }
-                    // Attach user info
-                    socket.user = {
+                    const userInfo = {
                         id: userDoc.id,
                         email: userDoc.email,
                         collection: decoded.collection || "users",
                         role: userDoc.role,
                     };
+                    // Store in socket.data for Redis adapter compatibility
+                    // socket.data is automatically synchronized across servers via Redis
+                    socket.data.user = userInfo;
+                    // Also attach to socket.user for backward compatibility
+                    socket.user = userInfo;
                     next();
                 }
                 catch (jwtError) {
@@ -190,8 +194,10 @@ class SocketIOManager {
                 const sockets = await this.io.in(room).fetchSockets();
                 for (const socket of sockets) {
                     const authSocket = socket;
-                    if (authSocket.user) {
-                        const isAuthorized = await collectionHandler(authSocket.user, finalEvent);
+                    // Use socket.data.user for remote sockets (Redis adapter), fallback to socket.user for local
+                    const user = socket.data.user || authSocket.user;
+                    if (user) {
+                        const isAuthorized = await collectionHandler(user, finalEvent);
                         if (isAuthorized) {
                             socket.emit("payload:event", finalEvent);
                         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payload-socket-plugin",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "description": "Real-time Socket.IO plugin for Payload CMS with Redis support",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",