X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPRequestService.ts;h=98c3081155bd2f350fe3a686c7909cd524166b52;hb=1a6188b2fcd2bf644e6fea0c697a095228c1aed0;hp=2a6a8c1884898d9d3c123cd071cda6f88c9befe0;hpb=b9da1bc288a2a6ffccfbca6cd19aa195bc6ccfbf;p=e-mobility-charging-stations-simulator.git

diff --git a/src/charging-station/ocpp/OCPPRequestService.ts b/src/charging-station/ocpp/OCPPRequestService.ts
index 2a6a8c18..98c30811 100644
--- a/src/charging-station/ocpp/OCPPRequestService.ts
+++ b/src/charging-station/ocpp/OCPPRequestService.ts
@@ -1,4 +1,4 @@
-import Ajv, { type JSONSchemaType } from 'ajv';
+import Ajv, { type JSONSchemaType, type ValidateFunction } from 'ajv';
 import ajvFormats from 'ajv-formats';
 
 import { OCPPConstants } from './OCPPConstants';
@@ -23,7 +23,13 @@ import {
   type ResponseCallback,
   type ResponseType,
 } from '../../types';
-import { Constants, ErrorUtils, Utils, logger } from '../../utils';
+import {
+  Constants,
+  cloneObject,
+  handleSendMessageError,
+  logger,
+  promiseWithTimeout,
+} from '../../utils';
 
 const moduleName = 'OCPPRequestService';
 
