import type internal from 'stream';
import { StatusCodes } from 'http-status-codes';
-import * as uuid from 'uuid';
-import WebSocket, { RawData, WebSocketServer } from 'ws';
+import WebSocket, { type RawData, WebSocketServer } from 'ws';
+import { AbstractUIServer } from './AbstractUIServer';
+import { UIServerUtils } from './UIServerUtils';
import type { UIServerConfiguration } from '../../types/ConfigurationData';
import type { ProtocolRequest, ProtocolResponse } from '../../types/UIProtocol';
import { WebSocketCloseEventStatusCode } from '../../types/WebSocket';
import logger from '../../utils/Logger';
import Utils from '../../utils/Utils';
-import { AbstractUIServer } from './AbstractUIServer';
-import { UIServiceUtils } from './ui-services/UIServiceUtils';
const moduleName = 'UIWebSocketServer';
public constructor(protected readonly uiServerConfiguration: UIServerConfiguration) {
super(uiServerConfiguration);
this.webSocketServer = new WebSocketServer({
- handleProtocols: UIServiceUtils.handleProtocols,
+ handleProtocols: UIServerUtils.handleProtocols,
noServer: true,
});
}
public start(): void {
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
this.webSocketServer.on('connection', (ws: WebSocket, req: IncomingMessage): void => {
- const [protocol, version] = UIServiceUtils.getProtocolAndVersion(ws.protocol);
- if (UIServiceUtils.isProtocolAndVersionSupported(protocol, version) === false) {
+ if (UIServerUtils.isProtocolAndVersionSupported(ws.protocol) === false) {
logger.error(
`${this.logPrefix(
moduleName,
'start.server.onconnection'
- )} Unsupported UI protocol version: '${protocol}${version}'`
+ )} Unsupported UI protocol version: '${ws.protocol}'`
);
ws.close(WebSocketCloseEventStatusCode.CLOSE_PROTOCOL_ERROR);
}
+ const [, version] = UIServerUtils.getProtocolAndVersion(ws.protocol);
this.registerProtocolVersionUIService(version);
ws.on('message', (rawData) => {
const request = this.validateRawDataRequest(rawData);
this.responseHandlers.set(requestId, ws);
this.uiServices
.get(version)
- .requestHandler(request)
+ ?.requestHandler(request)
.catch(() => {
/* Error caught by AbstractUIService */
});
);
});
});
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
+ this.httpServer.on('connect', (req: IncomingMessage, socket: internal.Duplex, head: Buffer) => {
+ if (req.headers?.connection !== 'Upgrade' || req.headers?.upgrade !== 'websocket') {
+ socket.write(`HTTP/1.1 ${StatusCodes.BAD_REQUEST} Bad Request\r\n\r\n`);
+ socket.destroy();
+ }
+ });
this.httpServer.on(
'upgrade',
(req: IncomingMessage, socket: internal.Duplex, head: Buffer): void => {
socket.destroy();
return;
}
- this.webSocketServer.handleUpgrade(req, socket, head, (ws: WebSocket) => {
- this.webSocketServer.emit('connection', ws, req);
- });
+ try {
+ this.webSocketServer.handleUpgrade(req, socket, head, (ws: WebSocket) => {
+ this.webSocketServer.emit('connection', ws, req);
+ });
+ } catch (error) {
+ logger.error(
+ `${this.logPrefix(
+ moduleName,
+ 'start.httpServer.on.upgrade'
+ )} Error at handling connection upgrade:`,
+ error
+ );
+ }
});
}
);
- if (this.httpServer.listening === false) {
- this.httpServer.listen(this.uiServerConfiguration.options);
- }
+ this.startHttpServer();
}
public sendRequest(request: ProtocolRequest): void {
public sendResponse(response: ProtocolResponse): void {
const responseId = response[0];
- if (this.responseHandlers.has(responseId)) {
- const ws = this.responseHandlers.get(responseId) as WebSocket;
- if (ws?.readyState === WebSocket.OPEN) {
- ws.send(JSON.stringify(response));
+ try {
+ if (this.responseHandlers.has(responseId)) {
+ const ws = this.responseHandlers.get(responseId) as WebSocket;
+ if (ws?.readyState === WebSocket.OPEN) {
+ ws.send(JSON.stringify(response));
+ } else {
+ logger.error(
+ `${this.logPrefix(
+ moduleName,
+ 'sendResponse'
+ )} Error at sending response id '${responseId}', WebSocket is not open: ${
+ ws?.readyState
+ }`
+ );
+ }
+ } else {
+ logger.error(
+ `${this.logPrefix(
+ moduleName,
+ 'sendResponse'
+ )} Response for unknown request id: ${responseId}`
+ );
}
- this.responseHandlers.delete(responseId);
- } else {
+ } catch (error) {
logger.error(
`${this.logPrefix(
moduleName,
'sendResponse'
- )} Response for unknown request id: ${responseId}`
+ )} Error at sending response id '${responseId}':`,
+ error
);
+ } finally {
+ this.responseHandlers.delete(responseId);
}
}
return false;
}
- if (uuid.validate(request[0]) === false) {
+ if (Utils.validateUUID(request[0]) === false) {
logger.error(
`${this.logPrefix(
moduleName,