X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPRequestService.ts;h=6695fcbc010e451a85740966da781f8fee392165;hb=8114d10e3893e96bb725ce2fca9744429ee4b75b;hp=e5047d33e2ec8d05a1a6021b6d921d5df0cded17;hpb=bad85ee42a1c6a12be50560e535331dadff453b4;p=e-mobility-charging-stations-simulator.git

diff --git a/src/charging-station/ocpp/OCPPRequestService.ts b/src/charging-station/ocpp/OCPPRequestService.ts
index e5047d33..6695fcbc 100644
--- a/src/charging-station/ocpp/OCPPRequestService.ts
+++ b/src/charging-station/ocpp/OCPPRequestService.ts
@@ -1,103 +1,99 @@
+import OCPPError from '../../exception/OCPPError';
+import PerformanceStatistics from '../../performance/PerformanceStatistics';
+import { EmptyObject } from '../../types/EmptyObject';
+import { HandleErrorParams } from '../../types/Error';
+import { JsonObject, JsonType } from '../../types/JsonType';
+import { ErrorType } from '../../types/ocpp/ErrorType';
+import { MessageType } from '../../types/ocpp/MessageType';
 import {
-  DiagnosticsStatus,
   IncomingRequestCommand,
+  OutgoingRequest,
   RequestCommand,
+  RequestParams,
   ResponseType,
-  SendParams,
 } from '../../types/ocpp/Requests';
-
-import type ChargingStation from '../ChargingStation';
+import { ErrorResponse, Response } from '../../types/ocpp/Responses';
 import Constants from '../../utils/Constants';
-import { EmptyObject } from '../../types/EmptyObject';
-import { ErrorType } from '../../types/ocpp/ErrorType';
-import { HandleErrorParams } from '../../types/Error';
-import { JsonType } from '../../types/JsonType';
-import { MessageType } from '../../types/ocpp/MessageType';
-import OCPPError from '../../exception/OCPPError';
-import type OCPPResponseService from './OCPPResponseService';
-import PerformanceStatistics from '../../performance/PerformanceStatistics';
-import Utils from '../../utils/Utils';
 import logger from '../../utils/Logger';
