X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=src%2Fcharging-station%2Fui-server%2FUIWebSocketServer.ts;h=c05ec6251278da2d3eed84711f975d7fb6e32ff1;hb=2896e06dc8d72adf7150b23c941079f622f6f37c;hp=32f5262207873aaa62b71682ab92ac46d6fb316a;hpb=6d9876e7b9b024879f1463aa7407c6874c5ca06b;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 32f52622..c05ec625 100644 --- a/src/charging-station/ui-server/UIWebSocketServer.ts +++ b/src/charging-station/ui-server/UIWebSocketServer.ts @@ -1,46 +1,57 @@ import type { IncomingMessage } from 'http'; +import type internal from 'stream'; -import WebSocket, { RawData } from 'ws'; +import { StatusCodes } from 'http-status-codes'; +import WebSocket, { type RawData, WebSocketServer } from 'ws'; -import BaseError from '../../exception/BaseError'; -import type { ServerOptions } from '../../types/ConfigurationData'; -import type { ProtocolRequest, ProtocolResponse } from '../../types/UIProtocol'; -import { WebSocketCloseEventStatusCode } from '../../types/WebSocket'; -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 { + type ProtocolRequest, + type ProtocolResponse, + type UIServerConfiguration, + WebSocketCloseEventStatusCode, +} from '../../types'; +import { logger } from '../../utils/Logger'; +import { Utils } from '../../utils/Utils'; +import { AbstractUIServer, UIServerUtils } from '../internal'; 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', (ws: WebSocket, request: IncomingMessage): void => { - const [protocol, version] = UIServiceUtils.getProtocolAndVersion(ws.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}'` + )} 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); + 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(this.buildProtocolRequest(messageId, procedureName, payload)) + ?.requestHandler(request) .catch(() => { /* Error caught by AbstractUIService */ }); @@ -59,10 +70,39 @@ export default class UIWebSocketServer extends AbstractUIServer { ); }); }); - } - - public stop(): void { - this.chargingStations.clear(); + // 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 => { + 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 sendRequest(request: ProtocolRequest): void { @@ -70,28 +110,63 @@ 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.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 { + private validateRawDataRequest(rawData: RawData): ProtocolRequest | false { // logger.debug( // `${this.logPrefix( // moduleName, @@ -102,11 +177,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;