-import type { IncomingMessage } from 'http';
-import type internal from 'stream';
-
-import { StatusCodes } from 'http-status-codes';
-import WebSocket, { type RawData, WebSocketServer } from 'ws';
-
-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 { UIServerUtils } from './UIServerUtils';
-
-const moduleName = 'UIWebSocketServer';
-
-export default class UIWebSocketServer extends AbstractUIServer {
- private readonly webSocketServer: WebSocketServer;
-
- public constructor(protected readonly uiServerConfiguration: UIServerConfiguration) {
- super(uiServerConfiguration);
+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 {
+ 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'
+
+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,
- });
+ handleProtocols,
+ noServer: true
+ })
}
- public start(): void {
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
- this.webSocketServer.on('connection', (ws: WebSocket, req: IncomingMessage): void => {
- if (UIServerUtils.isProtocolAndVersionSupported(ws.protocol) === false) {
+ 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);
+ )
+ ws.close(WebSocketCloseEventStatusCode.CLOSE_PROTOCOL_ERROR)
}
- const [, version] = UIServerUtils.getProtocolAndVersion(ws.protocol);
- this.registerProtocolVersionUIService(version);
- ws.on('message', (rawData) => {
- const request = this.validateRawDataRequest(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;
+ ws.close(WebSocketCloseEventStatusCode.CLOSE_INVALID_PAYLOAD)
+ return
}
- const [requestId] = request as ProtocolRequest;
- this.responseHandlers.set(requestId, ws);
+ const [requestId] = request
+ this.responseHandlers.set(requestId, ws)
this.uiServices
.get(version)
- .requestHandler(request)
- .catch(() => {
- /* Error caught by AbstractUIService */
- });
- });
- ws.on('error', (error) => {
- logger.error(`${this.logPrefix(moduleName, 'start.ws.onerror')} WebSocket 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: '${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();
- 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()
}
- );
- this.startHttpServer();
+ })
+ this.httpServer.on('upgrade', (req: IncomingMessage, socket: Duplex, head: Buffer): void => {
+ const onSocketError = (error: Error): void => {
+ logger.error(
+ `${this.logPrefix(
+ moduleName,
+ 'start.httpServer.on.upgrade'
+ )} Socket error at connection upgrade event handling:`,
+ error
+ )
+ }
+ 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: ProtocolRequest): void {
- this.broadcastToClients(JSON.stringify(request));
+ public sendRequest (request: ProtocolRequest): void {
+ this.broadcastToClients(JSON.stringify(request))
}
- public sendResponse(response: ProtocolResponse): void {
- const responseId = response[0];
+ public sendResponse (response: ProtocolResponse): void {
+ 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));
+ 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
+ ws.readyState
}`
- );
+ )
}
} else {
logger.error(
moduleName,
'sendResponse'
)} Response for unknown request id: ${responseId}`
- );
+ )
}
} catch (error) {
logger.error(
'sendResponse'
)} Error at sending response id '${responseId}':`,
error
- );
+ )
} finally {
- this.responseHandlers.delete(responseId);
+ 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);
+ if (client.readyState === WebSocket.OPEN) {
+ client.send(message)
}
}
}
- private validateRawDataRequest(rawData: RawData): ProtocolRequest | false {
+ 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;
+ 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) === false) {
+ if (!Array.isArray(request)) {
logger.error(
`${this.logPrefix(
moduleName,
'validateRawDataRequest'
)} UI protocol request is not an array:`,
request
- );
- return false;
+ )
+ 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;
+ )
+ return false
}
- if (Utils.validateUUID(request[0]) === false) {
+ if (!validateUUID(request[0])) {
logger.error(
`${this.logPrefix(
moduleName,
'validateRawDataRequest'
)} UI protocol request UUID field is invalid:`,
request
- );
- return false;
+ )
+ return false
}
- return request;
+ return request
}
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff