refactor: cleanup unneeded type casting

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

diff --git a/src/charging-station/ui-server/AbstractUIServer.ts b/src/charging-station/ui-server/AbstractUIServer.ts
index f6e2010f8edf923fad117ea3ec8fb5c088f46944..cd6167389cf159d44c3b6118e20d3446473d01d3 100644 (file)
--- a/src/charging-station/ui-server/AbstractUIServer.ts
+++ b/src/charging-station/ui-server/AbstractUIServer.ts
@@ -1,83 +1,128 @@
-import { type IncomingMessage, Server } from 'http';
-import type { Socket } from 'net';
+import { type IncomingMessage, Server, type ServerResponse } from 'node:http'
+import { type Http2Server, createServer } from 'node:http2'
 
-import type { WebSocket } from 'ws';
+import type { WebSocket } from 'ws'
 
-import type { ChargingStationData } from '../../types/ChargingStationWorker';
-import type { UIServerConfiguration } from '../../types/ConfigurationData';
+import type { AbstractUIService } from './ui-services/AbstractUIService.js'
+import { UIServiceFactory } from './ui-services/UIServiceFactory.js'
+import { BaseError } from '../../exception/index.js'
 import {
+  ApplicationProtocolVersion,
   AuthenticationType,
-  ProcedureName,
-  ProtocolRequest,
-  ProtocolResponse,
+  type ChargingStationData,
+  type ProcedureName,
+  type ProtocolRequest,
+  type ProtocolResponse,
   ProtocolVersion,
-  RequestPayload,
-  ResponsePayload,
-} from '../../types/UIProtocol';
-import type AbstractUIService from './ui-services/AbstractUIService';
-import UIServiceFactory from './ui-services/UIServiceFactory';
+  type RequestPayload,
+  type ResponsePayload,
+  type UIServerConfiguration
+} from '../../types/index.js'
 
 export abstract class AbstractUIServer {
-  public readonly chargingStations: Map<string, ChargingStationData>;
-  protected httpServer: Server;
-  protected sockets: Set<Socket | WebSocket>;
-  protected readonly uiServices: Map<ProtocolVersion, AbstractUIService>;
-
-  public constructor(protected readonly uiServerConfiguration: UIServerConfiguration) {
-    this.chargingStations = new Map<string, ChargingStationData>();
-    this.httpServer = new Server();
-    this.sockets = new Set<Socket>();
-    this.uiServices = new Map<ProtocolVersion, AbstractUIService>();
+  public readonly chargingStations: Map<string, ChargingStationData>
+  protected readonly httpServer: Server | Http2Server
+  protected readonly responseHandlers: Map<string, ServerResponse | WebSocket>
+  protected readonly uiServices: Map<ProtocolVersion, AbstractUIService>
+
+  public constructor (protected readonly uiServerConfiguration: UIServerConfiguration) {
+    this.chargingStations = new Map<string, ChargingStationData>()
+    switch (this.uiServerConfiguration.version) {
+      case ApplicationProtocolVersion.VERSION_11:
+        this.httpServer = new Server()
+        break
+      case ApplicationProtocolVersion.VERSION_20:
+        this.httpServer = createServer()
+        break
+      default:
+        throw new BaseError(
+          `Unsupported application protocol version ${this.uiServerConfiguration.version}`
+        )
+    }
+    this.responseHandlers = new Map<string, ServerResponse | WebSocket>()
+    this.uiServices = new Map<ProtocolVersion, AbstractUIService>()
   }
 
-  public buildProtocolRequest(
+  public buildProtocolRequest (
     id: string,
     procedureName: ProcedureName,
     requestPayload: RequestPayload
   ): ProtocolRequest {
-    return [id, procedureName, requestPayload];
+    return [id, procedureName, requestPayload]
+  }
+
+  public buildProtocolResponse (id: string, responsePayload: ResponsePayload): ProtocolResponse {
+    return [id, responsePayload]
+  }
+
+  public stop (): void {
+    this.stopHttpServer()
+    this.chargingStations.clear()
+  }
+
+  public async sendInternalRequest (request: ProtocolRequest): Promise<ProtocolResponse> {
+    const protocolVersion = ProtocolVersion['0.0.1']
+    this.registerProtocolVersionUIService(protocolVersion)
+    return await (this.uiServices
+      .get(protocolVersion)
+      ?.requestHandler(request) as Promise<ProtocolResponse>)
   }
 
-  public buildProtocolResponse(id: string, responsePayload: ResponsePayload): ProtocolResponse {
-    return [id, responsePayload];
+  public hasResponseHandler (id: string): boolean {
+    return this.responseHandlers.has(id)
   }
 
-  public stop(): void {
-    this.chargingStations.clear();
+  protected startHttpServer (): void {
+    if (!this.httpServer.listening) {
+      this.httpServer.listen(this.uiServerConfiguration.options)
+    }
+  }
+
+  protected registerProtocolVersionUIService (version: ProtocolVersion): void {
+    if (!this.uiServices.has(version)) {
+      this.uiServices.set(version, UIServiceFactory.getUIServiceImplementation(version, this))
+    }
+  }
+
+  protected authenticate (req: IncomingMessage, next: (err?: Error) => void): void {
+    if (this.isBasicAuthEnabled()) {
+      if (!this.isValidBasicAuth(req)) {
+        next(new BaseError('Unauthorized'))
+      }
+      next()
+    }
+    next()
   }
 
-  protected registerProtocolVersionUIService(version: ProtocolVersion): void {
-    if (this.uiServices.has(version) === false) {
-      this.uiServices.set(version, UIServiceFactory.getUIServiceImplementation(version, this));
+  private stopHttpServer (): void {
+    if (this.httpServer.listening) {
+      this.httpServer.close()
     }
   }
 
-  protected isBasicAuthEnabled(): boolean {
+  private isBasicAuthEnabled (): boolean {
     return (
       this.uiServerConfiguration.authentication?.enabled === true &&
-      this.uiServerConfiguration.authentication?.type === AuthenticationType.BASIC_AUTH
-    );
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+      this.uiServerConfiguration.authentication.type === AuthenticationType.BASIC_AUTH
+    )
   }
 
-  protected isValidBasicAuth(req: IncomingMessage): boolean {
-    const authorizationHeader = req.headers.authorization ?? '';
-    const authorizationToken = authorizationHeader.split(/\s+/).pop() ?? '';
-    const authentication = Buffer.from(authorizationToken, 'base64').toString();
-    const authenticationParts = authentication.split(/:/);
-    const username = authenticationParts.shift();
-    const password = authenticationParts.join(':');
+  private isValidBasicAuth (req: IncomingMessage): boolean {
+    const authorizationHeader = req.headers.authorization ?? ''
+    const authorizationToken = authorizationHeader.split(/\s+/).pop() ?? ''
+    const authentication = Buffer.from(authorizationToken, 'base64').toString()
+    const authenticationParts = authentication.split(/:/)
+    const username = authenticationParts.shift()
+    const password = authenticationParts.join(':')
     return (
       this.uiServerConfiguration.authentication?.username === username &&
       this.uiServerConfiguration.authentication?.password === password
-    );
+    )
   }
 
-  public abstract start(): void;
-  public abstract sendRequest(request: ProtocolRequest): void;
-  public abstract sendResponse(response: ProtocolResponse): void;
-  public abstract logPrefix(
-    moduleName?: string,
-    methodName?: string,
-    prefixSuffix?: string
-  ): string;
+  public abstract start (): void
+  public abstract sendRequest (request: ProtocolRequest): void
+  public abstract sendResponse (response: ProtocolResponse): void
+  public abstract logPrefix (moduleName?: string, methodName?: string, prefixSuffix?: string): string
 }