Spaces:
Runtime error
Runtime error
File size: 8,567 Bytes
46252cd | 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 279 | import { useEffect, useRef, useCallback, useState } from 'react';
import { io, Socket } from 'socket.io-client';
import { warnIfInsecureHttpUrl } from '../utils/urlSecurity';
interface SessionStatusEvent {
sessionId: string;
status: string;
timestamp: string;
}
interface QRCodeEvent {
sessionId: string;
qrCode: string;
timestamp: string;
}
interface MessageEvent {
sessionId: string;
message: Record<string, unknown>;
timestamp: string;
}
interface MessageAckEvent {
sessionId: string;
id: string;
messageId: string;
// Neutral delivery status emitted by the backend (engine-agnostic), not a raw wwebjs ack integer.
status: 'pending' | 'sent' | 'delivered' | 'read' | 'failed';
// Deprecated legacy numeric ack kept for backward compatibility; prefer `status`.
ack?: number;
timestamp?: string;
}
interface MessageReactionEvent {
sessionId: string;
messageId: string;
chatId: string;
reaction: string;
senderId: string;
reactions: Record<string, string>;
timestamp: string;
}
interface MessageEditedEvent {
sessionId: string;
messageId: string;
chatId: string;
body: string;
timestamp: number;
}
interface MessageRevokedEvent {
sessionId: string;
id: string;
/**
* Id of the ORIGINAL deleted message. Optional: whatsapp-web.js can only resolve it when the
* original is still in its local store, and Baileys sets it identical to `id`.
*/
revokedId?: string;
chatId: string;
from: string;
to: string;
body: string;
type: string;
timestamp: number;
}
interface WebSocketEvents {
onSessionStatus?: (event: SessionStatusEvent) => void;
onQRCode?: (event: QRCodeEvent) => void;
onMessage?: (event: MessageEvent) => void;
onMessageAck?: (event: MessageAckEvent) => void;
onMessageReaction?: (event: MessageReactionEvent) => void;
onMessageRevoked?: (event: MessageRevokedEvent) => void;
onMessageEdited?: (event: MessageEditedEvent) => void;
}
// Shape of the server -> client event envelope produced by the NestJS gateway.
interface ServerEventEnvelope {
type: string;
timestamp: string;
payload?: {
event: string;
sessionId: string;
data: Record<string, unknown>;
};
}
// Use current origin for WebSocket (goes through nginx proxy in Docker)
// Falls back to env var or localhost for development
const SOCKET_URL = import.meta.env.VITE_WS_URL || window.location.origin;
// Warn when the WebSocket origin is an insecure http:// URL on a non-localhost host.
warnIfInsecureHttpUrl(SOCKET_URL, 'VITE_WS_URL');
export function useWebSocket(events: WebSocketEvents = {}) {
const socketRef = useRef<Socket | null>(null);
const [isConnected, setIsConnected] = useState(false);
// True once Socket.IO exhausts its reconnection attempts and permanently gives up — lets the
// UI show a "connection lost" indicator + a manual retry instead of silently going stale.
const [connectionFailed, setConnectionFailed] = useState(false);
const connect = useCallback(() => {
if (socketRef.current?.connected) return;
// Get API key from sessionStorage (same as api.ts)
const apiKey = sessionStorage.getItem('openwa_api_key');
if (!apiKey) {
console.warn('[WebSocket] No API key found, skipping connection');
return;
}
socketRef.current = io(`${SOCKET_URL}/events`, {
autoConnect: true,
reconnection: true,
reconnectionAttempts: 5,
reconnectionDelay: 1000,
// Send the key via `auth` (and a header for proxies). NOT via `query` — a key in the
// handshake URL leaks into access logs / Referer. The gateway reads auth first.
auth: {
apiKey,
},
extraHeaders: {
'X-API-Key': apiKey,
},
});
socketRef.current.on('connect', () => {
setIsConnected(true);
setConnectionFailed(false);
});
socketRef.current.on('disconnect', () => {
setIsConnected(false);
});
socketRef.current.on('connect_error', error => {
console.warn('[WebSocket] Connection error:', error.message);
});
// `reconnect_failed` is emitted on the Manager once all reconnectionAttempts are exhausted.
socketRef.current.io.on('reconnect_failed', () => {
console.warn('[WebSocket] Reconnection failed after max attempts');
setConnectionFailed(true);
});
}, []);
// Manual retry after the socket permanently gave up: tear down the dead socket and reconnect.
const reconnect = useCallback(() => {
setConnectionFailed(false);
if (socketRef.current) {
socketRef.current.disconnect();
socketRef.current = null;
}
connect();
}, [connect]);
const subscribe = useCallback((sessionId: string, eventsList: string[]) => {
if (socketRef.current?.connected) {
socketRef.current.emit('message', {
type: 'subscribe',
sessionId,
events: eventsList,
});
}
}, []);
const unsubscribe = useCallback((sessionId: string) => {
if (socketRef.current?.connected) {
socketRef.current.emit('message', {
type: 'unsubscribe',
sessionId,
});
}
}, []);
useEffect(() => {
connect();
return () => {
if (socketRef.current) {
socketRef.current.disconnect();
socketRef.current = null;
}
};
}, [connect]);
// Register the single envelope handler and fan out to the typed callbacks.
useEffect(() => {
if (!socketRef.current) return;
const socket = socketRef.current;
const handleIncomingMessage = (msg: ServerEventEnvelope) => {
if (!msg || msg.type !== 'event' || !msg.payload) return;
const { event, sessionId, data } = msg.payload;
switch (event) {
case 'session.status':
events.onSessionStatus?.({ sessionId, status: String(data.status), timestamp: msg.timestamp });
break;
case 'session.qr':
events.onQRCode?.({ sessionId, qrCode: String(data.qrCode), timestamp: msg.timestamp });
break;
case 'message.received':
case 'message.sent':
events.onMessage?.({ sessionId, message: data, timestamp: msg.timestamp });
break;
case 'message.ack':
events.onMessageAck?.({
sessionId,
id: String(data.id),
messageId: String(data.messageId),
status: data.status as MessageAckEvent['status'],
ack: typeof data.ack === 'number' ? data.ack : undefined,
timestamp: msg.timestamp,
});
break;
case 'message.reaction':
events.onMessageReaction?.({
sessionId,
messageId: String(data.messageId),
chatId: String(data.chatId),
reaction: String(data.reaction),
senderId: String(data.senderId),
reactions: (data.reactions as Record<string, string>) || {},
timestamp: msg.timestamp,
});
break;
case 'message.revoked':
events.onMessageRevoked?.({
sessionId,
id: String(data.id),
// Not String()-coerced like its neighbours: the field is optional on the wire, and
// String(undefined) would yield the truthy literal "undefined" and defeat the fallback.
revokedId: typeof data.revokedId === 'string' ? data.revokedId : undefined,
chatId: String(data.chatId),
from: String(data.from),
to: String(data.to),
body: String(data.body ?? ''),
type: String(data.type),
timestamp: Number(data.timestamp),
});
break;
case 'message.edited':
// Keep optional/malformed wire fields from becoming the truthy strings "undefined"/"null"
// and accidentally matching an unrelated cached row.
if (
typeof data.messageId !== 'string' ||
!data.messageId ||
typeof data.chatId !== 'string' ||
typeof data.body !== 'string'
) {
break;
}
events.onMessageEdited?.({
sessionId,
messageId: data.messageId,
chatId: data.chatId,
body: data.body,
timestamp: Number(data.timestamp),
});
break;
default:
break;
}
};
socket.on('message', handleIncomingMessage);
return () => {
socket.off('message', handleIncomingMessage);
};
}, [events]);
return { isConnected, connectionFailed, reconnect, subscribe, unsubscribe };
}
|