X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2FUIWebSocketServer.ts;h=5651ab5a405f3d98c00f0688ff7f493ab7da8a71;hb=4a3807d16c54137840a60af41877f3b21de12950;hp=c067fb362a8c8b717312bcff35a049135aac2a23;hpb=623b39b56185797f9976508571ca38619518a975;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ui-server/UIWebSocketServer.ts b/src/charging-station/ui-server/UIWebSocketServer.ts index c067fb36..5651ab5a 100644 --- a/src/charging-station/ui-server/UIWebSocketServer.ts +++ b/src/charging-station/ui-server/UIWebSocketServer.ts @@ -1,43 +1,53 @@ -import type { IncomingMessage } from 'http'; -import type internal from 'stream'; +import type { IncomingMessage } from 'node:http'; +import type { Duplex } from 'node:stream'; import { StatusCodes } from 'http-status-codes'; -import * as uuid from 'uuid'; -import WebSocket, { RawData, WebSocketServer } from 'ws'; - -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 { type RawData, WebSocket, WebSocketServer } from 'ws'; + import { AbstractUIServer } from './AbstractUIServer'; -import { UIServiceUtils } from './ui-services/UIServiceUtils'; +import { UIServerUtils } from './UIServerUtils'; +import { + type ProtocolRequest, + type ProtocolResponse, + type UIServerConfiguration, + WebSocketCloseEventStatusCode, +} from '../../types'; +import { + Constants, + getWebSocketCloseEventStatusString, + isNotEmptyString, + isNullOrUndefined, + logPrefix, + logger, + validateUUID, +} from '../../utils'; const moduleName = 'UIWebSocketServer'; -export default class UIWebSocketServer extends AbstractUIServer { +export class UIWebSocketServer extends AbstractUIServer { private readonly webSocketServer: WebSocketServer; 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}'` + 'start.server.onconnection', + )} 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); @@ -49,10 +59,13 @@ export default class UIWebSocketServer extends AbstractUIServer { this.responseHandlers.set(requestId, ws); this.uiServices .get(version) - .requestHandler(request) - .catch(() => { - /* Error caught by AbstractUIService */ - }); + ?.requestHandler(request) + .then((protocolResponse?: ProtocolResponse) => { + if (!isNullOrUndefined(protocolResponse)) { + this.sendResponse(protocolResponse!); + } + }) + .catch(Constants.EMPTY_FUNCTION); }); ws.on('error', (error) => { logger.error(`${this.logPrefix(moduleName, 'start.ws.onerror')} WebSocket error:`, error); @@ -61,31 +74,43 @@ export default class UIWebSocketServer extends AbstractUIServer { logger.debug( `${this.logPrefix( moduleName, - 'start.ws.onclose' - )} WebSocket closed: '${Utils.getWebSocketCloseEventStatusString( - code - )}' - '${reason.toString()}'` + 'start.ws.onclose', + )} WebSocket closed: '${getWebSocketCloseEventStatusString( + code, + )}' - '${reason.toString()}'`, ); }); }); - this.httpServer.on( - 'upgrade', - (req: IncomingMessage, socket: internal.Duplex, head: Buffer): void => { - this.authenticate(req, (err) => { - if (err) { - socket.write(`HTTP/1.1 ${StatusCodes.UNAUTHORIZED} Unauthorized\r\n\r\n`); - socket.destroy(); - return; - } + // eslint-disable-next-line @typescript-eslint/no-unused-vars + this.httpServer.on('connect', (req: IncomingMessage, socket: 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: Duplex, head: Buffer): void => { + this.authenticate(req, (err) => { + if (err) { + socket.write(`HTTP/1.1 ${StatusCodes.UNAUTHORIZED} Unauthorized\r\n\r\n`); + socket.destroy(); + return; + } + try { this.webSocketServer.handleUpgrade(req, socket, head, (ws: WebSocket) => { this.webSocketServer.emit('connection', ws, req); }); - }); - } - ); - if (this.httpServer.listening === false) { - this.httpServer.listen(this.uiServerConfiguration.options); - } + } catch (error) { + logger.error( + `${this.logPrefix( + moduleName, + 'start.httpServer.on.upgrade', + )} Error at handling connection upgrade:`, + error, + ); + } + }); + }); + this.startHttpServer(); } public sendRequest(request: ProtocolRequest): void { @@ -94,30 +119,50 @@ export default class UIWebSocketServer extends AbstractUIServer { 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.hasResponseHandler(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}` + 'sendResponse', + )} Error at sending response id '${responseId}':`, + error, ); + } finally { + this.responseHandlers.delete(responseId); } } - public logPrefix(modName?: string, methodName?: string, prefixSuffix?: string): string { + public logPrefix = (modName?: string, methodName?: string, prefixSuffix?: string): string => { const logMsgPrefix = prefixSuffix ? `UI WebSocket Server ${prefixSuffix}` : 'UI WebSocket Server'; const logMsg = - modName && methodName ? ` ${logMsgPrefix} | ${modName}.${methodName}:` : ` ${logMsgPrefix} |`; - return Utils.logPrefix(logMsg); - } + isNotEmptyString(modName) && isNotEmptyString(methodName) + ? ` ${logMsgPrefix} | ${modName}.${methodName}:` + : ` ${logMsgPrefix} |`; + return logPrefix(logMsg); + }; private broadcastToClients(message: string): void { for (const client of this.webSocketServer.clients) { @@ -131,19 +176,21 @@ export default class UIWebSocketServer extends AbstractUIServer { // logger.debug( // `${this.logPrefix( // moduleName, - // 'validateRawDataRequest' - // )} Raw data received in string format: ${rawData.toString()}` + // 'validateRawDataRequest', + // // eslint-disable-next-line @typescript-eslint/no-base-to-string + // )} Raw data received in string format: ${rawData.toString()}`, // ); + // eslint-disable-next-line @typescript-eslint/no-base-to-string const request = JSON.parse(rawData.toString()) as ProtocolRequest; if (Array.isArray(request) === false) { logger.error( `${this.logPrefix( moduleName, - 'validateRawDataRequest' + 'validateRawDataRequest', )} UI protocol request is not an array:`, - request + request, ); return false; } @@ -151,18 +198,18 @@ export default class UIWebSocketServer extends AbstractUIServer { if (request.length !== 3) { logger.error( `${this.logPrefix(moduleName, 'validateRawDataRequest')} UI protocol request is malformed:`, - request + request, ); return false; } - if (uuid.validate(request[0]) === false) { + if (validateUUID(request[0]) === false) { logger.error( `${this.logPrefix( moduleName, - 'validateRawDataRequest' + 'validateRawDataRequest', )} UI protocol request UUID field is invalid:`, - request + request, ); return false; }