X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2FUIHttpServer.ts;h=eafea59ad3ec2398be9f1e4c2c526e829c7e98d2;hb=3000c1258ccda0c8828f4e4fffb988e5ffaa84da;hp=2d729bfc3be22b57ca4a0e71e26702245e5fedd2;hpb=771633ffad91ad096e5b837f3b102b3251e39633;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 2d729bfc..eafea59a 100644 --- a/src/charging-station/ui-server/UIHttpServer.ts +++ b/src/charging-station/ui-server/UIHttpServer.ts @@ -1,142 +1,174 @@ -import { IncomingMessage, RequestListener, Server, ServerResponse } from 'http'; +import type { IncomingMessage, ServerResponse } from 'node:http' -import { StatusCodes } from 'http-status-codes'; +import { StatusCodes } from 'http-status-codes' -import BaseError from '../../exception/BaseError'; -import { ServerOptions } from '../../types/ConfigurationData'; +import { AbstractUIServer } from './AbstractUIServer.js' +import { UIServerUtils } from './UIServerUtils.js' +import { BaseError } from '../../exception/index.js' import { - ProcedureName, - Protocol, - ProtocolResponse, - ProtocolVersion, - RequestPayload, - ResponsePayload, + ApplicationProtocolVersion, + 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'; - -const moduleName = 'UIHttpServer'; - -type responseHandler = { procedureName: ProcedureName; res: ServerResponse }; + type UIServerConfiguration +} from '../../types/index.js' +import { + Constants, + JSONStringifyWithMapSupport, + generateUUID, + isNotEmptyString, + logPrefix, + logger +} from '../../utils/index.js' -export default class UIHttpServer extends AbstractUIServer { - private readonly responseHandlers: Map; +const moduleName = 'UIHttpServer' - public constructor(private options?: ServerOptions) { - super(); - this.server = new Server(this.requestListener.bind(this) as RequestListener); - this.responseHandlers = new Map(); - } +enum HttpMethods { + GET = 'GET', + PUT = 'PUT', + POST = 'POST', + PATCH = 'PATCH' +} - public start(): void { - (this.server as Server).listen(this.options ?? Configuration.getUIServer().options); +export class UIHttpServer extends AbstractUIServer { + public constructor (protected readonly uiServerConfiguration: UIServerConfiguration) { + super(uiServerConfiguration) } - public stop(): void { - this.chargingStations.clear(); + 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: string): 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: string): void { - const [uuid, payload] = JSON.parse(response) as ProtocolResponse; - const statusCode = this.responseStatusToStatusCode(payload.status); - if (this.responseHandlers.has(uuid)) { - 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 { + public sendResponse (response: ProtocolResponse): void { + const [uuid, payload] = response + try { + if (this.hasResponseHandler(uuid)) { + const res = this.responseHandlers.get(uuid) as ServerResponse + res + .writeHead(this.responseStatusToStatusCode(payload.status), { + 'Content-Type': 'application/json' + }) + .end(JSONStringifyWithMapSupport(payload)) + } else { + logger.error( + `${this.logPrefix(moduleName, 'sendResponse')} Response for unknown request id: ${uuid}` + ) + } + } catch (error) { logger.error( - `${this.logPrefix()} ${moduleName}.sendResponse: Response received for unknown request: ${response}` - ); + `${this.logPrefix(moduleName, 'sendResponse')} Error at sending response id '${uuid}':`, + error + ) + } finally { + this.responseHandlers.delete(uuid) } } - public logPrefix(modName?: string, methodName?: string): string { + public logPrefix = (modName?: string, methodName?: string, prefixSuffix?: string): string => { + const logMsgPrefix = prefixSuffix != null ? `UI HTTP Server ${prefixSuffix}` : 'UI HTTP Server' const logMsg = - modName && methodName ? ` UI HTTP Server | ${modName}.${methodName}:` : ' UI HTTP Server |'; - return Utils.logPrefix(logMsg); + isNotEmptyString(modName) && isNotEmptyString(methodName) + ? ` ${logMsgPrefix} | ${modName}.${methodName}:` + : ` ${logMsgPrefix} |` + return logPrefix(logMsg) } - private requestListener(req: IncomingMessage, res: ServerResponse): void { + 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' + }) + .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, ProtocolVersion, ProcedureName - ]; - const uuid = Utils.generateUUID(); - this.responseHandlers.set(uuid, { procedureName, res }); + ] + const uuid = generateUUID() + this.responseHandlers.set(uuid, res) try { - if (UIServiceUtils.isProtocolSupported(protocol, version) === false) { - throw new BaseError(`Unsupported UI protocol version: '/${protocol}/${version}'`); + const fullProtocol = `${protocol}${version}` + if (!UIServerUtils.isProtocolAndVersionSupported(fullProtocol)) { + throw new BaseError(`Unsupported UI protocol version: '${fullProtocol}'`) } - req.on('error', (error) => { + this.registerProtocolVersionUIService(version) + req.on('error', error => { logger.error( - `${this.logPrefix( - moduleName, - 'requestListener.req.onerror' - )} Error at incoming request handling:`, + `${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') { - const bodyBuffer = []; - let body: RequestPayload; + ) + }) + if (req.method === HttpMethods.POST) { + const bodyBuffer: Uint8Array[] = [] req - .on('data', (chunk) => { - bodyBuffer.push(chunk); + .on('data', (chunk: Uint8Array) => { + bodyBuffer.push(chunk) }) .on('end', () => { - 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.buildRequest(uuid, procedureName, body ?? {})) - .catch(() => { - this.sendResponse(this.buildResponse(uuid, { status: ResponseStatus.FAILURE })); - }); - }); + ?.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) { - this.sendResponse(this.buildResponse(uuid, { status: ResponseStatus.FAILURE })); + logger.error( + `${this.logPrefix(moduleName, 'requestListener')} Handle HTTP request error:`, + error + ) + this.sendResponse(this.buildProtocolResponse(uuid, { status: ResponseStatus.FAILURE })) } } - private buildRequest( - id: string, - procedureName: ProcedureName, - requestPayload: RequestPayload - ): string { - return JSON.stringify([id, procedureName, requestPayload]); - } - - private buildResponse(id: string, responsePayload: ResponsePayload): string { - return JSON.stringify([id, responsePayload]); - } - - 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 } } }