X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2FUIWebSocketServer.ts;h=bf9eb8b3a66b753907d98a2df18120dcd25291ce;hb=12f26d4a81773cf8ede8bad4255e36aadf10bce0;hp=01c57800a293c5d3d9da411812ee6d0388e63f16;hpb=4055bcb98b38568fdd77461842820e7d1a86f419;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 01c57800..bf9eb8b3 100644 --- a/src/charging-station/ui-server/UIWebSocketServer.ts +++ b/src/charging-station/ui-server/UIWebSocketServer.ts @@ -1,56 +1,54 @@ -import { IncomingMessage, createServer } 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 WebSocket, { RawData, WebSocketServer } from 'ws'; - -import BaseError from '../../exception/BaseError'; -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 UIServiceFactory from './ui-services/UIServiceFactory'; -import { UIServiceUtils } from './ui-services/UIServiceUtils'; +import WebSocket, { type RawData, WebSocketServer } from 'ws'; + +import { + type ProtocolRequest, + type ProtocolResponse, + type UIServerConfiguration, + WebSocketCloseEventStatusCode, +} from '../../types'; +import { Constants, Utils, logger } from '../../utils'; +import { AbstractUIServer, UIServerUtils } from '../internal'; 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.httpServer = createServer(); 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); } - if (this.uiServices.has(version) === false) { - this.uiServices.set(version, UIServiceFactory.getUIServiceImplementation(version, this)); - } + const [, version] = UIServerUtils.getProtocolAndVersion(ws.protocol); + this.registerProtocolVersionUIService(version); ws.on('message', (rawData) => { - const [messageId, procedureName, payload] = this.validateRawDataRequest(rawData); - this.uiServices - .get(version) - .requestHandler(this.buildProtocolRequest(messageId, procedureName, payload)) - .catch(() => { - /* Error caught by AbstractUIService */ - }); + const request = this.validateRawDataRequest(rawData); + if (request === false) { + ws.close(WebSocketCloseEventStatusCode.CLOSE_INVALID_PAYLOAD); + return; + } + const [requestId] = request as ProtocolRequest; + this.responseHandlers.set(requestId, ws); + this.uiServices.get(version)?.requestHandler(request).catch(Constants.EMPTY_FUNCTION); }); ws.on('error', (error) => { logger.error(`${this.logPrefix(moduleName, 'start.ws.onerror')} WebSocket error:`, error); @@ -66,28 +64,36 @@ export default class UIWebSocketServer extends AbstractUIServer { ); }); }); - 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); - } - } - - public stop(): void { - this.chargingStations.clear(); + } catch (error) { + logger.error( + `${this.logPrefix( + moduleName, + 'start.httpServer.on.upgrade' + )} Error at handling connection upgrade:`, + error + ); + } + }); + }); + this.startHttpServer(); } public sendRequest(request: ProtocolRequest): void { @@ -95,18 +101,53 @@ export default class UIWebSocketServer extends AbstractUIServer { } public sendResponse(response: ProtocolResponse): void { - // TODO: send response only to the client that sent the request - this.broadcastToClients(JSON.stringify(response)); + const responseId = response[0]; + 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}` + ); + } + } catch (error) { + logger.error( + `${this.logPrefix( + moduleName, + '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} |`; + Utils.isNotEmptyString(modName) && Utils.isNotEmptyString(methodName) + ? ` ${logMsgPrefix} | ${modName}.${methodName}:` + : ` ${logMsgPrefix} |`; return Utils.logPrefix(logMsg); - } + }; private broadcastToClients(message: string): void { for (const client of this.webSocketServer.clients) { @@ -116,19 +157,7 @@ export default class UIWebSocketServer extends AbstractUIServer { } } - private authenticate(req: IncomingMessage, next: (err?: Error) => void): void { - if (this.isBasicAuthEnabled() === true) { - if (this.isValidBasicAuth(req) === false) { - next(new Error('Unauthorized')); - } else { - next(); - } - } else { - next(); - } - } - - private validateRawDataRequest(rawData: RawData): ProtocolRequest { + private validateRawDataRequest(rawData: RawData): ProtocolRequest | false { // logger.debug( // `${this.logPrefix( // moduleName, @@ -139,11 +168,33 @@ export default class UIWebSocketServer extends AbstractUIServer { const request = JSON.parse(rawData.toString()) as ProtocolRequest; if (Array.isArray(request) === false) { - throw new BaseError('UI protocol request is not an array'); + logger.error( + `${this.logPrefix( + moduleName, + 'validateRawDataRequest' + )} UI protocol request is not an array:`, + request + ); + return false; } if (request.length !== 3) { - throw new BaseError('UI protocol request is malformed'); + logger.error( + `${this.logPrefix(moduleName, 'validateRawDataRequest')} UI protocol request is malformed:`, + request + ); + return false; + } + + if (Utils.validateUUID(request[0]) === false) { + logger.error( + `${this.logPrefix( + moduleName, + 'validateRawDataRequest' + )} UI protocol request UUID field is invalid:`, + request + ); + return false; } return request;