-import { IncomingMessage, RequestListener, Server, ServerResponse } from 'http';
+import type { IncomingMessage, RequestListener, ServerResponse } from 'http';
import { StatusCodes } from 'http-status-codes';
+import { AbstractUIServer } from './AbstractUIServer';
+import { UIServerUtils } from './UIServerUtils';
import BaseError from '../../exception/BaseError';
-import { ServerOptions } from '../../types/ConfigurationData';
+import type { UIServerConfiguration } from '../../types/ConfigurationData';
import {
- ProcedureName,
- Protocol,
- ProtocolResponse,
- ProtocolVersion,
- RequestPayload,
- ResponsePayload,
+ 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 };
-
export default class UIHttpServer extends AbstractUIServer {
- private readonly responseHandlers: Map<string, responseHandler>;
-
- public constructor(private options?: ServerOptions) {
- super();
- this.server = new Server(this.requestListener.bind(this) as RequestListener);
- this.responseHandlers = new Map<string, responseHandler>();
+ public constructor(protected readonly uiServerConfiguration: UIServerConfiguration) {
+ super(uiServerConfiguration);
}
public start(): void {
- (this.server as Server).listen(this.options ?? Configuration.getUIServer().options);
- }
-
- public stop(): void {
- this.chargingStations.clear();
+ this.httpServer.on('request', this.requestListener.bind(this) as RequestListener);
+ this.startHttpServer();
}
// eslint-disable-next-line @typescript-eslint/no-unused-vars
- public sendRequest(request: string): void {
+ public sendRequest(request: ProtocolRequest): void {
// This is intentionally left blank
}
- public sendResponse(response: string): void {
- const [uuid, payload] = JSON.parse(response) as ProtocolResponse;
- let statusCode: StatusCodes;
- switch (payload.status) {
- case ResponseStatus.SUCCESS:
- statusCode = StatusCodes.OK;
- break;
- case ResponseStatus.FAILURE:
- default:
- statusCode = StatusCodes.BAD_REQUEST;
- break;
- }
- 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.responseHandlers.has(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 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 ? `UI HTTP Server ${prefixSuffix}` : 'UI HTTP Server';
const logMsg =
- modName && methodName ? ` UI HTTP Server | ${modName}.${methodName}:` : ' UI HTTP Server |';
+ 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,
ProcedureName
];
const uuid = Utils.generateUUID();
- this.responseHandlers.set(uuid, { procedureName, res });
+ 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) === 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 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;
req
.on('data', (chunk) => {
bodyBuffer.push(chunk);
})
.on('end', () => {
- body = JSON.parse(Buffer.concat(bodyBuffer).toString()) as RequestPayload;
+ const body = JSON.parse(Buffer.concat(bodyBuffer).toString()) as RequestPayload;
this.uiServices
.get(version)
- .requestHandler(this.buildRequest(uuid, procedureName, body ?? {}))
+ ?.requestHandler(this.buildProtocolRequest(uuid, procedureName, body ?? {}))
.catch(() => {
- this.sendResponse(this.buildResponse(uuid, { status: ResponseStatus.FAILURE }));
+ /* Error caught by AbstractUIService */
});
});
} else {
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 {
+ switch (status) {
+ case ResponseStatus.SUCCESS:
+ return StatusCodes.OK;
+ case ResponseStatus.FAILURE:
+ return StatusCodes.BAD_REQUEST;
+ default:
+ return StatusCodes.INTERNAL_SERVER_ERROR;
+ }
}
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff