NestJS Enterprise Backend APIs · Aula

Escalando o Tempo Real com um Adaptador Redis Pub/Sub

Sincronize o estado dos sockets entre várias instâncias usando o IoAdapter do Redis para escalabilidade horizontal.

Escalando o Tempo Real com um Adaptador Redis Pub/Sub é uma aula grátis de NestJS Enterprise Backend APIs no CoddyKit. Esta é a aula 4 de 4. Você pode ler a aula completa abaixo gratuitamente — depois pratica ao vivo no navegador com um editor de código integrado e um tutor de IA 24/7. Faz parte do caminho de aprendizado de NestJS Enterprise Backend APIs, e seu progresso é sincronizado entre a web e o app CoddyKit. O curso de NestJS Enterprise Backend APIs inclui 4 aulas no total.

Partes desta aula ainda não foram traduzidas e aparecem em inglês.

The Multi-Instance Problem

A single NestJS WebSocket gateway keeps every connected socket in the memory of one Node process. The moment you scale horizontally behind a load balancer, that assumption breaks.

Client A connects to instance 1.
Client B connects to instance 2.
When instance 1 emits to a room, instance 2 never hears about it — so Client B misses the message.

To fix this we need a shared message bus that lets every instance broadcast events to every other instance. Redis Pub/Sub is the canonical choice, and Socket.IO ships an adapter for exactly this.

How the Redis Adapter Works

The @socket.io/redis-adapter replaces Socket.IO's in-memory adapter. Whenever your code calls server.to(room).emit(...), the adapter publishes that event to a Redis channel instead of only delivering it locally.

Every instance subscribes to the same Redis channels.
An emit on instance 1 is published to Redis, then every subscribed instance (including instance 2) receives it and delivers it to its own local sockets.
Redis is only a relay — socket connections still live on each node; no socket state is stored in Redis.

This means room membership, broadcasts, and even server.emit() fan out correctly across the whole cluster.

Installing the Pieces

You need three packages: a Redis client (ioredis or the official redis client), the Socket.IO Redis adapter, and Socket.IO itself (already pulled in by @nestjs/platform-socket.io).

The adapter needs two Redis connections: one pubClient for publishing and one subClient for subscribing. A connection in subscribe mode cannot issue normal commands, which is why they must be separate.

// package.json dependencies (excerpt)
{
  "dependencies": {
    "@nestjs/platform-socket.io": "^11.0.0",
    "@nestjs/websockets": "^11.0.0",
    "@socket.io/redis-adapter": "^8.3.0",
    "socket.io": "^4.7.0",
    "ioredis": "^5.4.0"
  }
}

A Custom IoAdapter

NestJS wraps Socket.IO behind an IoAdapter class. To inject the Redis adapter, you subclass IoAdapter and override createIOServer so that every namespace server is given the Redis adapter via server.adapter(...).

connectToRedis() creates the duplicated pub/sub clients once at bootstrap.
createIOServer() attaches the adapter created by createAdapter(pubClient, subClient).

This is the central piece of the whole lesson.

// redis-io.adapter.ts
import { IoAdapter } from '@nestjs/platform-socket.io';
import { ServerOptions } from 'socket.io';
import { createAdapter } from '@socket.io/redis-adapter';
import { Redis } from 'ioredis';

export class RedisIoAdapter extends IoAdapter {
  private adapterConstructor: ReturnType<typeof createAdapter>;

  async connectToRedis(url: string): Promise<void> {
    const pubClient = new Redis(url);
    const subClient = pubClient.duplicate();
    this.adapterConstructor = createAdapter(pubClient, subClient);
  }

  createIOServer(port: number, options?: ServerOptions): any {
    const server = super.createIOServer(port, options);
    server.adapter(this.adapterConstructor);
    return server;
  }
}

Wiring It at Bootstrap

The adapter must be connected to Redis before the app starts listening, and registered with app.useWebSocketAdapter(). Do this in main.ts.

Instantiate RedisIoAdapter with the app instance.
await the Redis connection so a failure aborts startup cleanly.
Register it, then call app.listen().

