refactor(simulator): constify and factor out empty data structure

[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 d1615dbbcb893a3bae3454ad5aceac7a2cfb6a8d..9e33302682533c68d39e9536cc878bd15a3b68c6 100644 (file)
--- a/src/charging-station/ui-server/UIHttpServer.ts
+++ b/src/charging-station/ui-server/UIHttpServer.ts
@@ -1,35 +1,38 @@
-import type { IncomingMessage, RequestListener, ServerResponse } from 'http';
+import type { IncomingMessage, RequestListener, ServerResponse } from 'node:http';
 
 import { StatusCodes } from 'http-status-codes';
 
-import BaseError from '../../exception/BaseError';
-import type { UIServerConfiguration } from '../../types/ConfigurationData';
+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 logger from '../../utils/Logger';
-import Utils from '../../utils/Utils';
-import { AbstractUIServer } from './AbstractUIServer';
-import { UIServiceUtils } from './ui-services/UIServiceUtils';
+  type UIServerConfiguration,
+} from '../../types';
+import { Constants, Utils, logger } from '../../utils';
+import { AbstractUIServer, UIServerUtils } from '../internal';
 
 const moduleName = 'UIHttpServer';
 
-export default class UIHttpServer extends AbstractUIServer {
+enum HttpMethods {
+  GET = 'GET',
+  PUT = 'PUT',
+  POST = 'POST',
+  PATCH = 'PATCH',
+}
+
+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);
-    if (this.httpServer.listening === false) {
-      this.httpServer.listen(this.uiServerConfiguration.options);
-    }
+    this.startHttpServer();
   }
 
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -39,35 +42,51 @@ export default class UIHttpServer extends AbstractUIServer {
 
   public sendResponse(response: ProtocolResponse): void {
     const [uuid, payload] = response;
-    if (this.responseHandlers.has(uuid) === true) {
-      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 {
+    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 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 {
-    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;
-    }
+    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,
@@ -77,8 +96,9 @@ export default class UIHttpServer extends AbstractUIServer {
     const uuid = Utils.generateUUID();
     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) => {
@@ -87,7 +107,7 @@ export default class UIHttpServer extends AbstractUIServer {
           error
         );
       });
-      if (req.method === 'POST') {
+      if (req.method === HttpMethods.POST) {
         const bodyBuffer = [];
         req
           .on('data', (chunk) => {
@@ -97,12 +117,14 @@ 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
+                )
+              )
+              .catch(Constants.EMPTY_FUNCTION);
           });
       } else {
         throw new BaseError(`Unsupported HTTP method: '${req.method}'`);
@@ -116,16 +138,6 @@ 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: