|
| 1 | +import { useState } from 'react'; |
| 2 | +import { useEffectOnce, useUnmount } from 'react-use'; |
| 3 | +import { IReqraftWebSocketConfig, ReqraftWebSocket } from '../../utils/websocket'; |
| 4 | + |
| 5 | +export interface IUseReqraftWebSocketOptions extends IReqraftWebSocketConfig { |
| 6 | + onMessage?: (ev: MessageEvent) => void; |
| 7 | + useState?: boolean; |
| 8 | + includeSentMessagesInState?: boolean; |
| 9 | + includeLogMessagesInState?: boolean; |
| 10 | + openOnMount?: boolean; |
| 11 | + closeOnUnmount?: boolean; |
| 12 | +} |
| 13 | + |
| 14 | +export interface IUseReqraftWebSocket { |
| 15 | + messages: string[]; |
| 16 | + status: keyof typeof ReqraftWebSocketStatus; |
| 17 | + open: () => void; |
| 18 | + close: () => void; |
| 19 | + socket: ReqraftWebSocket; |
| 20 | + send: (data: string) => void; |
| 21 | + clear: () => void; |
| 22 | + on: (type: keyof WebSocketEventMap, handler: (ev: Event) => void) => void; |
| 23 | + addMessage: (message: string) => void; |
| 24 | +} |
| 25 | + |
| 26 | +export enum ReqraftWebSocketStatus { |
| 27 | + OPEN = 'OPEN', |
| 28 | + CLOSED = 'CLOSED', |
| 29 | + CONNECTING = 'CONNECTING', |
| 30 | +} |
| 31 | + |
| 32 | +export const useReqraftWebSocket = (options: IUseReqraftWebSocketOptions): IUseReqraftWebSocket => { |
| 33 | + const [messages, setMessages] = useState<string[]>([]); |
| 34 | + const [status, setStatus] = useState<keyof typeof ReqraftWebSocketStatus>('CLOSED'); |
| 35 | + const [socket, setSocket] = useState<ReqraftWebSocket>(undefined); |
| 36 | + |
| 37 | + const updateStates = (status: keyof typeof ReqraftWebSocketStatus, log?: string) => { |
| 38 | + setStatus(status); |
| 39 | + |
| 40 | + if (log && options?.includeLogMessagesInState && options?.useState) { |
| 41 | + setMessages((prev) => [...prev, log]); |
| 42 | + } |
| 43 | + }; |
| 44 | + |
| 45 | + const handleOpen = (ev?: Event) => { |
| 46 | + updateStates(ReqraftWebSocketStatus.OPEN, 'Connection opened'); |
| 47 | + |
| 48 | + options?.onOpen?.(ev); |
| 49 | + }; |
| 50 | + |
| 51 | + const open = () => { |
| 52 | + const socket = new ReqraftWebSocket({ |
| 53 | + ...options, |
| 54 | + onOpen: handleOpen, |
| 55 | + onMessage: (ev) => { |
| 56 | + if (options?.useState) { |
| 57 | + setMessages((prev) => [...prev, ev.data]); |
| 58 | + } |
| 59 | + |
| 60 | + options?.onMessage?.(ev); |
| 61 | + }, |
| 62 | + onClose: (...args) => { |
| 63 | + updateStates(ReqraftWebSocketStatus.CLOSED, 'Connection closed'); |
| 64 | + |
| 65 | + options?.onClose?.(...args); |
| 66 | + }, |
| 67 | + onError: (...args) => { |
| 68 | + updateStates(ReqraftWebSocketStatus.CLOSED, 'Connection error'); |
| 69 | + |
| 70 | + options?.onError?.(...args); |
| 71 | + }, |
| 72 | + onReconnecting: (reconnectNumber) => { |
| 73 | + updateStates( |
| 74 | + ReqraftWebSocketStatus.CONNECTING, |
| 75 | + `Reconnecting... Attempt ${reconnectNumber}` |
| 76 | + ); |
| 77 | + |
| 78 | + options?.onReconnecting?.(reconnectNumber); |
| 79 | + }, |
| 80 | + onReconnectFailed: () => { |
| 81 | + updateStates(ReqraftWebSocketStatus.CLOSED, 'Reconnect failed'); |
| 82 | + |
| 83 | + options?.onReconnectFailed?.(); |
| 84 | + }, |
| 85 | + }); |
| 86 | + |
| 87 | + setSocket(socket); |
| 88 | + }; |
| 89 | + |
| 90 | + const close = () => { |
| 91 | + socket?.remove(); |
| 92 | + setSocket(undefined); |
| 93 | + setStatus(ReqraftWebSocketStatus.CLOSED); |
| 94 | + }; |
| 95 | + |
| 96 | + const send = (data: string) => { |
| 97 | + socket?.send(data); |
| 98 | + |
| 99 | + if (options?.includeSentMessagesInState) { |
| 100 | + setMessages((prev) => [...prev, data]); |
| 101 | + } |
| 102 | + }; |
| 103 | + |
| 104 | + const on = (type: keyof WebSocketEventMap, handler: (ev: Event) => void) => { |
| 105 | + // Special case for message event |
| 106 | + // We want to handle it differently |
| 107 | + // We want to filter out the ping messages |
| 108 | + if (type === 'message') { |
| 109 | + socket?.addHandler('message', (ev) => { |
| 110 | + if ((<MessageEvent>ev).data === 'pong') { |
| 111 | + return; |
| 112 | + } |
| 113 | + |
| 114 | + handler(ev); |
| 115 | + }); |
| 116 | + |
| 117 | + return; |
| 118 | + } |
| 119 | + |
| 120 | + socket?.addHandler(type, handler); |
| 121 | + }; |
| 122 | + |
| 123 | + const clear = () => { |
| 124 | + setMessages([]); |
| 125 | + }; |
| 126 | + |
| 127 | + const addMessage = (message: string) => { |
| 128 | + if (options?.useState) { |
| 129 | + setMessages((prev) => [...prev, message]); |
| 130 | + } |
| 131 | + }; |
| 132 | + |
| 133 | + useEffectOnce(() => { |
| 134 | + if (options?.openOnMount) { |
| 135 | + open(); |
| 136 | + } |
| 137 | + }); |
| 138 | + |
| 139 | + useUnmount(() => { |
| 140 | + if (options?.closeOnUnmount) { |
| 141 | + close(); |
| 142 | + } |
| 143 | + }); |
| 144 | + |
| 145 | + return { messages, status, open, socket, close, send, clear, on, addMessage }; |
| 146 | +}; |
0 commit comments