X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2FUIHttpServer.ts;h=159559df1f4cacb6eebaa1f67b8e6cca66ac030a;hb=be245fdab36274873e0a9651589cebd097548076;hp=152529373d375f033985f571989ed8e31cc63dba;hpb=5e3cb7281de2b6fa8b61a453f964c2f213fefa80;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 15252937..159559df 100644 --- a/src/charging-station/ui-server/UIHttpServer.ts +++ b/src/charging-station/ui-server/UIHttpServer.ts @@ -1,47 +1,39 @@ -import { IncomingMessage, RequestListener, Server, ServerResponse } from 'http'; +import type { IncomingMessage, RequestListener, ServerResponse } from 'node:http'; import { StatusCodes } from 'http-status-codes'; -import BaseError from '../../exception/BaseError'; -import type { ServerOptions } from '../../types/ConfigurationData'; +import { AbstractUIServer } from './AbstractUIServer'; +import { UIServerUtils } from './UIServerUtils'; +import { BaseError } from '../../exception'; import { - ProcedureName, - Protocol, - ProtocolRequest, - ProtocolResponse, - ProtocolVersion, - RequestPayload, + type ProcedureName, + type Protocol, + type ProtocolRequest, + type ProtocolResponse, + type ProtocolVersion, + type RequestPayload, ResponseStatus, -} 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 { UIServiceUtils } from './ui-services/UIServiceUtils'; + type UIServerConfiguration, +} from '../../types'; +import { Constants, Utils, logger } from '../../utils'; const moduleName = 'UIHttpServer'; -type responseHandler = { procedureName: ProcedureName; res: ServerResponse }; - -export default class UIHttpServer extends AbstractUIServer { - private readonly responseHandlers: Map; +enum HttpMethods { + GET = 'GET', + PUT = 'PUT', + POST = 'POST', + PATCH = 'PATCH', +} - public constructor(private options?: ServerOptions) { - super(); - this.server = new Server(this.requestListener.bind(this) as RequestListener); - this.responseHandlers = new Map(); +export class UIHttpServer extends AbstractUIServer { + public constructor(protected readonly uiServerConfiguration: UIServerConfiguration) { + super(uiServerConfiguration); } public start(): void { - if ((this.server as Server).listening === false) { - (this.server as Server).listen(this.options ?? Configuration.getUIServer().options); - } - } - - public stop(): void { - this.chargingStations.clear(); - this.responseHandlers.clear(); + this.httpServer.on('request', this.requestListener.bind(this) as RequestListener); + this.startHttpServer(); } // eslint-disable-next-line @typescript-eslint/no-unused-vars @@ -51,28 +43,51 @@ export default class UIHttpServer extends AbstractUIServer { public sendResponse(response: ProtocolResponse): void { const [uuid, payload] = response; - const statusCode = this.responseStatusToStatusCode(payload.status); - if (this.responseHandlers.has(uuid) === true) { - const { res } = this.responseHandlers.get(uuid); - res.writeHead(statusCode, { 'Content-Type': 'application/json' }); - res.write(JSON.stringify(payload)); - res.end(); - this.responseHandlers.delete(uuid); - } else { + try { + if (this.hasResponseHandler(uuid) === true) { + const res = this.responseHandlers.get(uuid) as ServerResponse; + res + .writeHead(this.responseStatusToStatusCode(payload.status), { + 'Content-Type': 'application/json', + }) + .end(JSON.stringify(payload)); + } else { + logger.error( + `${this.logPrefix(moduleName, 'sendResponse')} Response for unknown request id: ${uuid}` + ); + } + } catch (error) { logger.error( - `${this.logPrefix(moduleName, 'sendResponse')} Response for unknown request id: ${uuid}` + `${this.logPrefix(moduleName, 'sendResponse')} Error at sending response id '${uuid}':`, + error ); + } finally { + this.responseHandlers.delete(uuid); } } - public logPrefix(modName?: string, methodName?: string, prefixSuffix?: string): string { + public logPrefix = (modName?: string, methodName?: string, prefixSuffix?: string): string => { const logMsgPrefix = prefixSuffix ? `UI HTTP Server ${prefixSuffix}` : 'UI HTTP Server'; const logMsg = - modName && methodName ? ` ${logMsgPrefix} | ${modName}.${methodName}:` : ` ${logMsgPrefix} |`; + Utils.isNotEmptyString(modName) && Utils.isNotEmptyString(methodName) + ? ` ${logMsgPrefix} | ${modName}.${methodName}:` + : ` ${logMsgPrefix} |`; return Utils.logPrefix(logMsg); - } + }; private requestListener(req: IncomingMessage, res: ServerResponse): void { + this.authenticate(req, (err) => { + if (err) { + res + .writeHead(StatusCodes.UNAUTHORIZED, { + 'Content-Type': 'text/plain', + 'WWW-Authenticate': 'Basic realm=users', + }) + .end(`${StatusCodes.UNAUTHORIZED} Unauthorized`) + .destroy(); + req.destroy(); + } + }); // Expected request URL pathname: /ui/:version/:procedureName const [protocol, version, procedureName] = req.url?.split('/').slice(1) as [ Protocol, @@ -80,21 +95,20 @@ export default class UIHttpServer extends AbstractUIServer { ProcedureName ]; const uuid = Utils.generateUUID(); - this.responseHandlers.set(uuid, { procedureName, res }); + this.responseHandlers.set(uuid, res); try { - if (UIServiceUtils.isProtocolAndVersionSupported(protocol, version) === false) { - throw new BaseError(`Unsupported UI protocol version: '/${protocol}/${version}'`); + const fullProtocol = `${protocol}${version}`; + if (UIServerUtils.isProtocolAndVersionSupported(fullProtocol) === false) { + throw new BaseError(`Unsupported UI protocol version: '${fullProtocol}'`); } + this.registerProtocolVersionUIService(version); req.on('error', (error) => { logger.error( `${this.logPrefix(moduleName, 'requestListener.req.onerror')} Error on HTTP request:`, error ); }); - if (!this.uiServices.has(version)) { - this.uiServices.set(version, UIServiceFactory.getUIServiceImplementation(version, this)); - } - if (req.method === 'POST') { + if (req.method === HttpMethods.POST) { const bodyBuffer = []; req .on('data', (chunk) => { @@ -104,12 +118,19 @@ export default class UIHttpServer extends AbstractUIServer { const body = JSON.parse(Buffer.concat(bodyBuffer).toString()) as RequestPayload; this.uiServices .get(version) - .requestHandler(this.buildProtocolRequest(uuid, procedureName, body ?? {})) - .catch(() => { - this.sendResponse( - this.buildProtocolResponse(uuid, { status: ResponseStatus.FAILURE }) - ); - }); + ?.requestHandler( + this.buildProtocolRequest( + uuid, + procedureName, + body ?? Constants.EMPTY_FREEZED_OBJECT + ) + ) + .then((protocolResponse: ProtocolResponse) => { + if (!Utils.isNullOrUndefined(protocolResponse)) { + this.sendResponse(protocolResponse); + } + }) + .catch(Constants.EMPTY_FUNCTION); }); } else { throw new BaseError(`Unsupported HTTP method: '${req.method}'`);