X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPRequestService.ts;h=a50500dc24047f7a7eb3276a03d725cedf69fb44;hb=a14022a2a2426ab1f42c3ee25ffbfab8969447ea;hp=6f4e47be04864463f34b6b89fa65bceae9cf614c;hpb=1ca780f9d385bcf96a016ab5ba57ca0f19c94b74;p=e-mobility-charging-stations-simulator.git

diff --git a/src/charging-station/ocpp/OCPPRequestService.ts b/src/charging-station/ocpp/OCPPRequestService.ts
index 6f4e47be..a50500dc 100644
--- a/src/charging-station/ocpp/OCPPRequestService.ts
+++ b/src/charging-station/ocpp/OCPPRequestService.ts
@@ -1,44 +1,104 @@
-import { JSONSchemaType } from 'ajv';
-import Ajv from 'ajv-draft-04';
+import Ajv, { type JSONSchemaType } from 'ajv';
 import ajvFormats from 'ajv-formats';
 
-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 { OCPPConstants, type OCPPResponseService, OCPPServiceUtils } from './internal';
+import type { ChargingStation } from '../../charging-station';
+import { OCPPError } from '../../exception';
+import { PerformanceStatistics } from '../../performance';
 import {
-  IncomingRequestCommand,
-  OutgoingRequest,
+  type EmptyObject,
+  type ErrorCallback,
+  type ErrorResponse,
+  ErrorType,
+  type HandleErrorParams,
+  type IncomingRequestCommand,
+  type JsonObject,
+  type JsonType,
+  MessageType,
+  type OCPPVersion,
+  type OutgoingRequest,
   RequestCommand,
-  RequestParams,
-  ResponseType,
-} from '../../types/ocpp/Requests';
-import { ErrorResponse, Response } from '../../types/ocpp/Responses';
-import Constants from '../../utils/Constants';
-import logger from '../../utils/Logger';
-import Utils from '../../utils/Utils';
-import type ChargingStation from '../ChargingStation';
-import type OCPPResponseService from './OCPPResponseService';
-import { OCPPServiceUtils } from './OCPPServiceUtils';
+  type RequestParams,
+  type Response,
+  type ResponseCallback,
+  type ResponseType,
+} from '../../types';
+import { Constants, Utils, logger } from '../../utils';
 
 const moduleName = 'OCPPRequestService';
 
-export default abstract class OCPPRequestService {
+export abstract class OCPPRequestService {
   private static instance: OCPPRequestService | null = null;
-  private ajv: Ajv;
-
+  private readonly version: OCPPVersion;
+  private readonly ajv: Ajv;
   private readonly ocppResponseService: OCPPResponseService;
+  protected abstract jsonSchemas: Map<RequestCommand, JSONSchemaType<JsonObject>>;
 
-  protected constructor(ocppResponseService: OCPPResponseService) {
-    this.ocppResponseService = ocppResponseService;
-    this.requestHandler.bind(this);
-    this.sendResponse.bind(this);
-    this.sendError.bind(this);
-    this.ajv = new Ajv();
+  protected constructor(version: OCPPVersion, ocppResponseService: OCPPResponseService) {
+    this.version = version;
+    this.ajv = new Ajv({
+      keywords: ['javaType'],
+      multipleOfPrecision: 2,
+    });
     ajvFormats(this.ajv);
+    this.ocppResponseService = ocppResponseService;
+    this.requestHandler = this.requestHandler.bind(this) as <
+      ReqType extends JsonType,
+      ResType extends JsonType
+    >(
+      chargingStation: ChargingStation,
+      commandName: RequestCommand,
+      commandParams?: JsonType,
+      params?: RequestParams
+    ) => Promise<ResType>;
+    this.sendMessage = this.sendMessage.bind(this) as (
+      chargingStation: ChargingStation,
+      messageId: string,
+      messagePayload: JsonType,
+      commandName: RequestCommand,
+      params?: RequestParams
+    ) => Promise<ResponseType>;
+    this.sendResponse = this.sendResponse.bind(this) as (
+      chargingStation: ChargingStation,
+      messageId: string,
+      messagePayload: JsonType,
+      commandName: IncomingRequestCommand
+    ) => Promise<ResponseType>;
+    this.sendError = this.sendError.bind(this) as (
+      chargingStation: ChargingStation,
+      messageId: string,
+      ocppError: OCPPError,
+      commandName: RequestCommand | IncomingRequestCommand
+    ) => Promise<ResponseType>;
+    this.internalSendMessage = this.internalSendMessage.bind(this) as (
+      chargingStation: ChargingStation,
+      messageId: string,
+      messagePayload: JsonType | OCPPError,
+      messageType: MessageType,
+      commandName: RequestCommand | IncomingRequestCommand,
+      params?: RequestParams
+    ) => Promise<ResponseType>;
+    this.buildMessageToSend = this.buildMessageToSend.bind(this) as (
+      chargingStation: ChargingStation,
+      messageId: string,
+      messagePayload: JsonType | OCPPError,
+      messageType: MessageType,
+      commandName: RequestCommand | IncomingRequestCommand,
+      responseCallback: ResponseCallback,
+      errorCallback: ErrorCallback
+    ) => string;
+    this.validateRequestPayload = this.validateRequestPayload.bind(this) as <T extends JsonObject>(
+      chargingStation: ChargingStation,
+      commandName: RequestCommand | IncomingRequestCommand,
+      payload: T
+    ) => boolean;
+    this.validateIncomingRequestResponsePayload = this.validateIncomingRequestResponsePayload.bind(
+      this
+    ) as <T extends JsonObject>(
+      chargingStation: ChargingStation,
+      commandName: RequestCommand | IncomingRequestCommand,
+      payload: T
+    ) => boolean;
   }
 
   public static getInstance<T extends OCPPRequestService>(
@@ -67,7 +127,9 @@ export default abstract class OCPPRequestService {
         commandName
       );
     } catch (error) {
-      this.handleRequestError(chargingStation, commandName, error as Error);
+      this.handleSendMessageError(chargingStation, commandName, error as Error, {
+        throwError: true,
+      });
     }
   }
 
@@ -87,7 +149,7 @@ export default abstract class OCPPRequestService {
         commandName
       );
     } catch (error) {
-      this.handleRequestError(chargingStation, commandName, error as Error);
+      this.handleSendMessageError(chargingStation, commandName, error as Error);
     }
   }
 