// main.ts
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { RedisIoAdapter } from './redis-io.adapter';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  const redisIoAdapter = new RedisIoAdapter(app);
  await redisIoAdapter.connectToRedis(
    process.env.REDIS_URL ?? 'redis://localhost:6379',
  );
  app.useWebSocketAdapter(redisIoAdapter);

  await app.listen(3000);
}
bootstrap();

The Gateway Stays Unchanged

The beauty of this approach: your @WebSocketGateway code does not change at all. You keep using server.to(room).emit() and the adapter transparently fans it out across instances.

Join a room with client.join(room) as usual.
Broadcast with this.server.to(room).emit(event, payload).

The same gateway now works whether you run 1 or 50 replicas.

// chat.gateway.ts
import {
  WebSocketGateway,
  WebSocketServer,
  SubscribeMessage,
  MessageBody,
  ConnectedSocket,
} from '@nestjs/websockets';
import { Server, Socket } from 'socket.io';

@WebSocketGateway({ cors: { origin: '*' } })
export class ChatGateway {
  @WebSocketServer() server: Server;

  @SubscribeMessage('joinRoom')
  onJoin(@ConnectedSocket() client: Socket, @MessageBody() room: string) {
    client.join(room);
    return { joined: room };
  }

  @SubscribeMessage('sendMessage')
  onMessage(@MessageBody() data: { room: string; text: string }) {
    // Fans out to every instance thanks to the Redis adapter
    this.server.to(data.room).emit('message', data.text);
  }
}

Sticky Sessions vs. Polling

The Redis adapter fixes broadcasting, but it does not fix the HTTP long-polling handshake. With multiple instances, Socket.IO's polling transport sends several HTTP requests during the upgrade; if those requests hit different instances, the handshake fails.

Option A: Enable sticky sessions on the load balancer so a client always reaches the same instance.
Option B: Force the WebSocket transport only, skipping polling entirely.

Most production setups enable sticky sessions at the ingress/load balancer layer.

// Force WebSocket-only to sidestep multi-request polling handshakes
@WebSocketGateway({
  transports: ['websocket'],
  cors: { origin: '*' },
})
export class ChatGateway {}

Graceful Reconnection of the Bus

If Redis goes down, the adapter cannot relay events between instances. With ioredis you get automatic reconnection out of the box, but you should log and observe failures so you know broadcasts are degraded.

Attach listeners to both pub and sub clients.
A retryStrategy lets you cap backoff and avoid hammering Redis.

// redis-io.adapter.ts (hardened connect)
async connectToRedis(url: string): Promise<void> {
  const pubClient = new Redis(url, {
    retryStrategy: (times) => Math.min(times * 100, 3000),
  });
  const subClient = pubClient.duplicate();

  for (const client of [pubClient, subClient]) {
    client.on('error', (err) => console.error('Redis adapter error', err));
    client.on('reconnecting', () => console.warn('Redis adapter reconnecting'));
  }

  this.adapterConstructor = createAdapter(pubClient, subClient);
}

Reasoning About Fan-Out Cost

Every cross-instance emit becomes Redis traffic. Understanding the fan-out helps you size Redis. A pure standalone calculation makes the scaling intuition concrete: if each broadcast must reach N instances, Redis relays roughly one publish that N−1 other instances consume.

The snippet below is a plain TypeScript program estimating published messages per second across a cluster — no framework or Redis needed to run it.

// Estimate Redis pub/sub relay load for a cluster
function relayLoad(
  instances: number,
  broadcastsPerSecPerInstance: number,
): { publishes: number; deliveries: number } {
  const publishes = instances * broadcastsPerSecPerInstance;
  // each publish is consumed by the other (instances - 1) nodes
  const deliveries = publishes * (instances - 1);
  return { publishes, deliveries };
}

const scenarios = [
  { instances: 2, rate: 100 },
  { instances: 10, rate: 100 },
  { instances: 50, rate: 100 },
];

for (const s of scenarios) {
  const { publishes, deliveries } = relayLoad(s.instances, s.rate);
  console.log(
    `${s.instances} instances -> ${publishes} publishes/s, ${deliveries} deliveries/s`,
  );
}

Targeting Specific Sockets Across Nodes

Beyond rooms, the Redis adapter also supports cluster-wide operations Socket.IO exposes on the server object:

