X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fcharging-station%2Fui-server%2FUIHttpServer.ts;h=ce52ed4b5dd432a9c9035bbdc0eac01c7a422e4f;hb=10db00b2276f4cc7a88dd18e8f6f80593d6458b3;hp=01c0f1b63bba1dec403f7251fc1845cc421f9c93;hpb=1f7fa4de53a1b28324f362402f61b81b28d75c2c;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 01c0f1b6..ce52ed4b 100644
--- a/src/charging-station/ui-server/UIHttpServer.ts
+++ b/src/charging-station/ui-server/UIHttpServer.ts
@@ -1,19 +1,18 @@
 import { IncomingMessage, RequestListener, Server, ServerResponse } from 'http';
 
-import StatusCodes from 'http-status-codes';
+import { StatusCodes } from 'http-status-codes';
 
 import BaseError from '../../exception/BaseError';
-import { ServerOptions } from '../../types/ConfigurationData';
+import type { UIServerConfiguration } from '../../types/ConfigurationData';
 import {
   ProcedureName,
   Protocol,
+  ProtocolRequest,
   ProtocolResponse,
   ProtocolVersion,
   RequestPayload,
-  ResponsePayload,
   ResponseStatus,
 } from '../../types/UIProtocol';
-import Configuration from '../../utils/Configuration';
 import logger from '../../utils/Logger';
 import Utils from '../../utils/Utils';
 import { AbstractUIServer } from './AbstractUIServer';
@@ -27,14 +26,16 @@ 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);
+  public constructor(protected readonly uiServerConfiguration: UIServerConfiguration) {
+    super(uiServerConfiguration);
+    this.httpServer = new Server(this.requestListener.bind(this) as RequestListener);
     this.responseHandlers = new Map<string, responseHandler>();
   }
 
   public start(): void {
-    (this.server as Server).listen(this.options ?? Configuration.getUIServer().options);
+    if (this.httpServer.listening === false) {
+      this.httpServer.listen(this.uiServerConfiguration.options);
+    }
   }
 
   public stop(): void {
@@ -42,42 +43,42 @@ 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: number;
-    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 { procedureName, res } = this.responseHandlers.get(uuid);
-      res.writeHead(statusCode, { 'Content-Type': 'application/json' });
+  public sendResponse(response: ProtocolResponse): void {
+    const [uuid, payload] = response;
+    if (this.responseHandlers.has(uuid) === true) {
+      const { res } = this.responseHandlers.get(uuid);
+      res.writeHead(this.responseStatusToStatusCode(payload.status), {
+        'Content-Type': 'application/json',
+      });
       res.write(JSON.stringify(payload));
       res.end();
       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);
   }
 
   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,
@@ -87,54 +88,65 @@ 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 authenticate(req: IncomingMessage): boolean {
+    if (this.isBasicAuthEnabled() === true) {
+      if (this.isValidBasicAuth(req) === true) {
+        return true;
+      }
+      return false;
+    }
+    return true;
   }
 
-  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;
+    }
   }
 }