@@ -99,6 +161,7 @@ export default abstract class OCPPRequestService {
     params: RequestParams = {
       skipBufferingOnError: false,
       triggerMessage: false,
+      throwError: false,
     }
   ): Promise<ResponseType> {
     try {
@@ -111,27 +174,37 @@ export default abstract class OCPPRequestService {
         params
       );
     } catch (error) {
-      this.handleRequestError(chargingStation, commandName, error as Error, { throwError: false });
+      this.handleSendMessageError(chargingStation, commandName, error as Error, {
+        throwError: params.throwError,
+      });
     }
   }
 
-  protected validateRequestPayload<T extends JsonType>(
+  private validateRequestPayload<T extends JsonObject>(
     chargingStation: ChargingStation,
-    commandName: RequestCommand,
-    schema: JSONSchemaType<T>,
+    commandName: RequestCommand | IncomingRequestCommand,
     payload: T
   ): boolean {
-    if (!chargingStation.getPayloadSchemaValidation()) {
+    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(schema);
+    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: Request PDU is invalid: %j`,
+      `${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',
@@ -140,146 +213,201 @@ export default abstract class OCPPRequestService {
     );
   }
 
+  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,
+    commandName: RequestCommand | IncomingRequestCommand,
     params: RequestParams = {
       skipBufferingOnError: false,
       triggerMessage: false,
     }
   ): Promise<ResponseType> {
     if (
-      (chargingStation.isInUnknownState() && commandName === RequestCommand.BOOT_NOTIFICATION) ||
-      (!chargingStation.getOcppStrictCompliance() && chargingStation.isInUnknownState()) ||
-      chargingStation.isInAcceptedState() ||
-      (chargingStation.isInPendingState() &&
-        (params.triggerMessage || messageType === MessageType.CALL_RESULT_MESSAGE))
+      (chargingStation.isInUnknownState() === true &&
+        commandName === RequestCommand.BOOT_NOTIFICATION) ||
+      (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;
       // Send a message through wsConnection
       return Utils.promiseWithTimeout(
         new Promise((resolve, reject) => {
-          const messageToSend = this.buildMessageToSend(
-            chargingStation,
-            messageId,
-            messagePayload,
-            messageType,
-            commandName,
-            responseCallback,
-            errorCallback
-          );
-          if (chargingStation.getEnableStatistics()) {
-            chargingStation.performanceStatistics.addRequestStatistic(commandName, messageType);
-          }
-          // Check if wsConnection opened
-          if (chargingStation.isWebSocketConnectionOpened()) {
-            // Yes: Send Message
-            const beginId = PerformanceStatistics.beginMeasure(commandName);
-            // FIXME: Handle sending error
-            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
-            chargingStation.bufferMessage(messageToSend);
-            const ocppError = new OCPPError(
-              ErrorType.GENERIC_ERROR,
-              `WebSocket closed for buffered message id '${messageId}' with content '${messageToSend}'`,
-              commandName,
-              (messagePayload as JsonObject)?.details ?? {}
-            );
-            if (messageType === MessageType.CALL_MESSAGE) {
-              // Reject it but keep the request in the cache
-              return reject(ocppError);
-            }
-            return errorCallback(ocppError, false);
-          } else {
-            // Reject it
-            return errorCallback(
-              new OCPPError(
-                ErrorType.GENERIC_ERROR,
-                `WebSocket closed for non buffered message id '${messageId}' with content '${messageToSend}'`,
-                commandName,
-                (messagePayload as JsonObject)?.details ?? {}
-              ),
-              false
-            );
-          }
-          // 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,
-            requestPayload: JsonType
-          ): Promise<void> {
-            if (chargingStation.getEnableStatistics()) {
-              chargingStation.performanceStatistics.addRequestStatistic(
+          const 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.responseHandler(
+            self.ocppResponseService
+              .responseHandler(
                 chargingStation,
                 commandName as RequestCommand,
                 payload,
                 requestPayload
-              );
-              resolve(payload);
-            } catch (error) {
-              reject(error);
-            } finally {
-              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 errorCallback(error: OCPPError, requestStatistic = true): void {
-            if (requestStatistic && chargingStation.getEnableStatistics()) {
-              chargingStation.performanceStatistics.addRequestStatistic(
+          const errorCallback = (error: OCPPError, requestStatistic = true): void => {
+            if (requestStatistic === true && chargingStation.getEnableStatistics() === true) {
+              chargingStation.performanceStatistics?.addRequestStatistic(
                 commandName,
                 MessageType.CALL_ERROR_MESSAGE
               );
             }
             logger.error(
-              `${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
             );
             chargingStation.requests.delete(messageId);
             reject(error);
+          };
+
+          if (chargingStation.getEnableStatistics() === true) {
+            chargingStation.performanceStatistics?.addRequestStatistic(commandName, messageType);
+          }
+          const messageToSend = this.buildMessageToSend(
+            chargingStation,
+            messageId,
+            messagePayload,
+            messageType,
+            commandName,
+            responseCallback,
+            errorCallback
+          );
+          let sendError = false;
+          // Check if wsConnection opened
+          const wsOpened = chargingStation.isWebSocketConnectionOpened() === true;
+          if (wsOpened) {
+            const beginId = PerformanceStatistics.beginMeasure(commandName);
+            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, beginId);
+          }
+          const wsClosedOrErrored = !wsOpened || 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 ?? Constants.EMPTY_FREEZED_OBJECT
+              )
+            );
+          } else if (wsClosedOrErrored) {
+            const ocppError = new OCPPError(
+              ErrorType.GENERIC_ERROR,
+              `WebSocket closed or errored for non buffered message id '${messageId}' with content '${messageToSend}'`,
+              commandName,
+              (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FREEZED_OBJECT
+            );
+            // Reject response
+            if (messageType !== MessageType.CALL_MESSAGE) {
+              return reject(ocppError);
+            }
+            // Reject and remove request from the cache
+            return errorCallback(ocppError, false);
+          }
+          // Resolve response
+          if (messageType !== MessageType.CALL_MESSAGE) {
+            return resolve(messagePayload);
           }
         }),
-        Constants.OCPP_WEBSOCKET_TIMEOUT,
+        OCPPConstants.OCPP_WEBSOCKET_TIMEOUT,
         new OCPPError(
           ErrorType.GENERIC_ERROR,
           `Timeout for message id '${messageId}'`,
           commandName,
-          (messagePayload as JsonObject)?.details ?? {}
+          (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FREEZED_OBJECT
         ),
         () => {
           messageType === MessageType.CALL_MESSAGE && chargingStation.requests.delete(messageId);
@@ -298,9 +426,9 @@ export default abstract class OCPPRequestService {
     messageId: string,
     messagePayload: JsonType | OCPPError,
     messageType: MessageType,
-    commandName?: RequestCommand | IncomingRequestCommand,
-    responseCallback?: (payload: JsonType, requestPayload: JsonType) => Promise<void>,
-    errorCallback?: (error: OCPPError, requestStatistic?: boolean) => void
+    commandName: RequestCommand | IncomingRequestCommand,
+    responseCallback: ResponseCallback,
+    errorCallback: ErrorCallback
   ): string {
     let messageToSend: string;
     // Type of message
@@ -308,6 +436,7 @@ export default abstract class OCPPRequestService {
       // Request
       case MessageType.CALL_MESSAGE:
         // Build request
+        this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonObject);
         chargingStation.requests.set(messageId, [
           responseCallback,
           errorCallback,
@@ -324,6 +453,11 @@ export default abstract class OCPPRequestService {
       // Response
       case MessageType.CALL_RESULT_MESSAGE:
         // Build response
+        this.validateIncomingRequestResponsePayload(
+          chargingStation,
+          commandName,
+          messagePayload as JsonObject
+        );
         messageToSend = JSON.stringify([messageType, messageId, messagePayload] as Response);
         break;
       // Error Message
@@ -341,34 +475,23 @@ export default abstract class OCPPRequestService {
     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(
+  private handleSendMessageError(
     chargingStation: ChargingStation,
     commandName: RequestCommand | IncomingRequestCommand,
     error: Error,
-    params: HandleErrorParams<EmptyObject> = { throwError: true }
+    params: HandleErrorParams<EmptyObject> = { throwError: false }
   ): void {
-    logger.error(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;
     }
   }
 
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  public abstract requestHandler<Request extends JsonType, Response extends JsonType>(
+  public abstract requestHandler<ReqType extends JsonType, ResType extends JsonType>(
     chargingStation: ChargingStation,
     commandName: RequestCommand,
     commandParams?: JsonType,
     params?: RequestParams
-  ): Promise<Response>;
+  ): Promise<ResType>;
 }