server.fetchSockets() returns socket info from all instances.
server.in(socketId).disconnectSockets() can disconnect a socket living on another node.
server.socketsJoin(room) / socketsLeave(room) move sockets cluster-wide.

These are async because they round-trip through Redis to reach remote instances.

// admin.gateway.ts
@SubscribeMessage('kick')
async onKick(@MessageBody() socketId: string) {
  // Works even if that socket is connected to another instance
  const remoteSockets = await this.server.in(socketId).fetchSockets();
  for (const s of remoteSockets) {
    s.emit('kicked', { reason: 'admin action' });
    s.disconnect(true);
  }
}

Redis Pub/Sub vs. Streams Adapter

Socket.IO offers two Redis-based adapters with different delivery guarantees:

Pub/Sub adapter (@socket.io/redis-adapter): fire-and-forget. If an instance is briefly disconnected from Redis, it misses messages during that window. Lowest latency, simplest.
Streams adapter (@socket.io/redis-streams-adapter): uses Redis Streams so a reconnecting instance can replay missed messages. Slightly more overhead but better for at-least-once needs.

For typical chat/notification fan-out, the Pub/Sub adapter is the default recommendation. Choose Streams when missed broadcasts during a blip are unacceptable.

Quick Check: Why Two Clients?

The Redis adapter requires a separate pubClient and subClient. Why can't you reuse a single Redis connection for both?

Recap

You learned how to scale a NestJS realtime app horizontally with a Redis Pub/Sub adapter:

In-memory Socket.IO state does not span instances — Redis Pub/Sub relays broadcasts across the cluster.
Subclass IoAdapter, connect a pubClient and subClient, and attach createAdapter(...) in createIOServer.
Register it in main.ts with app.useWebSocketAdapter() before listen(); your gateway code stays unchanged.
Enable sticky sessions (or force the WebSocket transport) so the polling handshake survives load balancing.
Cluster-wide ops like fetchSockets() and disconnectSockets() round-trip through Redis.
Choose the Streams adapter instead when you need replay of broadcasts missed during a Redis blip.

Perguntas Frequentes

A aula “Escalando o Tempo Real com um Adaptador Redis Pub/Sub” é grátis?

Sim — o texto completo de “Escalando o Tempo Real com um Adaptador Redis Pub/Sub” é grátis para ler aqui na web. Para praticá-la interativamente (um editor de código integrado e um tutor de IA 24/7) e desbloquear o restante do curso de NestJS Enterprise Backend APIs, atualize para CoddyKit PRO. O curso de NestJS Enterprise Backend APIs inclui 4 aulas no total.

O que vou aprender em “Escalando o Tempo Real com um Adaptador Redis Pub/Sub”?

Sincronize o estado dos sockets entre várias instâncias usando o IoAdapter do Redis para escalabilidade horizontal. Você pratica NestJS Enterprise Backend APIs com código prático que executa diretamente no navegador, e um tutor de IA 24/7 responde suas dúvidas enquanto trabalha na aula.

Preciso ter experiência prévia para começar NestJS Enterprise Backend APIs?

Nenhuma experiência prévia é necessária. NestJS Enterprise Backend APIs no CoddyKit é estruturado para alunos iniciantes até avançados, então você pode começar aqui ou desde o início e aprender no seu ritmo. Esta é a aula 4 de 4.

Quanto tempo leva a aula “Escalando o Tempo Real com um Adaptador Redis Pub/Sub”?

A maioria das aulas CoddyKit leva cerca de 5–10 minutos. Cada uma é compacta e interativa, então você faz progresso constante e retoma exatamente de onde parou entre web e app.

Posso escrever e executar código nesta aula de NestJS Enterprise Backend APIs?

Sim. Cada aula de NestJS Enterprise Backend APIs inclui um editor de código integrado, então você escreve e executa código real direto no navegador e recebe feedback de IA instantaneamente — nenhuma configuração local necessária.

Todas as aulas deste curso

Gateways WebSocket com o Adaptador Socket.IO
Autenticando e Protegendo Conexões Socket
Eventos Enviados pelo Servidor para Envio Unidirecional
Escalando o Tempo Real com um Adaptador Redis Pub/Sub

← Voltar para NestJS Enterprise Backend APIs