X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPRequestService.ts;h=023d5f95174bc07df34f3f5dbc49e214f1191d1a;hb=8ca6874c767f7068b101291232cf69b05bbd28c1;hp=89766371dc935b63d1ca6925e51cf5ccb349e881;hpb=54ce9b7d9ae0dd7d25a0c805611676b3c6a22318;p=e-mobility-charging-stations-simulator.git

diff --git a/src/charging-station/ocpp/OCPPRequestService.ts b/src/charging-station/ocpp/OCPPRequestService.ts
index 89766371..023d5f95 100644
--- a/src/charging-station/ocpp/OCPPRequestService.ts
+++ b/src/charging-station/ocpp/OCPPRequestService.ts
@@ -1,104 +1,124 @@
+import Ajv, { type JSONSchemaType } from 'ajv';
+import ajvFormats from 'ajv-formats';
+
+import type OCPPResponseService from './OCPPResponseService';
+import { OCPPServiceUtils } from './OCPPServiceUtils';
+import OCPPError from '../../exception/OCPPError';
+import PerformanceStatistics from '../../performance/PerformanceStatistics';
+import type { EmptyObject } from '../../types/EmptyObject';
+import type { HandleErrorParams } from '../../types/Error';
+import type { JsonObject, JsonType } from '../../types/JsonType';
+import { ErrorType } from '../../types/ocpp/ErrorType';
+import { MessageType } from '../../types/ocpp/MessageType';
+import type { OCPPVersion } from '../../types/ocpp/OCPPVersion';
 import {
-  IncomingRequestCommand,
+  type ErrorCallback,
+  type IncomingRequestCommand,
+  type OutgoingRequest,
   RequestCommand,
-  ResponseType,
-  SendParams,
+  type RequestParams,
+  type ResponseCallback,
+  type ResponseType,
 } from '../../types/ocpp/Requests';
