Socket.io Summary and Complete Guide Real-Time Node.js Applications

Socket.io Summary and Complete Guide

This is a complete summary of everything you need to know about Socket.io in Node.js.

Complete Setup Checklist

• socket.io installed on server
• socket.io-client installed on frontend
• HTTP server created from Express app
• Socket.io initialized with CORS config
• JWT authentication middleware
• Connection and disconnection handlers
• Online users tracking (Map)
• Event handlers (join, message, typing)
• Room management (deterministic room IDs)
• Input validation on all events
• Rate limiting
• Error handling with acknowledgments
• Redis adapter for multi-instance scaling
• PM2 cluster mode with Redis adapter
• Nginx WebSocket proxy configuration
• HTTPS/WSS in production

Architecture Summary

Frontend (React)
  ↓ socket.io-client connects with JWT auth
Socket.io Server (Node.js)
  ↓ JWT authentication middleware
  ↓ Connection handler
  ↓ Room management
  ↓ Event handlers (message, typing, presence)
Redis (for multi-instance scaling)
  ↓ Pub/sub for cross-instance broadcasting
MongoDB
  ↓ Message persistence
Nginx
  ↓ WebSocket proxy with Upgrade headers

Code Template

// Server
const http = require("http");
const socketio = require("socket.io");
const { createAdapter } = require("@socket.io/redis-adapter");
const { createClient } = require("redis");

const app = require("./app");
const server = http.createServer(app);

const io = socketio(server, {
  cors: { origin: process.env.CLIENT_URL, credentials: true },
  transports: ["websocket"]
});

// Redis adapter
const pubClient = createClient({ url: process.env.REDIS_URL });
const subClient = pubClient.duplicate();
await Promise.all([pubClient.connect(), subClient.connect()]);
io.adapter(createAdapter(pubClient, subClient));

// Auth middleware
io.use(async (socket, next) => {
  const token = socket.handshake.auth.token;
  const decoded = jwt.verify(token, process.env.JWT_SECRET);
  socket.user = await User.findById(decoded._id);
  socket.userId = socket.user._id.toString();
  next();
});

const onlineUsers = new Map();

io.on("connection", (socket) => {
  onlineUsers.set(socket.userId, socket.id);
  io.emit("user:online", { userId: socket.userId });
  
  socket.on("join:chat", ({ targetUserId }) => {
    const roomId = [socket.userId, targetUserId].sort().join("_");
    socket.join(roomId);
  });
  
  socket.on("message:send", async ({ targetUserId, text }, ack) => {
    try {
      const message = await Message.create({
        senderId: socket.userId, receiverId: targetUserId, text
      });
      const roomId = [socket.userId, targetUserId].sort().join("_");
      io.to(roomId).emit("message:received", message);
      ack({ success: true });
    } catch (err) {
      ack({ success: false, error: err.message });
    }
  });
  
  socket.on("disconnect", () => {
    onlineUsers.delete(socket.userId);
    io.emit("user:offline", { userId: socket.userId });
  });
});

server.listen(process.env.PORT || 3000);

Client Template

import { io } from "socket.io-client";

const socket = io(process.env.VITE_SOCKET_URL, {
  withCredentials: true,
  auth: { token: getCookie("token") },
  transports: ["websocket"]
});

socket.on("connect", () => {
  console.log("Connected:", socket.id);
});

socket.on("message:received", (message) => {
  // Display message
});

socket.on("user:online", ({ userId }) => {
  // Update online status
});

// Send message with acknowledgment
socket.emit("message:send", { targetUserId, text }, (response) => {
  if (response.success) {
    console.log("Sent!");
  }
});

The Takeaway

Socket.io provides real-time, bidirectional communication for Node.js. The key components are: JWT authentication middleware, room management with deterministic IDs, event handlers for messages and typing, online user tracking, Redis adapter for multi-instance scaling, PM2 cluster mode, Nginx WebSocket proxy, input validation, rate limiting, and error handling with acknowledgments. This stack powers real-time chat, notifications, and presence for the DevTinder application.