+import Utils from '../../utils/Utils';
+import type ChargingStation from '../ChargingStation';
+import type OCPPResponseService from './OCPPResponseService';
 
 export default abstract class OCPPRequestService {
-  private static readonly instances: Map<string, OCPPRequestService> = new Map<
-    string,
-    OCPPRequestService
-  >();
+  private static instance: OCPPRequestService | null = null;
 
-  protected readonly chargingStation: ChargingStation;
   private readonly ocppResponseService: OCPPResponseService;
 
-  protected constructor(
-    chargingStation: ChargingStation,
-    ocppResponseService: OCPPResponseService
-  ) {
-    this.chargingStation = chargingStation;
+  protected constructor(ocppResponseService: OCPPResponseService) {
     this.ocppResponseService = ocppResponseService;
-    this.sendMessageHandler.bind(this);
+    this.requestHandler.bind(this);
+    this.sendResponse.bind(this);
+    this.sendError.bind(this);
   }
 
   public static getInstance<T extends OCPPRequestService>(
-    this: new (chargingStation: ChargingStation, ocppResponseService: OCPPResponseService) => T,
-    chargingStation: ChargingStation,
+    this: new (ocppResponseService: OCPPResponseService) => T,
     ocppResponseService: OCPPResponseService
   ): T {
-    if (!OCPPRequestService.instances.has(chargingStation.id)) {
-      OCPPRequestService.instances.set(
-        chargingStation.id,
-        new this(chargingStation, ocppResponseService)
-      );
+    if (!OCPPRequestService.instance) {
+      OCPPRequestService.instance = new this(ocppResponseService);
     }
-    return OCPPRequestService.instances.get(chargingStation.id) as T;
+    return OCPPRequestService.instance as T;
   }
 
-  public async sendResult(
+  public async sendResponse(
+    chargingStation: ChargingStation,
     messageId: string,
     messagePayload: JsonType,
     commandName: IncomingRequestCommand
   ): Promise<ResponseType> {
     try {
-      // Send result message
+      // Send response message
       return await this.internalSendMessage(
+        chargingStation,
         messageId,
         messagePayload,
         MessageType.CALL_RESULT_MESSAGE,
         commandName
       );
     } catch (error) {
-      this.handleRequestError(commandName, error as Error);
+      this.handleRequestError(chargingStation, commandName, error as Error);
     }
   }
 
   public async sendError(
+    chargingStation: ChargingStation,
     messageId: string,
     ocppError: OCPPError,
-    commandName: IncomingRequestCommand
+    commandName: RequestCommand | IncomingRequestCommand
   ): Promise<ResponseType> {
     try {
       // Send error message
       return await this.internalSendMessage(
+        chargingStation,
         messageId,
         ocppError,
         MessageType.CALL_ERROR_MESSAGE,
         commandName
       );
     } catch (error) {
-      this.handleRequestError(commandName, error as Error);
+      this.handleRequestError(chargingStation, commandName, error as Error);
     }
   }
 
   protected async sendMessage(
+    chargingStation: ChargingStation,
     messageId: string,
     messagePayload: JsonType,
     commandName: RequestCommand,
-    params: SendParams = {
+    params: RequestParams = {
       skipBufferingOnError: false,
       triggerMessage: false,
     }
   ): Promise<ResponseType> {
     try {
       return await this.internalSendMessage(
+        chargingStation,
         messageId,
         messagePayload,
         MessageType.CALL_MESSAGE,
@@ -105,27 +101,27 @@ export default abstract class OCPPRequestService {
         params
       );
     } catch (error) {
-      this.handleRequestError(commandName, error as Error, { throwError: false });
+      this.handleRequestError(chargingStation, commandName, error as Error, { throwError: false });
     }
   }
 
   private async internalSendMessage(
+    chargingStation: ChargingStation,
     messageId: string,
     messagePayload: JsonType | OCPPError,
     messageType: MessageType,
     commandName?: RequestCommand | IncomingRequestCommand,
-    params: SendParams = {
+    params: RequestParams = {
       skipBufferingOnError: false,
       triggerMessage: false,
     }
   ): Promise<ResponseType> {
     if (
-      (this.chargingStation.isInUnknownState() &&
-        commandName === RequestCommand.BOOT_NOTIFICATION) ||
-      (!this.chargingStation.getOcppStrictCompliance() &&
-        this.chargingStation.isInUnknownState()) ||
-      this.chargingStation.isInAcceptedState() ||
-      (this.chargingStation.isInPendingState() && params.triggerMessage)
+      (chargingStation.isInUnknownState() && commandName === RequestCommand.BOOT_NOTIFICATION) ||
+      (!chargingStation.getOcppStrictCompliance() && chargingStation.isInUnknownState()) ||
+      chargingStation.isInAcceptedState() ||
+      (chargingStation.isInPendingState() &&
+        (params.triggerMessage || messageType === MessageType.CALL_RESULT_MESSAGE))
     ) {
       // eslint-disable-next-line @typescript-eslint/no-this-alias
       const self = this;
@@ -133,48 +129,51 @@ export default abstract class OCPPRequestService {
       return Utils.promiseWithTimeout(
         new Promise((resolve, reject) => {
           const messageToSend = this.buildMessageToSend(
+            chargingStation,
             messageId,
             messagePayload,
             messageType,
             commandName,
             responseCallback,
-            rejectCallback
+            errorCallback
           );
-          if (this.chargingStation.getEnableStatistics()) {
-            this.chargingStation.performanceStatistics.addRequestStatistic(
-              commandName,
-              messageType
-            );
+          if (chargingStation.getEnableStatistics()) {
+            chargingStation.performanceStatistics.addRequestStatistic(commandName, messageType);
           }
           // Check if wsConnection opened
-          if (this.chargingStation.isWebSocketConnectionOpened()) {
+          if (chargingStation.isWebSocketConnectionOpened()) {
             // Yes: Send Message
             const beginId = PerformanceStatistics.beginMeasure(commandName);
             // FIXME: Handle sending error
-            this.chargingStation.wsConnection.send(messageToSend);
+            chargingStation.wsConnection.send(messageToSend);
             PerformanceStatistics.endMeasure(commandName, beginId);
+            logger.debug(
+              `${chargingStation.logPrefix()} >> Command '${commandName}' sent ${this.getMessageTypeString(
+                messageType
+              )} payload: ${messageToSend}`
+            );
           } else if (!params.skipBufferingOnError) {
             // Buffer it
-            this.chargingStation.bufferMessage(messageToSend);
+            chargingStation.bufferMessage(messageToSend);
             const ocppError = new OCPPError(
               ErrorType.GENERIC_ERROR,
               `WebSocket closed for buffered message id '${messageId}' with content '${messageToSend}'`,
               commandName,
-              (messagePayload?.details as JsonType) ?? {}
+              (messagePayload as JsonObject)?.details ?? {}
             );
             if (messageType === MessageType.CALL_MESSAGE) {
               // Reject it but keep the request in the cache
               return reject(ocppError);
             }
-            return rejectCallback(ocppError, false);
+            return errorCallback(ocppError, false);
           } else {
             // Reject it
-            return rejectCallback(
+            return errorCallback(
               new OCPPError(
                 ErrorType.GENERIC_ERROR,
                 `WebSocket closed for non buffered message id '${messageId}' with content '${messageToSend}'`,
                 commandName,
-                (messagePayload?.details as JsonType) ?? {}
+                (messagePayload as JsonObject)?.details ?? {}
               ),
               false
             );
@@ -192,18 +191,19 @@ export default abstract class OCPPRequestService {
            * @param requestPayload
            */
           async function responseCallback(
-            payload: JsonType | string,
+            payload: JsonType,
             requestPayload: JsonType
           ): Promise<void> {
-            if (self.chargingStation.getEnableStatistics()) {
-              self.chargingStation.performanceStatistics.addRequestStatistic(
+            if (chargingStation.getEnableStatistics()) {
+              chargingStation.performanceStatistics.addRequestStatistic(
                 commandName,
                 MessageType.CALL_RESULT_MESSAGE
               );
             }
             // Handle the request's response
             try {
-              await self.ocppResponseService.handleResponse(
+              await self.ocppResponseService.responseHandler(
+                chargingStation,
                 commandName as RequestCommand,
                 payload,
                 requestPayload
@@ -211,9 +211,8 @@ export default abstract class OCPPRequestService {
               resolve(payload);
             } catch (error) {
               reject(error);
-              throw error;
             } finally {
-              self.chargingStation.requests.delete(messageId);
+              chargingStation.requests.delete(messageId);
             }
           }
 
@@ -223,20 +222,20 @@ export default abstract class OCPPRequestService {
            * @param error
            * @param requestStatistic
            */
-          function rejectCallback(error: OCPPError, requestStatistic = true): void {
-            if (requestStatistic && self.chargingStation.getEnableStatistics()) {
-              self.chargingStation.performanceStatistics.addRequestStatistic(
+          function errorCallback(error: OCPPError, requestStatistic = true): void {
+            if (requestStatistic && chargingStation.getEnableStatistics()) {
+              chargingStation.performanceStatistics.addRequestStatistic(
                 commandName,
                 MessageType.CALL_ERROR_MESSAGE
               );
             }
             logger.error(
-              `${self.chargingStation.logPrefix()} Error %j occurred when calling command %s with message data %j`,
+              `${chargingStation.logPrefix()} Error %j occurred when calling command %s with message data %j`,
               error,
               commandName,
               messagePayload
             );
-            self.chargingStation.requests.delete(messageId);
+            chargingStation.requests.delete(messageId);
             reject(error);
           }
         }),
@@ -245,28 +244,28 @@ export default abstract class OCPPRequestService {
           ErrorType.GENERIC_ERROR,
           `Timeout for message id '${messageId}'`,
           commandName,
-          (messagePayload?.details as JsonType) ?? {}
+          (messagePayload as JsonObject)?.details ?? {}
         ),
         () => {
-          messageType === MessageType.CALL_MESSAGE &&
-            this.chargingStation.requests.delete(messageId);
+          messageType === MessageType.CALL_MESSAGE && chargingStation.requests.delete(messageId);
         }
       );
     }
     throw new OCPPError(
       ErrorType.SECURITY_ERROR,
-      `Cannot send command ${commandName} payload when the charging station is in ${this.chargingStation.getRegistrationStatus()} state on the central server`,
+      `Cannot send command ${commandName} payload when the charging station is in ${chargingStation.getRegistrationStatus()} state on the central server`,
       commandName
     );
   }
 
   private buildMessageToSend(
+    chargingStation: ChargingStation,
     messageId: string,
     messagePayload: JsonType | OCPPError,
     messageType: MessageType,
     commandName?: RequestCommand | IncomingRequestCommand,
-    responseCallback?: (payload: JsonType | string, requestPayload: JsonType) => Promise<void>,
-    rejectCallback?: (error: OCPPError, requestStatistic?: boolean) => void
+    responseCallback?: (payload: JsonType, requestPayload: JsonType) => Promise<void>,
+    errorCallback?: (error: OCPPError, requestStatistic?: boolean) => void
   ): string {
     let messageToSend: string;
     // Type of message
@@ -274,18 +273,23 @@ export default abstract class OCPPRequestService {
       // Request
       case MessageType.CALL_MESSAGE:
         // Build request
-        this.chargingStation.requests.set(messageId, [
+        chargingStation.requests.set(messageId, [
           responseCallback,
-          rejectCallback,
+          errorCallback,
           commandName,
-          messagePayload,
+          messagePayload as JsonType,
         ]);
-        messageToSend = JSON.stringify([messageType, messageId, commandName, messagePayload]);
+        messageToSend = JSON.stringify([
+          messageType,
+          messageId,
+          commandName,
+          messagePayload,
+        ] as OutgoingRequest);
         break;
       // Response
       case MessageType.CALL_RESULT_MESSAGE:
         // Build response
-        messageToSend = JSON.stringify([messageType, messageId, messagePayload]);
+        messageToSend = JSON.stringify([messageType, messageId, messagePayload] as Response);
         break;
       // Error Message
       case MessageType.CALL_ERROR_MESSAGE:
@@ -293,33 +297,43 @@ export default abstract class OCPPRequestService {
         messageToSend = JSON.stringify([
           messageType,
           messageId,
-          messagePayload?.code ?? ErrorType.GENERIC_ERROR,
-          messagePayload?.message ?? '',
-          messagePayload?.details ?? { commandName },
-        ]);
+          (messagePayload as OCPPError)?.code ?? ErrorType.GENERIC_ERROR,
+          (messagePayload as OCPPError)?.message ?? '',
+          (messagePayload as OCPPError)?.details ?? { commandName },
+        ] as ErrorResponse);
         break;
     }
     return messageToSend;
   }
 
+  private getMessageTypeString(messageType: MessageType): string {
+    switch (messageType) {
+      case MessageType.CALL_MESSAGE:
+        return 'request';
+      case MessageType.CALL_RESULT_MESSAGE:
+        return 'response';
+      case MessageType.CALL_ERROR_MESSAGE:
+        return 'error';
+    }
+  }
+
   private handleRequestError(
+    chargingStation: ChargingStation,
     commandName: RequestCommand | IncomingRequestCommand,
     error: Error,
     params: HandleErrorParams<EmptyObject> = { throwError: true }
   ): void {
-    logger.error(
-      this.chargingStation.logPrefix() + ' Request command %s error: %j',
-      commandName,
-      error
-    );
+    logger.error(chargingStation.logPrefix() + ' Request command %s error: %j', commandName, error);
     if (params?.throwError) {
       throw error;
     }
   }
 
-  public abstract sendMessageHandler(
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  public abstract requestHandler<Request extends JsonType, Response extends JsonType>(
+    chargingStation: ChargingStation,
     commandName: RequestCommand,
     commandParams?: JsonType,
-    params?: SendParams
-  ): Promise<ResponseType>;
+    params?: RequestParams
+  ): Promise<Response>;
 }