X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2FUIWebSocketServer.ts;h=f8f836b1073b98b0f861145cefa441ba71192f89;hb=9c5d9fa4cd1904b5e2d4c4a8277bed25865b61b6;hp=c4829dcc29d9362d024fde7644c2df8355405218;hpb=5e3cb7281de2b6fa8b61a453f964c2f213fefa80;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 c4829dcc..f8f836b1 100644 --- a/src/charging-station/ui-server/UIWebSocketServer.ts +++ b/src/charging-station/ui-server/UIWebSocketServer.ts @@ -1,28 +1,33 @@ import type { IncomingMessage } from 'http'; +import type internal from 'stream'; -import WebSocket, { RawData } from 'ws'; +import { StatusCodes } from 'http-status-codes'; +import * as uuid from 'uuid'; +import WebSocket, { type RawData, WebSocketServer } from 'ws'; -import BaseError from '../../exception/BaseError'; -import type { ServerOptions } from '../../types/ConfigurationData'; +import type { UIServerConfiguration } 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'; const moduleName = 'UIWebSocketServer'; export default class UIWebSocketServer extends AbstractUIServer { - public constructor(options?: ServerOptions) { - super(); - this.server = new WebSocket.Server(options ?? Configuration.getUIServer().options); + private readonly webSocketServer: WebSocketServer; + + public constructor(protected readonly uiServerConfiguration: UIServerConfiguration) { + super(uiServerConfiguration); + this.webSocketServer = new WebSocketServer({ + handleProtocols: UIServiceUtils.handleProtocols, + noServer: true, + }); } public start(): void { - this.server.on('connection', (ws: WebSocket, request: IncomingMessage): void => { + this.webSocketServer.on('connection', (ws: WebSocket, req: IncomingMessage): void => { const [protocol, version] = UIServiceUtils.getProtocolAndVersion(ws.protocol); if (UIServiceUtils.isProtocolAndVersionSupported(protocol, version) === false) { logger.error( @@ -33,14 +38,18 @@ export default class UIWebSocketServer extends AbstractUIServer { ); ws.close(WebSocketCloseEventStatusCode.CLOSE_PROTOCOL_ERROR); } - if (!this.uiServices.has(version)) { - this.uiServices.set(version, UIServiceFactory.getUIServiceImplementation(version, this)); - } + 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 +68,24 @@ export default class UIWebSocketServer extends AbstractUIServer { ); }); }); - } - - public stop(): void { - this.chargingStations.clear(); + 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; + } + 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 sendRequest(request: ProtocolRequest): void { @@ -70,8 +93,41 @@ 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 { @@ -84,14 +140,14 @@ export default class UIWebSocketServer extends AbstractUIServer { } 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 +158,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 (uuid.validate(request[0]) === false) { + logger.error( + `${this.logPrefix( + moduleName, + 'validateRawDataRequest' + )} UI protocol request UUID field is invalid:`, + request + ); + return false; } return request;