@@ -38,7 +44,8 @@ export abstract class OCPPRequestService {
   private readonly version: OCPPVersion;
   private readonly ajv: Ajv;
   private readonly ocppResponseService: OCPPResponseService;
-  protected abstract jsonSchemas: Map<RequestCommand, JSONSchemaType<JsonObject>>;
+  private readonly jsonValidateFunctions: Map<RequestCommand, ValidateFunction<JsonType>>;
+  protected abstract jsonSchemas: Map<RequestCommand, JSONSchemaType<JsonType>>;
 
   protected constructor(version: OCPPVersion, ocppResponseService: OCPPResponseService) {
     this.version = version;
@@ -47,34 +54,36 @@ export abstract class OCPPRequestService {
       multipleOfPrecision: 2,
     });
     ajvFormats(this.ajv);
+    this.jsonValidateFunctions = new Map<RequestCommand, ValidateFunction<JsonType>>();
     this.ocppResponseService = ocppResponseService;
     this.requestHandler = this.requestHandler.bind(this) as <
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
       ReqType extends JsonType,
-      ResType extends JsonType
+      ResType extends JsonType,
     >(
       chargingStation: ChargingStation,
       commandName: RequestCommand,
       commandParams?: JsonType,
-      params?: RequestParams
+      params?: RequestParams,
     ) => Promise<ResType>;
     this.sendMessage = this.sendMessage.bind(this) as (
       chargingStation: ChargingStation,
       messageId: string,
       messagePayload: JsonType,
       commandName: RequestCommand,
-      params?: RequestParams
+      params?: RequestParams,
     ) => Promise<ResponseType>;
     this.sendResponse = this.sendResponse.bind(this) as (
       chargingStation: ChargingStation,
       messageId: string,
       messagePayload: JsonType,
-      commandName: IncomingRequestCommand
+      commandName: IncomingRequestCommand,
     ) => Promise<ResponseType>;
     this.sendError = this.sendError.bind(this) as (
       chargingStation: ChargingStation,
       messageId: string,
       ocppError: OCPPError,
-      commandName: RequestCommand | IncomingRequestCommand
+      commandName: RequestCommand | IncomingRequestCommand,
     ) => Promise<ResponseType>;
     this.internalSendMessage = this.internalSendMessage.bind(this) as (
       chargingStation: ChargingStation,
@@ -82,7 +91,7 @@ export abstract class OCPPRequestService {
       messagePayload: JsonType | OCPPError,
       messageType: MessageType,
       commandName: RequestCommand | IncomingRequestCommand,
-      params?: RequestParams
+      params?: RequestParams,
     ) => Promise<ResponseType>;
     this.buildMessageToSend = this.buildMessageToSend.bind(this) as (
       chargingStation: ChargingStation,
@@ -91,25 +100,25 @@ export abstract class OCPPRequestService {
       messageType: MessageType,
       commandName: RequestCommand | IncomingRequestCommand,
       responseCallback: ResponseCallback,
-      errorCallback: ErrorCallback
+      errorCallback: ErrorCallback,
     ) => string;
-    this.validateRequestPayload = this.validateRequestPayload.bind(this) as <T extends JsonObject>(
+    this.validateRequestPayload = this.validateRequestPayload.bind(this) as <T extends JsonType>(
       chargingStation: ChargingStation,
       commandName: RequestCommand | IncomingRequestCommand,
-      payload: T
+      payload: T,
     ) => boolean;
     this.validateIncomingRequestResponsePayload = this.validateIncomingRequestResponsePayload.bind(
-      this
-    ) as <T extends JsonObject>(
+      this,
+    ) as <T extends JsonType>(
       chargingStation: ChargingStation,
       commandName: RequestCommand | IncomingRequestCommand,
-      payload: T
+      payload: T,
     ) => boolean;
   }
 
   public static getInstance<T extends OCPPRequestService>(
     this: new (ocppResponseService: OCPPResponseService) => T,
-    ocppResponseService: OCPPResponseService
+    ocppResponseService: OCPPResponseService,
   ): T {
     if (OCPPRequestService.instance === null) {
       OCPPRequestService.instance = new this(ocppResponseService);
@@ -121,7 +130,7 @@ export abstract class OCPPRequestService {
     chargingStation: ChargingStation,
     messageId: string,
     messagePayload: JsonType,
-    commandName: IncomingRequestCommand
+    commandName: IncomingRequestCommand,
   ): Promise<ResponseType> {
     try {
       // Send response message
@@ -130,12 +139,13 @@ export abstract class OCPPRequestService {
         messageId,
         messagePayload,
         MessageType.CALL_RESULT_MESSAGE,
-        commandName
+        commandName,
       );
     } catch (error) {
-      ErrorUtils.handleSendMessageError(chargingStation, commandName, error as Error, {
+      handleSendMessageError(chargingStation, commandName, error as Error, {
         throwError: true,
       });
+      return null;
     }
   }
 
@@ -143,7 +153,7 @@ export abstract class OCPPRequestService {
     chargingStation: ChargingStation,
     messageId: string,
     ocppError: OCPPError,
-    commandName: RequestCommand | IncomingRequestCommand
+    commandName: RequestCommand | IncomingRequestCommand,
   ): Promise<ResponseType> {
     try {
       // Send error message
@@ -152,10 +162,11 @@ export abstract class OCPPRequestService {
         messageId,
         ocppError,
         MessageType.CALL_ERROR_MESSAGE,
-        commandName
+        commandName,
       );
     } catch (error) {
-      ErrorUtils.handleSendMessageError(chargingStation, commandName, error as Error);
+      handleSendMessageError(chargingStation, commandName, error as Error);
+      return null;
     }
   }
 
@@ -164,7 +175,7 @@ export abstract class OCPPRequestService {
     messageId: string,
     messagePayload: JsonType,
     commandName: RequestCommand,
-    params: RequestParams = defaultRequestParams
+    params?: RequestParams,
   ): Promise<ResponseType> {
     params = {
       ...defaultRequestParams,
@@ -177,86 +188,107 @@ export abstract class OCPPRequestService {
         messagePayload,
         MessageType.CALL_MESSAGE,
         commandName,
-        params
+        params,
       );
     } catch (error) {
-      ErrorUtils.handleSendMessageError(chargingStation, commandName, error as Error, {
+      handleSendMessageError(chargingStation, commandName, error as Error, {
         throwError: params.throwError,
       });
+      return null;
     }
   }
 
-  private validateRequestPayload<T extends JsonObject>(
+  private validateRequestPayload<T extends JsonType>(
     chargingStation: ChargingStation,
     commandName: RequestCommand | IncomingRequestCommand,
-    payload: T
+    payload: T,
   ): boolean {
-    if (chargingStation.getPayloadSchemaValidation() === false) {
+    if (chargingStation.stationInfo?.ocppStrictCompliance === 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`
+        `${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);
+    if (this.jsonValidateFunctions.has(commandName as RequestCommand) === false) {
+      this.jsonValidateFunctions.set(
+        commandName as RequestCommand,
+        this.ajv.compile<T>(this.jsonSchemas.get(commandName as RequestCommand)!).bind(this),
+      );
+    }
+    const validate = this.jsonValidateFunctions.get(commandName as RequestCommand)!;
+    payload = 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
+      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)
+      JSON.stringify(validate.errors, undefined, 2),
     );
   }
 
-  private validateIncomingRequestResponsePayload<T extends JsonObject>(
+  private validateIncomingRequestResponsePayload<T extends JsonType>(
     chargingStation: ChargingStation,
     commandName: RequestCommand | IncomingRequestCommand,
-    payload: T
+    payload: T,
   ): boolean {
-    if (chargingStation.getPayloadSchemaValidation() === false) {
+    if (chargingStation.stationInfo?.ocppStrictCompliance === false) {
       return true;
     }
     if (
       this.ocppResponseService.jsonIncomingRequestResponseSchemas.has(
-        commandName as IncomingRequestCommand
+        commandName as IncomingRequestCommand,
       ) === false
     ) {
       logger.warn(
-        `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: No JSON schema found for command '${commandName}' PDU validation`
+        `${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);
+    if (
+      this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.has(
+        commandName as IncomingRequestCommand,
+      ) === false
+    ) {
+      this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.set(
+        commandName as IncomingRequestCommand,
+        this.ajv
+          .compile<T>(
+            this.ocppResponseService.jsonIncomingRequestResponseSchemas.get(
+              commandName as IncomingRequestCommand,
+            )!,
+          )
+          .bind(this),
+      );
+    }
+    const validate = this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.get(
+      commandName as IncomingRequestCommand,
+    )!;
+    payload = 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
+      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)
+      JSON.stringify(validate.errors, undefined, 2),
     );
   }
 
@@ -266,7 +298,7 @@ export abstract class OCPPRequestService {
     messagePayload: JsonType | OCPPError,
     messageType: MessageType,
     commandName: RequestCommand | IncomingRequestCommand,
-    params: RequestParams = defaultRequestParams
+    params?: RequestParams,
   ): Promise<ResponseType> {
     params = {
       ...defaultRequestParams,
@@ -275,7 +307,7 @@ export abstract class OCPPRequestService {
     if (
       (chargingStation.inUnknownState() === true &&
         commandName === RequestCommand.BOOT_NOTIFICATION) ||
-      (chargingStation.getOcppStrictCompliance() === false &&
+      (chargingStation.stationInfo?.ocppStrictCompliance === false &&
         chargingStation.inUnknownState() === true) ||
       chargingStation.inAcceptedState() === true ||
       (chargingStation.inPendingState() === true &&
@@ -284,8 +316,8 @@ export abstract class OCPPRequestService {
       // eslint-disable-next-line @typescript-eslint/no-this-alias
       const self = this;
       // Send a message through wsConnection
-      return Utils.promiseWithTimeout(
-        new Promise((resolve, reject) => {
+      return promiseWithTimeout(
+        new Promise<ResponseType>((resolve, reject) => {
           /**
            * Function that will receive the request's response
            *
@@ -293,10 +325,10 @@ export abstract class OCPPRequestService {
            * @param requestPayload -
            */
           const responseCallback = (payload: JsonType, requestPayload: JsonType): void => {
-            if (chargingStation.getEnableStatistics() === true) {
+            if (chargingStation.stationInfo?.enableStatistics === true) {
               chargingStation.performanceStatistics?.addRequestStatistic(
                 commandName,
-                MessageType.CALL_RESULT_MESSAGE
+                MessageType.CALL_RESULT_MESSAGE,
               );
             }
             // Handle the request's response
@@ -305,7 +337,7 @@ export abstract class OCPPRequestService {
                 chargingStation,
                 commandName as RequestCommand,
                 payload,
-                requestPayload
+                requestPayload,
               )
               .then(() => {
                 resolve(payload);
@@ -325,24 +357,27 @@ export abstract class OCPPRequestService {
            * @param requestStatistic -
            */
           const errorCallback = (error: OCPPError, requestStatistic = true): void => {
-            if (requestStatistic === true && chargingStation.getEnableStatistics() === true) {
+            if (
+              requestStatistic === true &&
+              chargingStation.stationInfo?.enableStatistics === true
+            ) {
               chargingStation.performanceStatistics?.addRequestStatistic(
                 commandName,
-                MessageType.CALL_ERROR_MESSAGE
+                MessageType.CALL_ERROR_MESSAGE,
               );
             }
             logger.error(
               `${chargingStation.logPrefix()} Error occurred at ${OCPPServiceUtils.getMessageTypeString(
-                messageType
+                messageType,
               )} command ${commandName} with PDU %j:`,
               messagePayload,
-              error
+              error,
             );
             chargingStation.requests.delete(messageId);
             reject(error);
           };
 
-          if (chargingStation.getEnableStatistics() === true) {
+          if (chargingStation.stationInfo?.enableStatistics === true) {
             chargingStation.performanceStatistics?.addRequestStatistic(commandName, messageType);
           }
           const messageToSend = this.buildMessageToSend(
@@ -352,7 +387,7 @@ export abstract class OCPPRequestService {
             messageType,
             commandName,
             responseCallback,
-            errorCallback
+            errorCallback,
           );
           let sendError = false;
           // Check if wsConnection opened
@@ -363,22 +398,22 @@ export abstract class OCPPRequestService {
               chargingStation.wsConnection?.send(messageToSend);
               logger.debug(
                 `${chargingStation.logPrefix()} >> Command '${commandName}' sent ${OCPPServiceUtils.getMessageTypeString(
-                  messageType
-                )} payload: ${messageToSend}`
+                  messageType,
+                )} payload: ${messageToSend}`,
               );
             } catch (error) {
               logger.error(
                 `${chargingStation.logPrefix()} >> Command '${commandName}' failed to send ${OCPPServiceUtils.getMessageTypeString(
-                  messageType
+                  messageType,
                 )} payload: ${messageToSend}:`,
-                error
+                error,
               );
               sendError = true;
             }
             PerformanceStatistics.endMeasure(commandName, beginId);
           }
           const wsClosedOrErrored = !wsOpened || sendError === true;
-          if (wsClosedOrErrored && params.skipBufferingOnError === false) {
+          if (wsClosedOrErrored && params?.skipBufferingOnError === false) {
             // Buffer
             chargingStation.bufferMessage(messageToSend);
             // Reject and keep request in the cache
@@ -387,15 +422,15 @@ export abstract class OCPPRequestService {
                 ErrorType.GENERIC_ERROR,
                 `WebSocket closed or errored for buffered message id '${messageId}' with content '${messageToSend}'`,
                 commandName,
-                (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FREEZED_OBJECT
-              )
+                (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FROZEN_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
+              (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FROZEN_OBJECT,
             );
             // Reject response
             if (messageType !== MessageType.CALL_MESSAGE) {
@@ -414,17 +449,17 @@ export abstract class OCPPRequestService {
           ErrorType.GENERIC_ERROR,
           `Timeout for message id '${messageId}'`,
           commandName,
-          (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FREEZED_OBJECT
+          (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FROZEN_OBJECT,
         ),
         () => {
           messageType === MessageType.CALL_MESSAGE && chargingStation.requests.delete(messageId);
-        }
+        },
       );
     }
     throw new OCPPError(
       ErrorType.SECURITY_ERROR,
       `Cannot send command ${commandName} PDU when the charging station is in ${chargingStation.getRegistrationStatus()} state on the central server`,
-      commandName
+      commandName,
     );
   }
 
@@ -435,7 +470,7 @@ export abstract class OCPPRequestService {
     messageType: MessageType,
     commandName: RequestCommand | IncomingRequestCommand,
     responseCallback: ResponseCallback,
-    errorCallback: ErrorCallback
+    errorCallback: ErrorCallback,
   ): string {
     let messageToSend: string;
     // Type of message
@@ -443,7 +478,7 @@ export abstract class OCPPRequestService {
       // Request
       case MessageType.CALL_MESSAGE:
         // Build request
-        this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonObject);
+        this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonType);
         chargingStation.requests.set(messageId, [
           responseCallback,
           errorCallback,
@@ -463,7 +498,7 @@ export abstract class OCPPRequestService {
         this.validateIncomingRequestResponsePayload(
           chargingStation,
           commandName,
-          messagePayload as JsonObject
+          messagePayload as JsonType,
         );
         messageToSend = JSON.stringify([messageType, messageId, messagePayload] as Response);
         break;
@@ -486,7 +521,8 @@ export abstract class OCPPRequestService {
   public abstract requestHandler<ReqType extends JsonType, ResType extends JsonType>(
     chargingStation: ChargingStation,
     commandName: RequestCommand,
+    // FIXME: should be ReqType
     commandParams?: JsonType,
-    params?: RequestParams
+    params?: RequestParams,
   ): Promise<ResType>;
 }