Commit | Line | Data |
---|---|---|
daa6505e | 1 | import type { IncomingMessage } from 'http'; |
eb3abc4f | 2 | import type internal from 'stream'; |
8114d10e | 3 | |
eb3abc4f | 4 | import { StatusCodes } from 'http-status-codes'; |
976d11ec | 5 | import WebSocket, { type RawData, WebSocketServer } from 'ws'; |
8114d10e | 6 | |
78202038 JB |
7 | import { AbstractUIServer } from './AbstractUIServer'; |
8 | import { UIServerUtils } from './UIServerUtils'; | |
268a74bb JB |
9 | import { |
10 | type ProtocolRequest, | |
11 | type ProtocolResponse, | |
12 | type UIServerConfiguration, | |
13 | WebSocketCloseEventStatusCode, | |
14 | } from '../../types'; | |
15 | import { logger } from '../../utils/Logger'; | |
16 | import { Utils } from '../../utils/Utils'; | |
4198ad5c | 17 | |
32de5a57 LM |
18 | const moduleName = 'UIWebSocketServer'; |
19 | ||
268a74bb | 20 | export class UIWebSocketServer extends AbstractUIServer { |
eb3abc4f JB |
21 | private readonly webSocketServer: WebSocketServer; |
22 | ||
23 | public constructor(protected readonly uiServerConfiguration: UIServerConfiguration) { | |
24 | super(uiServerConfiguration); | |
eb3abc4f | 25 | this.webSocketServer = new WebSocketServer({ |
ed3d2808 | 26 | handleProtocols: UIServerUtils.handleProtocols, |
eb3abc4f JB |
27 | noServer: true, |
28 | }); | |
4198ad5c JB |
29 | } |
30 | ||
31 | public start(): void { | |
fd3c56d1 | 32 | // eslint-disable-next-line @typescript-eslint/no-unused-vars |
eb3abc4f | 33 | this.webSocketServer.on('connection', (ws: WebSocket, req: IncomingMessage): void => { |
ed3d2808 | 34 | if (UIServerUtils.isProtocolAndVersionSupported(ws.protocol) === false) { |
a92929f1 JB |
35 | logger.error( |
36 | `${this.logPrefix( | |
37 | moduleName, | |
38 | 'start.server.onconnection' | |
7cb5b17f | 39 | )} Unsupported UI protocol version: '${ws.protocol}'` |
a92929f1 | 40 | ); |
5e3cb728 | 41 | ws.close(WebSocketCloseEventStatusCode.CLOSE_PROTOCOL_ERROR); |
a92929f1 | 42 | } |
ed3d2808 | 43 | const [, version] = UIServerUtils.getProtocolAndVersion(ws.protocol); |
143498c8 | 44 | this.registerProtocolVersionUIService(version); |
72092cfc | 45 | ws.on('message', (rawData) => { |
5dea4c94 JB |
46 | const request = this.validateRawDataRequest(rawData); |
47 | if (request === false) { | |
48 | ws.close(WebSocketCloseEventStatusCode.CLOSE_INVALID_PAYLOAD); | |
49 | return; | |
50 | } | |
94dc3080 JB |
51 | const [requestId] = request as ProtocolRequest; |
52 | this.responseHandlers.set(requestId, ws); | |
e7aeea18 JB |
53 | this.uiServices |
54 | .get(version) | |
551e477c | 55 | ?.requestHandler(request) |
6c8f5d90 JB |
56 | .catch(() => { |
57 | /* Error caught by AbstractUIService */ | |
e7aeea18 | 58 | }); |
4198ad5c | 59 | }); |
72092cfc | 60 | ws.on('error', (error) => { |
5e3cb728 JB |
61 | logger.error(`${this.logPrefix(moduleName, 'start.ws.onerror')} WebSocket error:`, error); |
62 | }); | |
63 | ws.on('close', (code, reason) => { | |
64 | logger.debug( | |
65 | `${this.logPrefix( | |
66 | moduleName, | |
67 | 'start.ws.onclose' | |
68 | )} WebSocket closed: '${Utils.getWebSocketCloseEventStatusString( | |
69 | code | |
70 | )}' - '${reason.toString()}'` | |
32de5a57 | 71 | ); |
4198ad5c JB |
72 | }); |
73 | }); | |
cbf9b878 JB |
74 | // eslint-disable-next-line @typescript-eslint/no-unused-vars |
75 | this.httpServer.on('connect', (req: IncomingMessage, socket: internal.Duplex, head: Buffer) => { | |
76 | if (req.headers?.connection !== 'Upgrade' || req.headers?.upgrade !== 'websocket') { | |
77 | socket.write(`HTTP/1.1 ${StatusCodes.BAD_REQUEST} Bad Request\r\n\r\n`); | |
78 | socket.destroy(); | |
79 | } | |
80 | }); | |
eb3abc4f JB |
81 | this.httpServer.on( |
82 | 'upgrade', | |
83 | (req: IncomingMessage, socket: internal.Duplex, head: Buffer): void => { | |
72092cfc | 84 | this.authenticate(req, (err) => { |
cbf9b878 JB |
85 | if (err) { |
86 | socket.write(`HTTP/1.1 ${StatusCodes.UNAUTHORIZED} Unauthorized\r\n\r\n`); | |
4055bcb9 | 87 | socket.destroy(); |
cbf9b878 JB |
88 | return; |
89 | } | |
90 | try { | |
91 | this.webSocketServer.handleUpgrade(req, socket, head, (ws: WebSocket) => { | |
92 | this.webSocketServer.emit('connection', ws, req); | |
93 | }); | |
94 | } catch (error) { | |
95 | logger.error( | |
96 | `${this.logPrefix( | |
97 | moduleName, | |
98 | 'start.httpServer.on.upgrade' | |
99 | )} Error at handling connection upgrade:`, | |
100 | error | |
101 | ); | |
eb3abc4f | 102 | } |
eb3abc4f JB |
103 | }); |
104 | } | |
105 | ); | |
a307349b | 106 | this.startHttpServer(); |
4198ad5c JB |
107 | } |
108 | ||
5e3cb728 JB |
109 | public sendRequest(request: ProtocolRequest): void { |
110 | this.broadcastToClients(JSON.stringify(request)); | |
02a6943a JB |
111 | } |
112 | ||
5e3cb728 | 113 | public sendResponse(response: ProtocolResponse): void { |
94dc3080 | 114 | const responseId = response[0]; |
976d11ec JB |
115 | try { |
116 | if (this.responseHandlers.has(responseId)) { | |
117 | const ws = this.responseHandlers.get(responseId) as WebSocket; | |
118 | if (ws?.readyState === WebSocket.OPEN) { | |
119 | ws.send(JSON.stringify(response)); | |
e2c77f10 JB |
120 | } else { |
121 | logger.error( | |
122 | `${this.logPrefix( | |
123 | moduleName, | |
124 | 'sendResponse' | |
125 | )} Error at sending response id '${responseId}', WebSocket is not open: ${ | |
126 | ws?.readyState | |
127 | }` | |
128 | ); | |
976d11ec | 129 | } |
976d11ec JB |
130 | } else { |
131 | logger.error( | |
132 | `${this.logPrefix( | |
133 | moduleName, | |
134 | 'sendResponse' | |
135 | )} Response for unknown request id: ${responseId}` | |
136 | ); | |
94dc3080 | 137 | } |
976d11ec | 138 | } catch (error) { |
94dc3080 JB |
139 | logger.error( |
140 | `${this.logPrefix( | |
141 | moduleName, | |
142 | 'sendResponse' | |
976d11ec JB |
143 | )} Error at sending response id '${responseId}':`, |
144 | error | |
94dc3080 | 145 | ); |
e2c77f10 JB |
146 | } finally { |
147 | this.responseHandlers.delete(responseId); | |
94dc3080 | 148 | } |
178ac666 JB |
149 | } |
150 | ||
8b7072dc | 151 | public logPrefix = (modName?: string, methodName?: string, prefixSuffix?: string): string => { |
0d2cec76 JB |
152 | const logMsgPrefix = prefixSuffix |
153 | ? `UI WebSocket Server ${prefixSuffix}` | |
154 | : 'UI WebSocket Server'; | |
32de5a57 | 155 | const logMsg = |
5a2a53cf | 156 | Utils.isNotEmptyString(modName) && Utils.isNotEmptyString(methodName) |
1b271a54 JB |
157 | ? ` ${logMsgPrefix} | ${modName}.${methodName}:` |
158 | : ` ${logMsgPrefix} |`; | |
32de5a57 | 159 | return Utils.logPrefix(logMsg); |
8b7072dc | 160 | }; |
178ac666 JB |
161 | |
162 | private broadcastToClients(message: string): void { | |
eb3abc4f | 163 | for (const client of this.webSocketServer.clients) { |
0d8140bd | 164 | if (client?.readyState === WebSocket.OPEN) { |
178ac666 JB |
165 | client.send(message); |
166 | } | |
167 | } | |
168 | } | |
5e3cb728 | 169 | |
5dea4c94 | 170 | private validateRawDataRequest(rawData: RawData): ProtocolRequest | false { |
5e3cb728 JB |
171 | // logger.debug( |
172 | // `${this.logPrefix( | |
173 | // moduleName, | |
174 | // 'validateRawDataRequest' | |
175 | // )} Raw data received in string format: ${rawData.toString()}` | |
176 | // ); | |
177 | ||
178 | const request = JSON.parse(rawData.toString()) as ProtocolRequest; | |
179 | ||
180 | if (Array.isArray(request) === false) { | |
5dea4c94 JB |
181 | logger.error( |
182 | `${this.logPrefix( | |
183 | moduleName, | |
184 | 'validateRawDataRequest' | |
185 | )} UI protocol request is not an array:`, | |
186 | request | |
187 | ); | |
188 | return false; | |
5e3cb728 JB |
189 | } |
190 | ||
191 | if (request.length !== 3) { | |
5dea4c94 JB |
192 | logger.error( |
193 | `${this.logPrefix(moduleName, 'validateRawDataRequest')} UI protocol request is malformed:`, | |
194 | request | |
195 | ); | |
196 | return false; | |
197 | } | |
198 | ||
03eacbe5 | 199 | if (Utils.validateUUID(request[0]) === false) { |
5dea4c94 JB |
200 | logger.error( |
201 | `${this.logPrefix( | |
202 | moduleName, | |
203 | 'validateRawDataRequest' | |
204 | )} UI protocol request UUID field is invalid:`, | |
205 | request | |
206 | ); | |
207 | return false; | |
5e3cb728 JB |
208 | } |
209 | ||
210 | return request; | |
211 | } | |
4198ad5c | 212 | } |