X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2FUIWebSocketServer.ts;h=097533e0b493196bc7a0c864907ba1dbde3f5984;hb=66a7748ddeda8c94d7562a1ce58d440319654a4c;hp=c706cdd9a31613422bd5a519dcfba365833115ed;hpb=5aefc345de84b04a0bd5529830948da4d5c2f547;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 c706cdd9..097533e0 100644 --- a/src/charging-station/ui-server/UIWebSocketServer.ts +++ b/src/charging-station/ui-server/UIWebSocketServer.ts @@ -1,151 +1,215 @@ -import { IncomingMessage, createServer } from 'http'; -import type internal from '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'; - -const moduleName = 'UIWebSocketServer'; - -export default class UIWebSocketServer extends AbstractUIServer { - private readonly webSocketServer: WebSocketServer; - - public constructor(protected readonly uiServerConfiguration: UIServerConfiguration) { - super(uiServerConfiguration); - this.httpServer = createServer(); +import type { IncomingMessage } from 'node:http' +import type { Duplex } from 'node:stream' + +import { StatusCodes } from 'http-status-codes' +import { type RawData, WebSocket, WebSocketServer } from 'ws' + +import { AbstractUIServer } from './AbstractUIServer.js' +import { UIServerUtils } from './UIServerUtils.js' +import { + type ProtocolRequest, + type ProtocolResponse, + type UIServerConfiguration, + WebSocketCloseEventStatusCode +} from '../../types/index.js' +import { + Constants, + getWebSocketCloseEventStatusString, + isNotEmptyString, + logPrefix, + logger, + validateUUID +} from '../../utils/index.js' + +const moduleName = 'UIWebSocketServer' + +export class UIWebSocketServer extends AbstractUIServer { + private readonly webSocketServer: WebSocketServer + + public constructor (protected readonly uiServerConfiguration: UIServerConfiguration) { + super(uiServerConfiguration) this.webSocketServer = new WebSocketServer({ - handleProtocols: UIServiceUtils.handleProtocols, - noServer: true, - }); + handleProtocols: UIServerUtils.handleProtocols, + noServer: true + }) } - public start(): void { - this.webSocketServer.on('connection', (ws: WebSocket, req: IncomingMessage): void => { - const [protocol, version] = UIServiceUtils.getProtocolAndVersion(ws.protocol); - if (UIServiceUtils.isProtocolAndVersionSupported(protocol, version) === false) { + public start (): void { + this.webSocketServer.on('connection', (ws: WebSocket, _req: IncomingMessage): void => { + if (!UIServerUtils.isProtocolAndVersionSupported(ws.protocol)) { logger.error( `${this.logPrefix( moduleName, 'start.server.onconnection' - )} Unsupported UI protocol version: '${protocol}${version}'` - ); - ws.close(WebSocketCloseEventStatusCode.CLOSE_PROTOCOL_ERROR); - } - if (this.uiServices.has(version) === false) { - this.uiServices.set(version, UIServiceFactory.getUIServiceImplementation(version, this)); + )} 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 [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)) - .catch(() => { - /* Error caught by AbstractUIService */ - }); - }); + ?.requestHandler(request) + .then((protocolResponse?: ProtocolResponse) => { + if (protocolResponse != null) { + this.sendResponse(protocolResponse) + } + }) + .catch(Constants.EMPTY_FUNCTION) + }) ws.on('error', (error) => { - logger.error(`${this.logPrefix(moduleName, 'start.ws.onerror')} WebSocket 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: '${Utils.getWebSocketCloseEventStatusString( + )} 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(err); - return; - } - this.webSocketServer.handleUpgrade(req, socket, head, (ws: WebSocket) => { - this.webSocketServer.emit('connection', ws, req); - }); - }); + ) + }) + }) + 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() } - ); - if (this.httpServer.listening === false) { - this.httpServer.listen(this.uiServerConfiguration.options); - } - } - - public stop(): void { - this.chargingStations.clear(); + }) + this.httpServer.on('upgrade', (req: IncomingMessage, socket: Duplex, head: Buffer): void => { + this.authenticate(req, (err) => { + if (err != null) { + 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 { - this.broadcastToClients(JSON.stringify(request)); + public sendRequest (request: ProtocolRequest): void { + this.broadcastToClients(JSON.stringify(request)) } - public sendResponse(response: ProtocolResponse): void { - // TODO: send response only to the client that sent the request - this.broadcastToClients(JSON.stringify(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, prefixSuffix?: string): string { - const logMsgPrefix = prefixSuffix - ? `UI WebSocket Server ${prefixSuffix}` - : 'UI WebSocket Server'; + public logPrefix = (modName?: string, methodName?: string, prefixSuffix?: string): string => { + const logMsgPrefix = + prefixSuffix != null ? `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 { + private broadcastToClients (message: string): void { for (const client of this.webSocketServer.clients) { if (client?.readyState === WebSocket.OPEN) { - client.send(message); - } - } - } - - private authenticate(req: IncomingMessage, next: (err: Error) => void): void { - if (this.isBasicAuthEnabled() === true) { - if (this.isValidBasicAuth(req) === false) { - next(new Error('Unauthorized')); - } else { - next(undefined); + client.send(message) } - } else { - next(undefined); } } - private validateRawDataRequest(rawData: RawData): ProtocolRequest { + 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()}` - // ); - - const request = JSON.parse(rawData.toString()) as ProtocolRequest; - - if (Array.isArray(request) === false) { - throw new BaseError('UI protocol request is not an array'); + // ) + + // eslint-disable-next-line @typescript-eslint/no-base-to-string + const request = JSON.parse(rawData.toString()) as ProtocolRequest + + if (!Array.isArray(request)) { + 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 (!validateUUID(request?.[0])) { + logger.error( + `${this.logPrefix( + moduleName, + 'validateRawDataRequest' + )} UI protocol request UUID field is invalid:`, + request + ) + return false } - return request; + return request } }