X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2FUIHttpServer.ts;h=5bcae7beff6ed84fc6d0e202437361bc7f1c3725;hb=refs%2Fheads%2Fmain;hp=87f10a5eab41ef30ce19d0dd5211320900d9697e;hpb=78202038ffd2aca15aa97f45bc66ba42f40f2ec4;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ui-server/UIHttpServer.ts b/src/charging-station/ui-server/UIHttpServer.ts index 87f10a5e..5bcae7be 100644 --- a/src/charging-station/ui-server/UIHttpServer.ts +++ b/src/charging-station/ui-server/UIHttpServer.ts @@ -1,12 +1,11 @@ -import type { IncomingMessage, RequestListener, ServerResponse } from 'http'; +import type { IncomingMessage, ServerResponse } from 'node:http' -import { StatusCodes } from 'http-status-codes'; +import { StatusCodes } from 'http-status-codes' -import { AbstractUIServer } from './AbstractUIServer'; -import { UIServerUtils } from './UIServerUtils'; -import BaseError from '../../exception/BaseError'; -import type { UIServerConfiguration } from '../../types/ConfigurationData'; +import { BaseError } from '../../exception/index.js' import { + ApplicationProtocolVersion, + MapStringifyFormat, type ProcedureName, type Protocol, type ProtocolRequest, @@ -14,127 +13,163 @@ import { type ProtocolVersion, type RequestPayload, ResponseStatus, -} from '../../types/UIProtocol'; -import logger from '../../utils/Logger'; -import Utils from '../../utils/Utils'; + type UIServerConfiguration +} from '../../types/index.js' +import { + Constants, + generateUUID, + isNotEmptyString, + JSONStringify, + logger, + logPrefix +} from '../../utils/index.js' +import { AbstractUIServer } from './AbstractUIServer.js' +import { isProtocolAndVersionSupported } from './UIServerUtils.js' + +const moduleName = 'UIHttpServer' -const moduleName = 'UIHttpServer'; +enum HttpMethods { + GET = 'GET', + PUT = 'PUT', + POST = 'POST', + PATCH = 'PATCH' +} -export default class UIHttpServer extends AbstractUIServer { - public constructor(protected readonly uiServerConfiguration: UIServerConfiguration) { - super(uiServerConfiguration); +export class UIHttpServer extends AbstractUIServer { + public constructor (protected readonly uiServerConfiguration: UIServerConfiguration) { + super(uiServerConfiguration) } - public start(): void { - this.httpServer.on('request', this.requestListener.bind(this) as RequestListener); - this.startHttpServer(); + public start (): void { + this.httpServer.on('request', this.requestListener.bind(this)) + this.startHttpServer() } - // eslint-disable-next-line @typescript-eslint/no-unused-vars - public sendRequest(request: ProtocolRequest): void { - // This is intentionally left blank + public sendRequest (request: ProtocolRequest): void { + switch (this.uiServerConfiguration.version) { + case ApplicationProtocolVersion.VERSION_20: + this.httpServer.emit('request', request) + break + } } - public sendResponse(response: ProtocolResponse): void { - const [uuid, payload] = response; + public sendResponse (response: ProtocolResponse): void { + const [uuid, payload] = response try { - if (this.responseHandlers.has(uuid) === true) { - const res = this.responseHandlers.get(uuid) as ServerResponse; + if (this.hasResponseHandler(uuid)) { + const res = this.responseHandlers.get(uuid) as ServerResponse res .writeHead(this.responseStatusToStatusCode(payload.status), { - 'Content-Type': 'application/json', + 'Content-Type': 'application/json' }) - .end(JSON.stringify(payload)); + .end(JSONStringify(payload, undefined, MapStringifyFormat.object)) } else { logger.error( `${this.logPrefix(moduleName, 'sendResponse')} Response for unknown request id: ${uuid}` - ); + ) } } catch (error) { logger.error( `${this.logPrefix(moduleName, 'sendResponse')} Error at sending response id '${uuid}':`, error - ); + ) } finally { - this.responseHandlers.delete(uuid); + this.responseHandlers.delete(uuid) } } - public logPrefix(modName?: string, methodName?: string, prefixSuffix?: string): string { - const logMsgPrefix = prefixSuffix ? `UI HTTP Server ${prefixSuffix}` : 'UI HTTP Server'; + public logPrefix = (modName?: string, methodName?: string, prefixSuffix?: string): string => { + const logMsgPrefix = prefixSuffix != null ? `UI HTTP Server ${prefixSuffix}` : 'UI HTTP 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 requestListener(req: IncomingMessage, res: ServerResponse): void { - this.authenticate(req, (err) => { - if (err) { + private requestListener (req: IncomingMessage, res: ServerResponse): void { + this.authenticate(req, err => { + if (err != null) { res .writeHead(StatusCodes.UNAUTHORIZED, { 'Content-Type': 'text/plain', - 'WWW-Authenticate': 'Basic realm=users', + 'WWW-Authenticate': 'Basic realm=users' }) .end(`${StatusCodes.UNAUTHORIZED} Unauthorized`) - .destroy(); - req.destroy(); + res.destroy() + req.destroy() } - }); + }) // Expected request URL pathname: /ui/:version/:procedureName const [protocol, version, procedureName] = req.url?.split('/').slice(1) as [ Protocol, ProtocolVersion, ProcedureName - ]; - const uuid = Utils.generateUUID(); - this.responseHandlers.set(uuid, res); + ] + const uuid = generateUUID() + this.responseHandlers.set(uuid, res) try { - const fullProtocol = `${protocol}${version}`; - if (UIServerUtils.isProtocolAndVersionSupported(fullProtocol) === false) { - throw new BaseError(`Unsupported UI protocol version: '${fullProtocol}'`); + const fullProtocol = `${protocol}${version}` + if (!isProtocolAndVersionSupported(fullProtocol)) { + throw new BaseError(`Unsupported UI protocol version: '${fullProtocol}'`) } - this.registerProtocolVersionUIService(version); - req.on('error', (error) => { + this.registerProtocolVersionUIService(version) + req.on('error', error => { logger.error( `${this.logPrefix(moduleName, 'requestListener.req.onerror')} Error on HTTP request:`, error - ); - }); - if (req.method === 'POST') { - const bodyBuffer = []; + ) + }) + if (req.method === HttpMethods.POST) { + const bodyBuffer: Uint8Array[] = [] req - .on('data', (chunk) => { - bodyBuffer.push(chunk); + .on('data', (chunk: Uint8Array) => { + bodyBuffer.push(chunk) }) .on('end', () => { - const body = JSON.parse(Buffer.concat(bodyBuffer).toString()) as RequestPayload; + let requestPayload: RequestPayload | undefined + try { + requestPayload = JSON.parse(Buffer.concat(bodyBuffer).toString()) as RequestPayload + } catch (error) { + this.sendResponse( + this.buildProtocolResponse(uuid, { + status: ResponseStatus.FAILURE, + errorMessage: (error as Error).message, + errorStack: (error as Error).stack + }) + ) + return + } this.uiServices .get(version) - .requestHandler(this.buildProtocolRequest(uuid, procedureName, body ?? {})) - .catch(() => { - /* Error caught by AbstractUIService */ - }); - }); + ?.requestHandler(this.buildProtocolRequest(uuid, procedureName, requestPayload)) + .then((protocolResponse?: ProtocolResponse) => { + if (protocolResponse != null) { + this.sendResponse(protocolResponse) + } + }) + .catch(Constants.EMPTY_FUNCTION) + }) } else { - throw new BaseError(`Unsupported HTTP method: '${req.method}'`); + throw new BaseError(`Unsupported HTTP method: '${req.method}'`) } } catch (error) { logger.error( `${this.logPrefix(moduleName, 'requestListener')} Handle HTTP request error:`, error - ); - this.sendResponse(this.buildProtocolResponse(uuid, { status: ResponseStatus.FAILURE })); + ) + this.sendResponse(this.buildProtocolResponse(uuid, { status: ResponseStatus.FAILURE })) } } - private responseStatusToStatusCode(status: ResponseStatus): StatusCodes { + private responseStatusToStatusCode (status: ResponseStatus): StatusCodes { switch (status) { case ResponseStatus.SUCCESS: - return StatusCodes.OK; + return StatusCodes.OK case ResponseStatus.FAILURE: - return StatusCodes.BAD_REQUEST; + return StatusCodes.BAD_REQUEST default: - return StatusCodes.INTERNAL_SERVER_ERROR; + return StatusCodes.INTERNAL_SERVER_ERROR } } }