Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | 'use client';
/**
* useSocket Hook
*
* Client-side WebSocket connection hook with automatic authentication,
* reconnection, and typed event handling.
*/
import { useEffect, useRef, useState, useCallback, useSyncExternalStore } from 'react';
import { io, Socket } from 'socket.io-client';
import { useSession } from 'next-auth/react';
import type {
ServerToClientEvents,
ClientToServerEvents,
ConnectionStatus,
} from '@/lib/socket/types';
// Typed Socket.IO client
type TypedSocket = Socket<ServerToClientEvents, ClientToServerEvents>;
export interface UseSocketOptions {
/** Whether socket connection is enabled (default: true) */
enabled?: boolean;
/** Auto-connect when authenticated (default: true) */
autoConnect?: boolean;
/** Maximum reconnection attempts (default: 5) */
reconnectionAttempts?: number;
/** Initial reconnection delay in ms (default: 1000) */
reconnectionDelay?: number;
/** Maximum reconnection delay in ms (default: 5000) */
reconnectionDelayMax?: number;
}
export interface UseSocketReturn {
/** Socket instance (null if not connected) */
socket: TypedSocket | null;
/** Connection status */
status: ConnectionStatus;
/** Whether currently connected */
isConnected: boolean;
/** Connection error if any */
error: Error | null;
/** Subscribe to channels */
subscribe: (channels: string[]) => void;
/** Unsubscribe from channels */
unsubscribe: (channels: string[]) => void;
/** Add event listener - returns cleanup function */
on: <K extends keyof ServerToClientEvents>(
event: K,
handler: ServerToClientEvents[K]
) => () => void;
/** Manually connect */
connect: () => void;
/** Manually disconnect */
disconnect: () => void;
/** Reconnection attempt count */
reconnectAttempts: number;
}
const DEFAULT_OPTIONS: Required<UseSocketOptions> = {
enabled: true,
autoConnect: true,
reconnectionAttempts: 5,
reconnectionDelay: 1000,
reconnectionDelayMax: 5000,
};
export function useSocket(options: UseSocketOptions = {}): UseSocketReturn {
const opts = { ...DEFAULT_OPTIONS, ...options };
const { data: session, status: authStatus } = useSession();
const socketRef = useRef<TypedSocket | null>(null);
const [status, setStatus] = useState<ConnectionStatus>('disconnected');
const [error, setError] = useState<Error | null>(null);
const [reconnectAttempts, setReconnectAttempts] = useState(0);
// Use useSyncExternalStore to safely expose the socket ref value
// This avoids the "cannot access ref during render" error
const socket = useSyncExternalStore(
// Subscribe function (no-op since we don't have external subscriptions for the ref)
useCallback(() => () => {}, []),
// getSnapshot for client
() => socketRef.current,
// getServerSnapshot
() => null
);
const isAuthenticated = authStatus === 'authenticated' && !!session?.user;
const isConnected = status === 'connected';
/**
* Connect to the WebSocket server
*/
const connect = useCallback(() => {
if (!opts.enabled || !isAuthenticated) {
return;
}
if (socketRef.current?.connected) {
return;
}
// Disconnect existing socket if any
if (socketRef.current) {
socketRef.current.disconnect();
}
setStatus('connecting');
setError(null);
const socketUrl = process.env.NEXT_PUBLIC_SOCKET_URL || window.location.origin;
const socket = io(socketUrl, {
withCredentials: true,
transports: ['websocket', 'polling'],
reconnection: true,
reconnectionAttempts: opts.reconnectionAttempts,
reconnectionDelay: opts.reconnectionDelay,
reconnectionDelayMax: opts.reconnectionDelayMax,
timeout: 20000,
auth: {
// Pass the session token for authentication
// Note: You may need to adjust based on your NextAuth configuration
token: (session as { accessToken?: string })?.accessToken ||
// Fallback: use encoded JWT from cookies (handled server-side)
document.cookie
.split('; ')
.find(row => row.startsWith('next-auth.session-token='))
?.split('=')[1] ||
document.cookie
.split('; ')
.find(row => row.startsWith('__Secure-next-auth.session-token='))
?.split('=')[1],
},
}) as TypedSocket;
// Connection event handlers
socket.on('connect', () => {
setStatus('connected');
setError(null);
setReconnectAttempts(0);
});
socket.on('disconnect', (reason) => {
setStatus('disconnected');
// If the disconnection wasn't intentional, socket.io will try to reconnect
if (reason === 'io server disconnect') {
// Server forced disconnect - don't auto-reconnect
setError(new Error('Server disconnected the connection'));
}
});
socket.on('connect_error', (err) => {
setStatus('error');
setError(err);
});
// Track reconnection attempts
socket.io.on('reconnect_attempt', (attempt) => {
setStatus('connecting');
setReconnectAttempts(attempt);
});
socket.io.on('reconnect', () => {
setStatus('connected');
setReconnectAttempts(0);
});
socket.io.on('reconnect_failed', () => {
setStatus('error');
setError(new Error('Failed to reconnect after maximum attempts'));
});
// Handle server errors
socket.on('error', () => {
// Server error handled silently - error state is managed via setError
});
socketRef.current = socket;
}, [opts.enabled, isAuthenticated, session, opts.reconnectionAttempts, opts.reconnectionDelay, opts.reconnectionDelayMax]);
/**
* Disconnect from the WebSocket server
*/
const disconnect = useCallback(() => {
if (socketRef.current) {
socketRef.current.disconnect();
socketRef.current = null;
setStatus('disconnected');
setError(null);
setReconnectAttempts(0);
}
}, []);
/**
* Subscribe to channels
*/
const subscribe = useCallback((channels: string[]) => {
if (socketRef.current?.connected) {
socketRef.current.emit('subscribe', channels);
}
}, []);
/**
* Unsubscribe from channels
*/
const unsubscribe = useCallback((channels: string[]) => {
if (socketRef.current?.connected) {
socketRef.current.emit('unsubscribe', channels);
}
}, []);
/**
* Add an event listener - returns cleanup function
*/
const on = useCallback(<K extends keyof ServerToClientEvents>(
event: K,
handler: ServerToClientEvents[K]
): (() => void) => {
const socket = socketRef.current;
if (socket) {
// Use type assertion to handle Socket.IO's complex types
// eslint-disable-next-line @typescript-eslint/no-explicit-any
socket.on(event, handler as any);
return () => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
socket.off(event, handler as any);
};
}
// Return no-op if no socket
return () => {};
}, []);
// Auto-connect effect
useEffect(() => {
if (opts.autoConnect && opts.enabled && isAuthenticated) {
// Defer connection to avoid synchronous setState in effect
queueMicrotask(() => {
connect();
});
}
return () => {
if (socketRef.current) {
socketRef.current.disconnect();
socketRef.current = null;
}
};
}, [opts.autoConnect, opts.enabled, isAuthenticated, connect]);
// Cleanup on unmount
useEffect(() => {
return () => {
if (socketRef.current) {
socketRef.current.disconnect();
socketRef.current = null;
}
};
}, []);
return {
socket,
status,
isConnected,
error,
subscribe,
unsubscribe,
on,
connect,
disconnect,
reconnectAttempts,
};
}
export default useSocket;
|