-
-import type ChargingStation from '../ChargingStation';
+import type { 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';
 
-export default abstract class OCPPRequestService {
-  private static readonly instances: Map<string, OCPPRequestService> = new Map<
-    string,
-    OCPPRequestService
-  >();
+const moduleName = 'OCPPRequestService';
 
-  protected readonly chargingStation: ChargingStation;
+export default abstract class OCPPRequestService {
+  private static instance: OCPPRequestService | null = null;
+  private readonly version: OCPPVersion;
+  private readonly ajv: Ajv;
   private readonly ocppResponseService: OCPPResponseService;
+  protected abstract jsonSchemas: Map<RequestCommand, JSONSchemaType<JsonObject>>;
 
-  protected constructor(
-    chargingStation: ChargingStation,
-    ocppResponseService: OCPPResponseService
-  ) {
-    this.chargingStation = chargingStation;
+  protected constructor(version: OCPPVersion, ocppResponseService: OCPPResponseService) {
+    this.version = version;
+    this.ajv = new Ajv({
+      keywords: ['javaType'],
+      multipleOfPrecision: 2,
+    });
+    ajvFormats(this.ajv);
     this.ocppResponseService = ocppResponseService;
-    this.sendMessageHandler.bind(this);
-    this.sendResult.bind(this);
+    this.requestHandler.bind(this);
+    this.sendMessage.bind(this);
+    this.sendResponse.bind(this);
     this.sendError.bind(this);
+    this.internalSendMessage.bind(this);
+    this.buildMessageToSend.bind(this);
+    this.validateRequestPayload.bind(this);
+    this.validateIncomingRequestResponsePayload.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.hashId)) {
-      OCPPRequestService.instances.set(
-        chargingStation.hashId,
-        new this(chargingStation, ocppResponseService)
-      );
+    if (OCPPRequestService.instance === null) {
+      OCPPRequestService.instance = new this(ocppResponseService);
     }
-    return OCPPRequestService.instances.get(chargingStation.hashId) 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.handleSendMessageError(chargingStation, commandName, error as Error, {
+        throwError: true,
+      });
     }
   }
 
   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.handleSendMessageError(chargingStation, commandName, error as Error);
     }
   }
 
   protected async sendMessage(
+    chargingStation: ChargingStation,
     messageId: string,
     messagePayload: JsonType,
     commandName: RequestCommand,
-    params: SendParams = {
+    params: RequestParams = {
       skipBufferingOnError: false,
       triggerMessage: false,
+      throwError: false,
     }
   ): Promise<ResponseType> {
     try {
       return await this.internalSendMessage(
+        chargingStation,
         messageId,
         messagePayload,
         MessageType.CALL_MESSAGE,
@@ -106,27 +126,105 @@ export default abstract class OCPPRequestService {
         params
       );
     } catch (error) {
-      this.handleRequestError(commandName, error as Error, { throwError: false });
+      this.handleSendMessageError(chargingStation, commandName, error as Error, {
+        throwError: params.throwError,
+      });
     }
   }
 
+  private validateRequestPayload<T extends JsonObject>(
+    chargingStation: ChargingStation,
+    commandName: RequestCommand | IncomingRequestCommand,
+    payload: T
+  ): boolean {
+    if (chargingStation.getPayloadSchemaValidation() === false) {
+      return true;
+    }
+    if (this.jsonSchemas.has(commandName as RequestCommand) === false) {
+      logger.warn(
+        `${chargingStation.logPrefix()} ${moduleName}.validateRequestPayload: No JSON schema found for command '${commandName}' PDU validation`
+      );
+      return true;
+    }
+    const validate = this.ajv.compile(this.jsonSchemas.get(commandName as RequestCommand));
+    payload = Utils.cloneObject<T>(payload);
+    OCPPServiceUtils.convertDateToISOString<T>(payload);
+    if (validate(payload)) {
+      return true;
+    }
+    logger.error(
+      `${chargingStation.logPrefix()} ${moduleName}.validateRequestPayload: Command '${commandName}' request PDU is invalid: %j`,
+      validate.errors
+    );
+    // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
+    throw new OCPPError(
+      OCPPServiceUtils.ajvErrorsToErrorType(validate.errors),
+      'Request PDU is invalid',
+      commandName,
+      JSON.stringify(validate.errors, null, 2)
+    );
+  }
+
+  private validateIncomingRequestResponsePayload<T extends JsonObject>(
+    chargingStation: ChargingStation,
+    commandName: RequestCommand | IncomingRequestCommand,
+    payload: T
+  ): boolean {
+    if (chargingStation.getPayloadSchemaValidation() === false) {
+      return true;
+    }
+    if (
+      this.ocppResponseService.jsonIncomingRequestResponseSchemas.has(
+        commandName as IncomingRequestCommand
+      ) === false
+    ) {
+      logger.warn(
+        `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: No JSON schema found for command '${commandName}' PDU validation`
+      );
+      return true;
+    }
+    const validate = this.ajv.compile(
+      this.ocppResponseService.jsonIncomingRequestResponseSchemas.get(
+        commandName as IncomingRequestCommand
+      )
+    );
+    payload = Utils.cloneObject<T>(payload);
+    OCPPServiceUtils.convertDateToISOString<T>(payload);
+    if (validate(payload)) {
+      return true;
+    }
+    logger.error(
+      `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: Command '${commandName}' reponse PDU is invalid: %j`,
+      validate.errors
+    );
+    // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
+    throw new OCPPError(
+      OCPPServiceUtils.ajvErrorsToErrorType(validate.errors),
+      'Response PDU is invalid',
+      commandName,
+      JSON.stringify(validate.errors, null, 2)
+    );
+  }
+
   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() &&
+      (chargingStation.isInUnknownState() === true &&
         commandName === RequestCommand.BOOT_NOTIFICATION) ||
-      (!this.chargingStation.getOcppStrictCompliance() &&
-        this.chargingStation.isInUnknownState()) ||
-      this.chargingStation.isInAcceptedState() ||
-      (this.chargingStation.isInPendingState() && params.triggerMessage)
+      (chargingStation.getOcppStrictCompliance() === false &&
+        chargingStation.isInUnknownState() === true) ||
+      chargingStation.isInAcceptedState() === true ||
+      (chargingStation.isInPendingState() === true &&
+        (params.triggerMessage === true || messageType === MessageType.CALL_RESULT_MESSAGE))
     ) {
       // eslint-disable-next-line @typescript-eslint/no-this-alias
       const self = this;
@@ -134,109 +232,125 @@ 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() === true) {
+            chargingStation.performanceStatistics.addRequestStatistic(commandName, messageType);
           }
+          let sendError = false;
           // Check if wsConnection opened
-          if (this.chargingStation.isWebSocketConnectionOpened()) {
-            // Yes: Send Message
-            const beginId = PerformanceStatistics.beginMeasure(commandName);
-            // FIXME: Handle sending error
-            this.chargingStation.wsConnection.send(messageToSend);
-            PerformanceStatistics.endMeasure(commandName, beginId);
-          } else if (!params.skipBufferingOnError) {
-            // Buffer it
-            this.chargingStation.bufferMessage(messageToSend);
+          if (chargingStation.isWebSocketConnectionOpened() === true) {
+            const beginId = PerformanceStatistics.beginMeasure(commandName as string);
+            try {
+              chargingStation.wsConnection.send(messageToSend);
+              logger.debug(
+                `${chargingStation.logPrefix()} >> Command '${commandName}' sent ${OCPPServiceUtils.getMessageTypeString(
+                  messageType
+                )} payload: ${messageToSend}`
+              );
+            } catch (error) {
+              logger.error(
+                `${chargingStation.logPrefix()} >> Command '${commandName}' failed to send ${OCPPServiceUtils.getMessageTypeString(
+                  messageType
+                )} payload: ${messageToSend}:`,
+                error
+              );
+              sendError = true;
+            }
+            PerformanceStatistics.endMeasure(commandName as string, beginId);
+          }
+          const wsClosedOrErrored =
+            chargingStation.isWebSocketConnectionOpened() === false || sendError === true;
+          if (wsClosedOrErrored && params.skipBufferingOnError === false) {
+            // Buffer
+            chargingStation.bufferMessage(messageToSend);
+            // Reject and keep request in the cache
+            return reject(
+              new OCPPError(
+                ErrorType.GENERIC_ERROR,
+                `WebSocket closed or errored for buffered message id '${messageId}' with content '${messageToSend}'`,
+                commandName,
+                (messagePayload as JsonObject)?.details ?? {}
+              )
+            );
+          } else if (wsClosedOrErrored) {
             const ocppError = new OCPPError(
               ErrorType.GENERIC_ERROR,
-              `WebSocket closed for buffered message id '${messageId}' with content '${messageToSend}'`,
+              `WebSocket closed or errored for non 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
+            // Reject response
+            if (messageType !== MessageType.CALL_MESSAGE) {
               return reject(ocppError);
             }
-            return rejectCallback(ocppError, false);
-          } else {
-            // Reject it
-            return rejectCallback(
-              new OCPPError(
-                ErrorType.GENERIC_ERROR,
-                `WebSocket closed for non buffered message id '${messageId}' with content '${messageToSend}'`,
-                commandName,
-                (messagePayload?.details as JsonType) ?? {}
-              ),
-              false
-            );
+            // Reject and remove request from the cache
+            return errorCallback(ocppError, false);
           }
-          // Response?
+          // Resolve response
           if (messageType !== MessageType.CALL_MESSAGE) {
-            // Yes: send Ok
             return resolve(messagePayload);
           }
 
           /**
            * Function that will receive the request's response
            *
-           * @param payload
-           * @param requestPayload
+           * @param payload -
+           * @param requestPayload -
            */
-          async function responseCallback(
-            payload: JsonType | string,
-            requestPayload: JsonType
-          ): Promise<void> {
-            if (self.chargingStation.getEnableStatistics()) {
-              self.chargingStation.performanceStatistics.addRequestStatistic(
+          function responseCallback(payload: JsonType, requestPayload: JsonType): void {
+            if (chargingStation.getEnableStatistics() === true) {
+              chargingStation.performanceStatistics.addRequestStatistic(
                 commandName,
                 MessageType.CALL_RESULT_MESSAGE
               );
             }
             // Handle the request's response
-            try {
-              await self.ocppResponseService.handleResponse(
+            self.ocppResponseService
+              .responseHandler(
+                chargingStation,
                 commandName as RequestCommand,
                 payload,
                 requestPayload
-              );
-              resolve(payload);
-            } catch (error) {
-              reject(error);
-            } finally {
-              self.chargingStation.requests.delete(messageId);
-            }
+              )
+              .then(() => {
+                resolve(payload);
+              })
+              .catch((error) => {
+                reject(error);
+              })
+              .finally(() => {
+                chargingStation.requests.delete(messageId);
+              });
           }
 
           /**
            * Function that will receive the request's error response
            *
-           * @param error
-           * @param requestStatistic
+           * @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 === true && chargingStation.getEnableStatistics() === true) {
+              chargingStation.performanceStatistics.addRequestStatistic(
                 commandName,
                 MessageType.CALL_ERROR_MESSAGE
               );
             }
             logger.error(
-              `${self.chargingStation.logPrefix()} Error %j occurred when calling command %s with message data %j`,
-              error,
-              commandName,
-              messagePayload
+              `${chargingStation.logPrefix()} Error occurred at ${OCPPServiceUtils.getMessageTypeString(
+                messageType
+              )} command ${commandName} with PDU %j:`,
+              messagePayload,
+              error
             );
-            self.chargingStation.requests.delete(messageId);
+            chargingStation.requests.delete(messageId);
             reject(error);
           }
         }),
@@ -245,28 +359,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} PDU 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?: ResponseCallback,
+    errorCallback?: ErrorCallback
   ): string {
     let messageToSend: string;
     // Type of message
@@ -274,18 +388,29 @@ export default abstract class OCPPRequestService {
       // Request
       case MessageType.CALL_MESSAGE:
         // Build request
-        this.chargingStation.requests.set(messageId, [
+        this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonObject);
+        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]);
+        this.validateIncomingRequestResponsePayload(
+          chargingStation,
+          commandName,
+          messagePayload as JsonObject
+        );
+        messageToSend = JSON.stringify([messageType, messageId, messagePayload] as Response);
         break;
       // Error Message
       case MessageType.CALL_ERROR_MESSAGE:
@@ -293,33 +418,32 @@ 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 handleRequestError(
+  private handleSendMessageError(
+    chargingStation: ChargingStation,
     commandName: RequestCommand | IncomingRequestCommand,
     error: Error,
-    params: HandleErrorParams<EmptyObject> = { throwError: true }
+    params: HandleErrorParams<EmptyObject> = { throwError: false }
   ): void {
-    logger.error(
-      this.chargingStation.logPrefix() + ' Request command %s error: %j',
-      commandName,
-      error
-    );
-    if (params?.throwError) {
+    logger.error(`${chargingStation.logPrefix()} Request command '${commandName}' error:`, error);
+    if (params?.throwError === true) {
       throw error;
     }
   }
 
-  public abstract sendMessageHandler<Response extends JsonType>(
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  public abstract requestHandler<ReqType extends JsonType, ResType extends JsonType>(
+    chargingStation: ChargingStation,
     commandName: RequestCommand,
     commandParams?: JsonType,
-    params?: SendParams
-  ): Promise<Response>;
+    params?: RequestParams
+  ): Promise<ResType>;
 }