nestjs-real-time

WebSocket Gateway with Auth Example

Protocol Selection

WebSockets (Bi-directional): Use for Chat, Multiplayer Games, Collaborative Editing.
High Complexity: Requires custom scaling (Redis Adapter) and sticky sessions (sometimes).
Server-Sent Events (SSE) (Uni-directional): Use for Notifications, Live Feeds, Tickers, CI Log streaming.
Low Complexity: Standard HTTP. Works with standard Load Balancers. Easy to secure.
NestJS: Use @Sse('route') returning Observable<MessageEvent>.
Long Polling: Use only as fallback or for extremely low-frequency updates (e.g., job status check every 10m).
Impact: High header overhead. Blocks threads if not handled carefully.

WebSockets Implementation

Socket.io: Default choice. Features "Rooms", "Namespaces", and automatic reconnection. Heavy protocol.
Fastify/WS: Use ws adapter if performance critical (e.g., high-frequency trading updates) and you don't need "Rooms" logic.

Scaling (Critical)

WebSockets: In K8s, client connects to Pod . If Pod B emits event, client won't receive it.
Solution: Redis Adapter (@socket.io/redis-adapter). Every pod publishes to Redis; Redis distributes to all other pods.
SSE: Stateless. No special adapter needed, but aware of Connection Limits (6 concurrent connections per domain in HTTP/1.1; virtually unlimited in HTTP/2).
Rule: Must use HTTP/2 for SSE at scale.

Security

Handshake Auth: Standard HTTP Guards don't trigger on Ws connection efficiently.
Pattern: Validate JWT during handleConnection() lifecycle method. Disconnect immediately if invalid.
Rate Limiting: Sockets expensive. Apply strict throttling on "Message" events to prevent flooding.

Architecture

Gateway != Service: WebSocketGateway should only handle client comms (Join Room, Ack message).
Rule: Delegate business logic to Service or Command Bus.
Events: Use AsyncApi or SocketApi decorators (from community packages) to document WS events similarly to OpenAPI.

Anti-Patterns

No HTTP guards for WebSocket auth: Validate JWT in handleConnection(); HTTP guards don't trigger on WS.
No WebSocket at scale without Redis adapter: Without @socket.io/redis-adapter, cross-pod events lost.
No SSE over HTTP/1.1 at scale: Use HTTP/2 to avoid 6-connection-per-domain browser limit.

Plus depuis ce dépôt

même dépôt

context7

Retrieves up-to-date documentation, API references, and code examples for any developer technology. Use this skill whenever the user asks about a specific library, framework, SDK, CLI tool, or cloud service -- even for well-known ones like React, Next.js, Prisma, Express, Tailwind, Django, or Spring Boot. Your training data may not reflect recent API changes or version updates. Always use for: API syntax questions, configuration options, version migration issues, "how do I" questions mentioning a library name, debugging that involves library-specific behavior, setup instructions, and CLI tool usage. Use even when you think you know the answer -- do not rely on training data for API details, signatures, or configuration options as they are frequently outdated. Always verify against current docs. Prefer this over web search for library documentation and API details.

2026-07-022

refactor-plan

Create a concrete plan before starting a multi-file refactor. Use when the user asks to plan, sequence, scope, or safely execute a refactor across multiple files; always investigate first, output the plan, and wait for confirmation before making code changes.

2026-07-022

react-native-design

Master React Native styling, navigation, and Reanimated animations for cross-platform mobile development. Use when building React Native apps, implementing navigation patterns, or creating performant animations.

react-native-optimizations

Provides React Native performance optimization guidelines for FPS, TTI, bundle size, memory leaks, re-renders, and animations. Applies to tasks involving Hermes optimization, JS thread blocking, bridge overhead, FlashList, native modules, or debugging jank and frame drops.

flutter-app

Design Flutter applications to scale by strictly adhering to architectural principles: enforce separation of concerns, maintain single source of truth, implement unidirectional data flow, and treat UI as a function of state. Use when structuring layers, implementing data layer with services and repositories, or following feature implementation workflow.

shadcn-ui-flutter

A comprehensive Flutter UI library inspired by shadcn/ui. Provides high-quality, customizable, and accessible components including Buttons, Cards, Forms, and more. Use this skill when building Flutter UIs, implementing design systems, or needing specific component usage examples.

name	nestjs-real-time
description	Implement WebSocket gateways with Socketio and Server-Sent Events endpoints in NestJS. Use when building chat features, live feeds, or choosing between WebSocket and SSE for real-time communication.
license	MIT
version	1.0.0
author	[Filippo De Silva](https://github.com/FilippoDeSilva)
tags	["nestjs","real-time","websocket","sse","socketio","fastify"]
metadata	{"triggers":{"files":["*/.gateway.ts","*/.controller.ts","Socket.io"],"keywords":["WebSocketGateway","SubscribeMessage","Sse"]}}

Real-Time & WebSockets

Priority: P1 (OPERATIONAL)

Workflow: Add Real-Time Feature

Choose protocol — WebSocket for bi-directional (chat, collab); SSE for uni-directional (feeds, notifications).
Implement gateway or SSE — Create @WebSocketGateway() or @Sse() controller.
Add auth — Validate JWT in handleConnection() for WebSocket; use standard guards for SSE.
Scale — Add @socket.io/redis-adapter for multi-pod WebSocket; use HTTP/2 for SSE.
Test connections — Verify WebSocket handshake auth rejects invalid tokens; confirm SSE streams data.

SSE Endpoint Example

WebSocket Gateway with Auth Example