X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2FUIWebSocketServer.ts;h=5651ab5a405f3d98c00f0688ff7f493ab7da8a71;hb=4a3807d16c54137840a60af41877f3b21de12950;hp=9cec37da847f98362e64765c297e9496463082b0;hpb=a92929f178ff0d2d4fc55bd30f93ea7a64462dd5;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 9cec37da..5651ab5a 100644 --- a/src/charging-station/ui-server/UIWebSocketServer.ts +++ b/src/charging-station/ui-server/UIWebSocketServer.ts @@ -1,82 +1,219 @@ -import type { IncomingMessage } from 'http'; +import type { IncomingMessage } from 'node:http'; +import type { Duplex } from 'node:stream'; -import WebSocket from 'ws'; +import { StatusCodes } from 'http-status-codes'; +import { type RawData, WebSocket, WebSocketServer } from 'ws'; -import type { ServerOptions } from '../../types/ConfigurationData'; -import Configuration from '../../utils/Configuration'; -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 { 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 { - public constructor(options?: ServerOptions) { - super(); - this.server = new WebSocket.Server(options ?? Configuration.getUIServer().options); +export class UIWebSocketServer extends AbstractUIServer { + private readonly webSocketServer: WebSocketServer; + + public constructor(protected readonly uiServerConfiguration: UIServerConfiguration) { + super(uiServerConfiguration); + this.webSocketServer = new WebSocketServer({ + handleProtocols: UIServerUtils.handleProtocols, + noServer: true, + }); } public start(): void { - this.server.on('connection', (socket: WebSocket, request: IncomingMessage): void => { - const [protocol, version] = UIServiceUtils.getProtocolAndVersion(socket.protocol); - if (UIServiceUtils.isProtocolAndVersionSupported(protocol, version) === false) { + // eslint-disable-next-line @typescript-eslint/no-unused-vars + this.webSocketServer.on('connection', (ws: WebSocket, req: IncomingMessage): void => { + 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}'`, ); - socket.close(); + ws.close(WebSocketCloseEventStatusCode.CLOSE_PROTOCOL_ERROR); } - if (!this.uiServices.has(version)) { - this.uiServices.set(version, UIServiceFactory.getUIServiceImplementation(version, this)); - } - // FIXME: check connection validity - socket.on('message', (rawData) => { + const [, version] = UIServerUtils.getProtocolAndVersion(ws.protocol); + this.registerProtocolVersionUIService(version); + ws.on('message', (rawData) => { + 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(rawData) - .catch(() => { - /* Error caught by AbstractUIService */ - }); + ?.requestHandler(request) + .then((protocolResponse?: ProtocolResponse) => { + if (!isNullOrUndefined(protocolResponse)) { + this.sendResponse(protocolResponse!); + } + }) + .catch(Constants.EMPTY_FUNCTION); }); - socket.on('error', (error) => { - logger.error( - `${this.logPrefix(moduleName, 'start.socket.onerror')} Error on WebSocket:`, - error + ws.on('error', (error) => { + logger.error(`${this.logPrefix(moduleName, 'start.ws.onerror')} WebSocket error:`, error); + }); + ws.on('close', (code, reason) => { + logger.debug( + `${this.logPrefix( + moduleName, + 'start.ws.onclose', + )} WebSocket closed: '${getWebSocketCloseEventStatusString( + code, + )}' - '${reason.toString()}'`, ); }); }); + // 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); + }); + } catch (error) { + logger.error( + `${this.logPrefix( + moduleName, + 'start.httpServer.on.upgrade', + )} Error at handling connection upgrade:`, + error, + ); + } + }); + }); + this.startHttpServer(); } - public stop(): void { - this.chargingStations.clear(); - } - - public sendRequest(request: string): void { - this.broadcastToClients(request); + public sendRequest(request: ProtocolRequest): void { + this.broadcastToClients(JSON.stringify(request)); } - public sendResponse(response: string): void { - // TODO: send response only to the client that sent the request - this.broadcastToClients(response); + public sendResponse(response: ProtocolResponse): void { + const responseId = response[0]; + 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}`, + ); + } + } 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): string { + public logPrefix = (modName?: string, methodName?: string, prefixSuffix?: string): string => { + const logMsgPrefix = prefixSuffix + ? `UI WebSocket Server ${prefixSuffix}` + : 'UI WebSocket Server'; const logMsg = - modName && methodName - ? ` UI WebSocket Server | ${modName}.${methodName}:` - : ' UI WebSocket Server |'; - 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.server as WebSocket.Server).clients) { + for (const client of this.webSocketServer.clients) { if (client?.readyState === WebSocket.OPEN) { client.send(message); } } } + + private validateRawDataRequest(rawData: RawData): ProtocolRequest | false { + // logger.debug( + // `${this.logPrefix( + // moduleName, + // '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', + )} UI protocol request is not an array:`, + request, + ); + return false; + } + + if (request.length !== 3) { + logger.error( + `${this.logPrefix(moduleName, 'validateRawDataRequest')} UI protocol request is malformed:`, + request, + ); + return false; + } + + if (validateUUID(request[0]) === false) { + logger.error( + `${this.logPrefix( + moduleName, + 'validateRawDataRequest', + )} UI protocol request UUID field is invalid:`, + request, + ); + return false; + } + + return request; + } }