src/charging-station/ui-server/ui-services/AbstractUIService.ts

   1 import { RawData } from 'ws';
   2
   3 import BaseError from '../../../exception/BaseError';
   4 import { JsonType } from '../../../types/JsonType';
   5 import {
   6   ProcedureName,
   7   ProtocolRequest,
   8   ProtocolRequestHandler,
   9   ProtocolResponse,
  10   ProtocolVersion,
  11   RequestPayload,
  12   ResponsePayload,
  13   ResponseStatus,
  14 } from '../../../types/UIProtocol';
  15 import logger from '../../../utils/Logger';
  16 import Utils from '../../../utils/Utils';
  17 import Bootstrap from '../../Bootstrap';
  18 import UIServiceWorkerBroadcastChannel from '../../UIServiceWorkerBroadcastChannel';
  19 import { AbstractUIServer } from '../AbstractUIServer';
  20
  21 const moduleName = 'AbstractUIService';
  22
  23 export default abstract class AbstractUIService {
  24   protected readonly version: ProtocolVersion;
  25   protected readonly uiServer: AbstractUIServer;
  26   protected readonly requestHandlers: Map<ProcedureName, ProtocolRequestHandler>;
  27   protected uiServiceWorkerBroadcastChannel: UIServiceWorkerBroadcastChannel;
  28
  29   constructor(uiServer: AbstractUIServer, version: ProtocolVersion) {
  30     this.version = version;
  31     this.uiServer = uiServer;
  32     this.requestHandlers = new Map<ProcedureName, ProtocolRequestHandler>([
  33       [ProcedureName.LIST_CHARGING_STATIONS, this.handleListChargingStations.bind(this)],
  34       [ProcedureName.START_SIMULATOR, this.handleStartSimulator.bind(this)],
  35       [ProcedureName.STOP_SIMULATOR, this.handleStopSimulator.bind(this)],
  36     ]);
  37     this.uiServiceWorkerBroadcastChannel = new UIServiceWorkerBroadcastChannel(this);
  38   }
  39
  40   public async requestHandler(request: RawData): Promise<void> {
  41     let messageId: string;
  42     let command: ProcedureName;
  43     let requestPayload: RequestPayload | undefined;
  44     let responsePayload: ResponsePayload;
  45     try {
  46       [messageId, command, requestPayload] = this.requestValidation(request);
  47
  48       if (this.requestHandlers.has(command) === false) {
  49         throw new BaseError(
  50           `${command} is not implemented to handle message payload ${JSON.stringify(
  51             requestPayload,
  52             null,
  53             2
  54           )}`
  55         );
  56       }
  57
  58       // Call the request handler to build the response payload
  59       responsePayload = await this.requestHandlers.get(command)(messageId, requestPayload);
  60     } catch (error) {
  61       // Log
  62       logger.error(
  63         `${this.uiServer.logPrefix(moduleName, 'messageHandler')} Handle request error:`,
  64         error
  65       );
  66       responsePayload = {
  67         status: ResponseStatus.FAILURE,
  68         command,
  69         requestPayload,
  70         responsePayload,
  71         errorMessage: (error as Error).message,
  72         errorStack: (error as Error).stack,
  73       };
  74     }
  75
  76     if (responsePayload !== undefined) {
  77       // Send the response
  78       this.uiServer.sendResponse(this.buildProtocolResponse(messageId ?? 'error', responsePayload));
  79     }
  80   }
  81
  82   public sendRequest(
  83     messageId: string,
  84     procedureName: ProcedureName,
  85     requestPayload: RequestPayload
  86   ): void {
  87     this.uiServer.sendRequest(this.buildProtocolRequest(messageId, procedureName, requestPayload));
  88   }
  89
  90   public sendResponse(messageId: string, responsePayload: ResponsePayload): void {
  91     this.uiServer.sendResponse(this.buildProtocolResponse(messageId, responsePayload));
  92   }
  93
  94   public logPrefix(modName: string, methodName: string): string {
  95     return `${this.uiServer.logPrefix(modName, methodName)}`;
  96   }
  97
  98   private buildProtocolRequest(
  99     messageId: string,
 100     procedureName: ProcedureName,
 101     requestPayload: RequestPayload
 102   ): string {
 103     return JSON.stringify([messageId, procedureName, requestPayload] as ProtocolRequest);
 104   }
 105
 106   private buildProtocolResponse(messageId: string, responsePayload: ResponsePayload): string {
 107     return JSON.stringify([messageId, responsePayload] as ProtocolResponse);
 108   }
 109
 110   // Validate the raw data received from the WebSocket
 111   // TODO: should probably be moved to the ws verify clients callback
 112   private requestValidation(rawData: RawData): ProtocolRequest {
 113     // logger.debug(
 114     //   `${this.uiServer.logPrefix(
 115     //     moduleName,
 116     //     'dataValidation'
 117     //   )} Raw data received: ${rawData.toString()}`
 118     // );
 119
 120     const data = JSON.parse(rawData.toString()) as JsonType[];
 121
 122     if (Utils.isIterable(data) === false) {
 123       throw new BaseError('UI protocol request is not iterable');
 124     }
 125
 126     if (data.length !== 3) {
 127       throw new BaseError('UI protocol request is malformed');
 128     }
 129
 130     return data as ProtocolRequest;
 131   }
 132
 133   private handleListChargingStations(): ResponsePayload {
 134     // TODO: remove cast to unknown
 135     return {
 136       status: ResponseStatus.SUCCESS,
 137       ...Array.from(this.uiServer.chargingStations.values()),
 138     } as unknown as ResponsePayload;
 139   }
 140
 141   private async handleStartSimulator(): Promise<ResponsePayload> {
 142     await Bootstrap.getInstance().start();
 143     return { status: ResponseStatus.SUCCESS };
 144   }
 145
 146   private async handleStopSimulator(): Promise<ResponsePayload> {
 147     await Bootstrap.getInstance().stop();
 148     return { status: ResponseStatus.SUCCESS };
 149   }
 150 }