-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 { Protocol, ProtocolVersion } from '../../types/UIProtocol';
-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 {
+ MapStringifyFormat,
+ type ProtocolRequest,
+ type ProtocolResponse,
+ type UIServerConfiguration,
+ WebSocketCloseEventStatusCode
+} from '../../types/index.js'
+import {
+ Constants,
+ getWebSocketCloseEventStatusString,
+ isNotEmptyString,
+ JSONStringify,
+ logger,
+ logPrefix,
+ validateUUID
+} from '../../utils/index.js'
+import { AbstractUIServer } from './AbstractUIServer.js'
+import {
+ getProtocolAndVersion,
+ handleProtocols,
+ isProtocolAndVersionSupported
+} from './UIServerUtils.js'
-const moduleName = 'UIWebSocketServer';
+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,
+ noServer: true
+ })
}
- public start(): void {
- this.server.on('connection', (socket: WebSocket, request: IncomingMessage): void => {
- const protocolIndex = socket.protocol.indexOf(Protocol.UI);
- const version = socket.protocol.substring(
- protocolIndex + Protocol.UI.length
- ) as ProtocolVersion;
- if (!this.uiServices.has(version)) {
- this.uiServices.set(version, UIServiceFactory.getUIServiceImplementation(version, this));
+ public start (): void {
+ this.webSocketServer.on('connection', (ws: WebSocket, _req: IncomingMessage): void => {
+ if (!isProtocolAndVersionSupported(ws.protocol)) {
+ logger.error(
+ `${this.logPrefix(
+ moduleName,
+ 'start.server.onconnection'
+ )} Unsupported UI protocol version: '${ws.protocol}'`
+ )
+ ws.close(WebSocketCloseEventStatusCode.CLOSE_PROTOCOL_ERROR)
}
- // FIXME: check connection validity
- socket.on('message', (rawData) => {
+ const [, version] = 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
+ this.responseHandlers.set(requestId, ws)
this.uiServices
.get(version)
- .requestHandler(rawData)
- .catch(() => {
- /* Error caught by AbstractUIService */
- });
- });
- socket.on('error', (error) => {
+ ?.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)
+ })
+ ws.on('close', (code, reason) => {
+ logger.debug(
+ `${this.logPrefix(
+ moduleName,
+ 'start.ws.onclose'
+ )} WebSocket closed: '${getWebSocketCloseEventStatusString(
+ code
+ )}' - '${reason.toString()}'`
+ )
+ })
+ })
+ 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 => {
+ const onSocketError = (error: Error): void => {
logger.error(
- `${this.logPrefix(moduleName, 'start.socket.onerror')} Error on WebSocket:`,
+ `${this.logPrefix(
+ moduleName,
+ 'start.httpServer.on.upgrade'
+ )} Socket error at connection upgrade event handling:`,
error
- );
- });
- });
- }
-
- public stop(): void {
- this.chargingStations.clear();
+ )
+ }
+ socket.on('error', onSocketError)
+ 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 connection upgrade event handling:`,
+ error
+ )
+ }
+ })
+ socket.removeListener('error', onSocketError)
+ })
+ this.startHttpServer()
}
- 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(JSONStringify(response, undefined, MapStringifyFormat.object))
+ } 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 != null ? `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) {
- if (client?.readyState === WebSocket.OPEN) {
- client.send(message);
+ private broadcastToClients (message: string): void {
+ 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()}`
+ // )
+
+ let request: ProtocolRequest
+ try {
+ // eslint-disable-next-line @typescript-eslint/no-base-to-string
+ request = JSON.parse(rawData.toString()) as ProtocolRequest
+ } catch (error) {
+ logger.error(
+ `${this.logPrefix(
+ moduleName,
+ 'validateRawDataRequest'
+ // eslint-disable-next-line @typescript-eslint/no-base-to-string
+ )} UI protocol request is not valid JSON: ${rawData.toString()}`
+ )
+ return false
+ }
+
+ if (!Array.isArray(request)) {
+ logger.error(
+ `${this.logPrefix(
+ moduleName,
+ 'validateRawDataRequest'
+ )} UI protocol request is not an array:`,
+ request
+ )
+ return false
+ }
+
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+ if (request.length !== 3) {
+ 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
+ }
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff