UI HTTP server: fix stop simulator response handling

[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 0731b3c09712f7df1841e679227fb3b30c642184..a6a6313e02182b6dbd0e1e4c5aaaf417f9ee9728 100644 (file)
--- a/src/charging-station/ui-server/UIHttpServer.ts
+++ b/src/charging-station/ui-server/UIHttpServer.ts
@@ -3,14 +3,14 @@ import { IncomingMessage, RequestListener, Server, ServerResponse } from 'http';
 import { StatusCodes } from 'http-status-codes';
 
 import BaseError from '../../exception/BaseError';
-import { ServerOptions } from '../../types/ConfigurationData';
+import type { ServerOptions } from '../../types/ConfigurationData';
 import {
   ProcedureName,
   Protocol,
+  ProtocolRequest,
   ProtocolResponse,
   ProtocolVersion,
   RequestPayload,
-  ResponsePayload,
   ResponseStatus,
 } from '../../types/UIProtocol';
 import Configuration from '../../utils/Configuration';
@@ -34,7 +34,9 @@ export default class UIHttpServer extends AbstractUIServer {
   }
 
   public start(): void {
-    (this.server as Server).listen(this.options ?? Configuration.getUIServer().options);
+    if ((this.server as Server).listening === false) {
+      (this.server as Server).listen(this.options ?? Configuration.getUIServer().options);
+    }
   }
 
   public stop(): void {
@@ -42,23 +44,14 @@ export default class UIHttpServer extends AbstractUIServer {
   }
 
   // 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)) {
+  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));
@@ -66,14 +59,15 @@ export default class UIHttpServer extends AbstractUIServer {
       this.responseHandlers.delete(uuid);
     } else {
       logger.error(
-        `${this.logPrefix()} ${moduleName}.sendResponse: Response received 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);
   }
 
@@ -87,54 +81,55 @@ export default class UIHttpServer extends AbstractUIServer {
     const uuid = Utils.generateUUID();
     this.responseHandlers.set(uuid, { procedureName, res });
     try {
-      if (UIServiceUtils.isProtocolSupported(protocol, version) === false) {
+      if (UIServiceUtils.isProtocolAndVersionSupported(protocol, version) === false) {
         throw new BaseError(`Unsupported UI protocol version: '/${protocol}/${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)) {
+      if (this.uiServices.has(version) === false) {
         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 }));
+                this.sendResponse(
+                  this.buildProtocolResponse(uuid, { status: ResponseStatus.FAILURE })
+                );
               });
           });
       } 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;
+    }
   }
 }