UI Server: factor out responses handling logic in abstract class

[e-mobility-charging-stations-simulator.git] / src / charging-station / ui-server / UIHttpServer.ts

diff --git a/src/charging-station/ui-server/UIHttpServer.ts b/src/charging-station/ui-server/UIHttpServer.ts
index 9f423ce4157a61d5aa89f25e417dbf34765ad930..d1615dbbcb893a3bae3454ad5aceac7a2cfb6a8d 100644 (file)
--- a/src/charging-station/ui-server/UIHttpServer.ts
+++ b/src/charging-station/ui-server/UIHttpServer.ts
@@ -1,76 +1,73 @@
-import { IncomingMessage, RequestListener, Server, ServerResponse } from 'http';
+import type { IncomingMessage, RequestListener, ServerResponse } from 'http';
 
 import { StatusCodes } from 'http-status-codes';
 
 import BaseError from '../../exception/BaseError';
-import type { ServerOptions } from '../../types/ConfigurationData';
+import type { UIServerConfiguration } from '../../types/ConfigurationData';
 import {
   ProcedureName,
   Protocol,
+  ProtocolRequest,
   ProtocolResponse,
   ProtocolVersion,
   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 {
-    if ((this.server as Server).listening === false) {
-      (this.server as Server).listen(this.options ?? Configuration.getUIServer().options);
+    this.httpServer.on('request', this.requestListener.bind(this) as RequestListener);
+    if (this.httpServer.listening === false) {
+      this.httpServer.listen(this.uiServerConfiguration.options);
     }
   }
 
-  public stop(): void {
-    this.chargingStations.clear();
-    this.responseHandlers.clear();
-  }
-
   // 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;
-    const statusCode = this.responseStatusToStatusCode(payload.status);
+  public sendResponse(response: ProtocolResponse): void {
+    const [uuid, payload] = response;
     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();
+      const res = this.responseHandlers.get(uuid) as ServerResponse;
+      res.writeHead(this.responseStatusToStatusCode(payload.status), {
+        'Content-Type': 'application/json',
+      });
+      res.end(JSON.stringify(payload));
       this.responseHandlers.delete(uuid);
     } else {
       logger.error(
-        `${this.logPrefix()} ${moduleName}.sendResponse: Response for unknown request: ${response}`
+        `${this.logPrefix(moduleName, 'sendResponse')} Response for unknown request id: ${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 |';
+      modName && methodName ? ` ${logMsgPrefix} | ${modName}.${methodName}:` : ` ${logMsgPrefix} |`;
     return Utils.logPrefix(logMsg);
   }
 
   private requestListener(req: IncomingMessage, res: ServerResponse): void {
+    if (this.authenticate(req) === false) {
+      res.setHeader('Content-Type', 'text/plain');
+      res.setHeader('WWW-Authenticate', 'Basic realm=users');
+      res.writeHead(StatusCodes.UNAUTHORIZED);
+      res.end(`${StatusCodes.UNAUTHORIZED} Unauthorized`);
+      return;
+    }
     // Expected request URL pathname: /ui/:version/:procedureName
     const [protocol, version, procedureName] = req.url?.split('/').slice(1) as [
       Protocol,
@@ -78,20 +75,18 @@ 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.isProtocolSupported(protocol, version) === false) {
+      if (UIServiceUtils.isProtocolAndVersionSupported(protocol, version) === false) {
         throw new BaseError(`Unsupported UI protocol version: '/${protocol}/${version}'`);
       }
+      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') {
         const bodyBuffer = [];
         req
@@ -121,6 +116,16 @@ export default class UIHttpServer extends AbstractUIServer {
     }
   }
 
+  private authenticate(req: IncomingMessage): boolean {
+    if (this.isBasicAuthEnabled() === true) {
+      if (this.isValidBasicAuth(req) === true) {
+        return true;
+      }
+      return false;
+    }
+    return true;
+  }
+
   private responseStatusToStatusCode(status: ResponseStatus): StatusCodes {
     switch (status) {
       case ResponseStatus.SUCCESS: