X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F1.6%2FOCPP16ResponseService.ts;h=3905445e02fde891034802a202403d1b0bfb396b;hb=240fa4da80fd262158004eb576410d02afe0001f;hp=5ceeb38a6bc01d2747bfd0308bb5cfd8d4d7aa4b;hpb=65b5177e252fab95766ef8141e60e0b2434f2338;p=e-mobility-charging-stations-simulator.git

diff --git a/src/charging-station/ocpp/1.6/OCPP16ResponseService.ts b/src/charging-station/ocpp/1.6/OCPP16ResponseService.ts
index 5ceeb38a..3905445e 100644
--- a/src/charging-station/ocpp/1.6/OCPP16ResponseService.ts
+++ b/src/charging-station/ocpp/1.6/OCPP16ResponseService.ts
@@ -1,6 +1,6 @@
 // Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
 
-import type { JSONSchemaType } from 'ajv'
+import type { ValidateFunction } from 'ajv'
 import { secondsToMilliseconds } from 'date-fns'
 
 import { OCPP16ServiceUtils } from './OCPP16ServiceUtils.js'
@@ -51,19 +51,19 @@ import {
   type SetChargingProfileResponse,
   type UnlockConnectorResponse
 } from '../../../types/index.js'
-import { Constants, convertToInt, logger } from '../../../utils/index.js'
+import { Constants, convertToInt, isAsyncFunction, logger } from '../../../utils/index.js'
 import { OCPPResponseService } from '../OCPPResponseService.js'
 
 const moduleName = 'OCPP16ResponseService'
 
 export class OCPP16ResponseService extends OCPPResponseService {
-  public jsonIncomingRequestResponseSchemas: Map<
+  public incomingRequestResponsePayloadValidateFunctions: Map<
   OCPP16IncomingRequestCommand,
-  JSONSchemaType<JsonType>
+  ValidateFunction<JsonType>
   >
 
+  protected payloadValidateFunctions: Map<OCPP16RequestCommand, ValidateFunction<JsonType>>
   private readonly responseHandlers: Map<OCPP16RequestCommand, ResponseHandler>
-  private readonly jsonSchemas: Map<OCPP16RequestCommand, JSONSchemaType<JsonType>>
 
   public constructor () {
     // if (new.target.name === moduleName) {
@@ -97,231 +97,338 @@ export class OCPP16ResponseService extends OCPPResponseService {
       [OCPP16RequestCommand.DATA_TRANSFER, this.emptyResponseHandler],
       [OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, this.emptyResponseHandler]
     ])
-    this.jsonSchemas = new Map<OCPP16RequestCommand, JSONSchemaType<JsonType>>([
+    this.payloadValidateFunctions = new Map<OCPP16RequestCommand, ValidateFunction<JsonType>>([
       [
         OCPP16RequestCommand.BOOT_NOTIFICATION,
-        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16BootNotificationResponse>(
-          'assets/json-schemas/ocpp/1.6/BootNotificationResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajv
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16BootNotificationResponse>(
+              'assets/json-schemas/ocpp/1.6/BootNotificationResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16RequestCommand.HEARTBEAT,
-        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16HeartbeatResponse>(
-          'assets/json-schemas/ocpp/1.6/HeartbeatResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajv
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16HeartbeatResponse>(
+              'assets/json-schemas/ocpp/1.6/HeartbeatResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16RequestCommand.AUTHORIZE,
-        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16AuthorizeResponse>(
-          'assets/json-schemas/ocpp/1.6/AuthorizeResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajv
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16AuthorizeResponse>(
+              'assets/json-schemas/ocpp/1.6/AuthorizeResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16RequestCommand.START_TRANSACTION,
-        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16StartTransactionResponse>(
-          'assets/json-schemas/ocpp/1.6/StartTransactionResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajv
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16StartTransactionResponse>(
+              'assets/json-schemas/ocpp/1.6/StartTransactionResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16RequestCommand.STOP_TRANSACTION,
-        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16StopTransactionResponse>(
-          'assets/json-schemas/ocpp/1.6/StopTransactionResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajv
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16StopTransactionResponse>(
+              'assets/json-schemas/ocpp/1.6/StopTransactionResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16RequestCommand.STATUS_NOTIFICATION,
-        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16StatusNotificationResponse>(
-          'assets/json-schemas/ocpp/1.6/StatusNotificationResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajv
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16StatusNotificationResponse>(
+              'assets/json-schemas/ocpp/1.6/StatusNotificationResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16RequestCommand.METER_VALUES,
-        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16MeterValuesResponse>(
-          'assets/json-schemas/ocpp/1.6/MeterValuesResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajv
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16MeterValuesResponse>(
+              'assets/json-schemas/ocpp/1.6/MeterValuesResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION,
-        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16DiagnosticsStatusNotificationResponse>(
-          'assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotificationResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajv
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16DiagnosticsStatusNotificationResponse>(
+              'assets/json-schemas/ocpp/1.6/DiagnosticsStatusNotificationResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16RequestCommand.DATA_TRANSFER,
-        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16DataTransferResponse>(
-          'assets/json-schemas/ocpp/1.6/DataTransferResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajv
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16DataTransferResponse>(
+              'assets/json-schemas/ocpp/1.6/DataTransferResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION,
-        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16FirmwareStatusNotificationResponse>(
-          'assets/json-schemas/ocpp/1.6/FirmwareStatusNotificationResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajv
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16FirmwareStatusNotificationResponse>(
+              'assets/json-schemas/ocpp/1.6/FirmwareStatusNotificationResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ]
     ])
-    this.jsonIncomingRequestResponseSchemas = new Map([
+    this.incomingRequestResponsePayloadValidateFunctions = new Map<
+    OCPP16IncomingRequestCommand,
+    ValidateFunction<JsonType>
+    >([
       [
         OCPP16IncomingRequestCommand.RESET,
-        OCPP16ServiceUtils.parseJsonSchemaFile<GenericResponse>(
-          'assets/json-schemas/ocpp/1.6/ResetResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajvIncomingRequest
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<GenericResponse>(
+              'assets/json-schemas/ocpp/1.6/ResetResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16IncomingRequestCommand.CLEAR_CACHE,
-        OCPP16ServiceUtils.parseJsonSchemaFile<GenericResponse>(
-          'assets/json-schemas/ocpp/1.6/ClearCacheResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajvIncomingRequest
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<GenericResponse>(
+              'assets/json-schemas/ocpp/1.6/ClearCacheResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16IncomingRequestCommand.CHANGE_AVAILABILITY,
-        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16ChangeAvailabilityResponse>(
-          'assets/json-schemas/ocpp/1.6/ChangeAvailabilityResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajvIncomingRequest
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16ChangeAvailabilityResponse>(
+              'assets/json-schemas/ocpp/1.6/ChangeAvailabilityResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16IncomingRequestCommand.UNLOCK_CONNECTOR,
-        OCPP16ServiceUtils.parseJsonSchemaFile<UnlockConnectorResponse>(
-          'assets/json-schemas/ocpp/1.6/UnlockConnectorResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajvIncomingRequest
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<UnlockConnectorResponse>(
+              'assets/json-schemas/ocpp/1.6/UnlockConnectorResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16IncomingRequestCommand.GET_CONFIGURATION,
-        OCPP16ServiceUtils.parseJsonSchemaFile<GetConfigurationResponse>(
-          'assets/json-schemas/ocpp/1.6/GetConfigurationResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajvIncomingRequest
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<GetConfigurationResponse>(
+              'assets/json-schemas/ocpp/1.6/GetConfigurationResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16IncomingRequestCommand.CHANGE_CONFIGURATION,
-        OCPP16ServiceUtils.parseJsonSchemaFile<ChangeConfigurationResponse>(
-          'assets/json-schemas/ocpp/1.6/ChangeConfigurationResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajvIncomingRequest
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<ChangeConfigurationResponse>(
+              'assets/json-schemas/ocpp/1.6/ChangeConfigurationResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16IncomingRequestCommand.GET_COMPOSITE_SCHEDULE,
-        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16GetCompositeScheduleResponse>(
-          'assets/json-schemas/ocpp/1.6/GetCompositeScheduleResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajvIncomingRequest
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16GetCompositeScheduleResponse>(
+              'assets/json-schemas/ocpp/1.6/GetCompositeScheduleResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16IncomingRequestCommand.SET_CHARGING_PROFILE,
-        OCPP16ServiceUtils.parseJsonSchemaFile<SetChargingProfileResponse>(
-          'assets/json-schemas/ocpp/1.6/SetChargingProfileResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajvIncomingRequest
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<SetChargingProfileResponse>(
+              'assets/json-schemas/ocpp/1.6/SetChargingProfileResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE,
-        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16ClearChargingProfileResponse>(
-          'assets/json-schemas/ocpp/1.6/ClearChargingProfileResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajvIncomingRequest
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16ClearChargingProfileResponse>(
+              'assets/json-schemas/ocpp/1.6/ClearChargingProfileResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16IncomingRequestCommand.REMOTE_START_TRANSACTION,
-        OCPP16ServiceUtils.parseJsonSchemaFile<GenericResponse>(
-          'assets/json-schemas/ocpp/1.6/RemoteStartTransactionResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajvIncomingRequest
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<GenericResponse>(
+              'assets/json-schemas/ocpp/1.6/RemoteStartTransactionResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16IncomingRequestCommand.REMOTE_STOP_TRANSACTION,
-        OCPP16ServiceUtils.parseJsonSchemaFile<GenericResponse>(
-          'assets/json-schemas/ocpp/1.6/RemoteStopTransactionResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajvIncomingRequest
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<GenericResponse>(
+              'assets/json-schemas/ocpp/1.6/RemoteStopTransactionResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16IncomingRequestCommand.GET_DIAGNOSTICS,
-        OCPP16ServiceUtils.parseJsonSchemaFile<GetDiagnosticsResponse>(
-          'assets/json-schemas/ocpp/1.6/GetDiagnosticsResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajvIncomingRequest
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<GetDiagnosticsResponse>(
+              'assets/json-schemas/ocpp/1.6/GetDiagnosticsResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16IncomingRequestCommand.TRIGGER_MESSAGE,
-        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16TriggerMessageResponse>(
-          'assets/json-schemas/ocpp/1.6/TriggerMessageResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajvIncomingRequest
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16TriggerMessageResponse>(
+              'assets/json-schemas/ocpp/1.6/TriggerMessageResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16IncomingRequestCommand.DATA_TRANSFER,
-        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16DataTransferResponse>(
-          'assets/json-schemas/ocpp/1.6/DataTransferResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajvIncomingRequest
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16DataTransferResponse>(
+              'assets/json-schemas/ocpp/1.6/DataTransferResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16IncomingRequestCommand.UPDATE_FIRMWARE,
-        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16UpdateFirmwareResponse>(
-          'assets/json-schemas/ocpp/1.6/UpdateFirmwareResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajvIncomingRequest
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16UpdateFirmwareResponse>(
+              'assets/json-schemas/ocpp/1.6/UpdateFirmwareResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16IncomingRequestCommand.RESERVE_NOW,
-        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16ReserveNowResponse>(
-          'assets/json-schemas/ocpp/1.6/ReserveNowResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajvIncomingRequest
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16ReserveNowResponse>(
+              'assets/json-schemas/ocpp/1.6/ReserveNowResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP16IncomingRequestCommand.CANCEL_RESERVATION,
-        OCPP16ServiceUtils.parseJsonSchemaFile<GenericResponse>(
-          'assets/json-schemas/ocpp/1.6/CancelReservationResponse.json',
-          moduleName,
-          'constructor'
-        )
+        this.ajvIncomingRequest
+          .compile(
+            OCPP16ServiceUtils.parseJsonSchemaFile<GenericResponse>(
+              'assets/json-schemas/ocpp/1.6/CancelReservationResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ]
     ])
-    this.validatePayload = this.validatePayload.bind(this) as (
-      chargingStation: ChargingStation,
-      commandName: OCPP16RequestCommand,
-      payload: JsonType
-    ) => boolean
+    this.validatePayload = this.validatePayload.bind(this)
   }
 
   public async responseHandler<ReqType extends JsonType, ResType extends JsonType>(
@@ -338,7 +445,18 @@ export class OCPP16ResponseService extends OCPPResponseService {
         try {
           this.validatePayload(chargingStation, commandName, payload)
           // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-          await this.responseHandlers.get(commandName)!(chargingStation, payload, requestPayload)
+          const responseHandler = this.responseHandlers.get(commandName)!
+          if (isAsyncFunction(responseHandler)) {
+            await responseHandler(chargingStation, payload, requestPayload)
+          } else {
+            (
+              responseHandler as (
+                chargingStation: ChargingStation,
+                payload: JsonType,
+                requestPayload?: JsonType
+              ) => void
+            )(chargingStation, payload, requestPayload)
+          }
         } catch (error) {
           logger.error(
             `${chargingStation.logPrefix()} ${moduleName}.responseHandler: Handle response error:`,
@@ -350,7 +468,7 @@ export class OCPP16ResponseService extends OCPPResponseService {
         // Throw exception
         throw new OCPPError(
           ErrorType.NOT_IMPLEMENTED,
-          `${commandName} is not implemented to handle response PDU ${JSON.stringify(
+          `'${commandName}' is not implemented to handle response PDU ${JSON.stringify(
             payload,
             undefined,
             2
@@ -366,7 +484,7 @@ export class OCPP16ResponseService extends OCPPResponseService {
           payload,
           undefined,
           2
-        )} while the charging station is not registered on the central server.`,
+        )} while the charging station is not registered on the central server`,
         commandName,
         payload
       )
@@ -378,17 +496,11 @@ export class OCPP16ResponseService extends OCPPResponseService {
     commandName: OCPP16RequestCommand,
     payload: JsonType
   ): boolean {
-    if (this.jsonSchemas.has(commandName)) {
-      return this.validateResponsePayload(
-        chargingStation,
-        commandName,
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        this.jsonSchemas.get(commandName)!,
-        payload
-      )
+    if (this.payloadValidateFunctions.has(commandName)) {
+      return this.validateResponsePayload(chargingStation, commandName, payload)
     }
     logger.warn(
-      `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command '${commandName}' PDU validation`
+      `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema validation function found for command '${commandName}' PDU validation`
     )
     return false
   }
@@ -473,7 +585,7 @@ export class OCPP16ResponseService extends OCPPResponseService {
         logger.debug(
           `${chargingStation.logPrefix()} idTag '${requestPayload.idTag}' rejected with status '${
             payload.idTagInfo.status
-          }`
+          }'`
         )
       }
     } else {