X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F2.0%2FOCPP20ResponseService.ts;h=6ab91c074d01ec4f24b01a4c5fbdffb374ad1fa9;hb=9e9194c977f2100a92a4549e6562750499607706;hp=a0af4ab1280f03d751060d3195d3c9127dd7db31;hpb=31f59c6d2def2ab2b53240c1d3d35333ac00933b;p=e-mobility-charging-stations-simulator.git

diff --git a/src/charging-station/ocpp/2.0/OCPP20ResponseService.ts b/src/charging-station/ocpp/2.0/OCPP20ResponseService.ts
index a0af4ab1..6ab91c07 100644
--- a/src/charging-station/ocpp/2.0/OCPP20ResponseService.ts
+++ b/src/charging-station/ocpp/2.0/OCPP20ResponseService.ts
@@ -1,12 +1,11 @@
-// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
 
-import type { JSONSchemaType } from 'ajv';
+import type { ValidateFunction } from 'ajv'
 
-import { type ChargingStation, ChargingStationConfigurationUtils } from '../../../charging-station';
-import { OCPPError } from '../../../exception';
+import { addConfigurationKey, type ChargingStation } from '../../../charging-station/index.js'
+import { OCPPError } from '../../../exception/index.js'
 import {
   ErrorType,
-  type JsonObject,
   type JsonType,
   type OCPP20BootNotificationResponse,
   type OCPP20ClearCacheResponse,
@@ -17,171 +16,194 @@ import {
   type OCPP20StatusNotificationResponse,
   OCPPVersion,
   RegistrationStatusEnumType,
-  type ResponseHandler,
-} from '../../../types';
-import { logger } from '../../../utils';
-import { OCPP20ServiceUtils, OCPPResponseService } from '../internal';
+  type ResponseHandler
+} from '../../../types/index.js'
+import { isAsyncFunction, logger } from '../../../utils/index.js'
+import { OCPPResponseService } from '../OCPPResponseService.js'
+import { OCPP20ServiceUtils } from './OCPP20ServiceUtils.js'
 
-const moduleName = 'OCPP20ResponseService';
+const moduleName = 'OCPP20ResponseService'
 
 export class OCPP20ResponseService extends OCPPResponseService {
-  public jsonIncomingRequestResponseSchemas: Map<
-    OCPP20IncomingRequestCommand,
-    JSONSchemaType<JsonObject>
-  >;
+  public incomingRequestResponsePayloadValidateFunctions: Map<
+  OCPP20IncomingRequestCommand,
+  ValidateFunction<JsonType>
+  >
 
-  private responseHandlers: Map<OCPP20RequestCommand, ResponseHandler>;
-  private jsonSchemas: Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>;
+  protected payloadValidateFunctions: Map<OCPP20RequestCommand, ValidateFunction<JsonType>>
+  private readonly responseHandlers: Map<OCPP20RequestCommand, ResponseHandler>
 
-  public constructor() {
-    // if (new.target?.name === moduleName) {
-    //   throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
+  public constructor () {
+    // if (new.target.name === moduleName) {
+    //   throw new TypeError(`Cannot construct ${new.target.name} instances directly`)
     // }
-    super(OCPPVersion.VERSION_20);
+    super(OCPPVersion.VERSION_201)
     this.responseHandlers = new Map<OCPP20RequestCommand, ResponseHandler>([
-      [OCPP20RequestCommand.BOOT_NOTIFICATION, this.handleResponseBootNotification.bind(this)],
-      [OCPP20RequestCommand.HEARTBEAT, this.emptyResponseHandler.bind(this)],
-      [OCPP20RequestCommand.STATUS_NOTIFICATION, this.emptyResponseHandler.bind(this)],
-    ]);
-    this.jsonSchemas = new Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>([
       [
         OCPP20RequestCommand.BOOT_NOTIFICATION,
-        OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20BootNotificationResponse>(
-          '../../../assets/json-schemas/ocpp/2.0/BootNotificationResponse.json',
-          moduleName,
-          'constructor'
-        ),
+        this.handleResponseBootNotification.bind(this) as ResponseHandler
+      ],
+      [OCPP20RequestCommand.HEARTBEAT, this.emptyResponseHandler],
+      [OCPP20RequestCommand.STATUS_NOTIFICATION, this.emptyResponseHandler]
+    ])
+    this.payloadValidateFunctions = new Map<OCPP20RequestCommand, ValidateFunction<JsonType>>([
+      [
+        OCPP20RequestCommand.BOOT_NOTIFICATION,
+        this.ajv
+          .compile(
+            OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20BootNotificationResponse>(
+              'assets/json-schemas/ocpp/2.0/BootNotificationResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP20RequestCommand.HEARTBEAT,
-        OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20HeartbeatResponse>(
-          '../../../assets/json-schemas/ocpp/2.0/HeartbeatResponse.json',
-          moduleName,
-          'constructor'
-        ),
+        this.ajv
+          .compile(
+            OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20HeartbeatResponse>(
+              'assets/json-schemas/ocpp/2.0/HeartbeatResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
       ],
       [
         OCPP20RequestCommand.STATUS_NOTIFICATION,
-        OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20StatusNotificationResponse>(
-          '../../../assets/json-schemas/ocpp/2.0/StatusNotificationResponse.json',
-          moduleName,
-          'constructor'
-        ),
-      ],
-    ]);
-    this.jsonIncomingRequestResponseSchemas = new Map([
+        this.ajv
+          .compile(
+            OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20StatusNotificationResponse>(
+              'assets/json-schemas/ocpp/2.0/StatusNotificationResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
+      ]
+    ])
+    this.incomingRequestResponsePayloadValidateFunctions = new Map<
+    OCPP20IncomingRequestCommand,
+    ValidateFunction<JsonType>
+    >([
       [
         OCPP20IncomingRequestCommand.CLEAR_CACHE,
-        OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20ClearCacheResponse>(
-          '../../../assets/json-schemas/ocpp/2.0/ClearCacheResponse.json',
-          moduleName,
-          'constructor'
-        ),
-      ],
-    ]);
-    this.validatePayload = this.validatePayload.bind(this) as (
-      chargingStation: ChargingStation,
-      commandName: OCPP20RequestCommand,
-      payload: JsonType
-    ) => boolean;
+        this.ajvIncomingRequest
+          .compile(
+            OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20ClearCacheResponse>(
+              'assets/json-schemas/ocpp/2.0/ClearCacheResponse.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
+      ]
+    ])
+    this.validatePayload = this.validatePayload.bind(this)
   }
 
-  public async responseHandler(
+  public async responseHandler<ReqType extends JsonType, ResType extends JsonType>(
     chargingStation: ChargingStation,
     commandName: OCPP20RequestCommand,
-    payload: JsonType,
-    requestPayload: JsonType
+    payload: ResType,
+    requestPayload: ReqType
   ): Promise<void> {
-    if (
-      chargingStation.isRegistered() === true ||
-      commandName === OCPP20RequestCommand.BOOT_NOTIFICATION
-    ) {
+    if (chargingStation.isRegistered() || commandName === OCPP20RequestCommand.BOOT_NOTIFICATION) {
       if (
-        this.responseHandlers.has(commandName) === true &&
-        OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true
+        this.responseHandlers.has(commandName) &&
+        OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName)
       ) {
         try {
-          this.validatePayload(chargingStation, commandName, payload);
-          await this.responseHandlers.get(commandName)(chargingStation, payload, requestPayload);
+          this.validatePayload(chargingStation, commandName, payload)
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          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:`,
             error
-          );
-          throw error;
+          )
+          throw error
         }
       } else {
         // 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,
-            null,
+            undefined,
             2
           )}`,
           commandName,
           payload
-        );
+        )
       }
     } else {
       throw new OCPPError(
         ErrorType.SECURITY_ERROR,
         `${commandName} cannot be issued to handle response PDU ${JSON.stringify(
           payload,
-          null,
+          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
-      );
+      )
     }
   }
 
-  private validatePayload(
+  private validatePayload (
     chargingStation: ChargingStation,
     commandName: OCPP20RequestCommand,
     payload: JsonType
   ): boolean {
-    if (this.jsonSchemas.has(commandName) === true) {
-      return this.validateResponsePayload(
-        chargingStation,
-        commandName,
-        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`
-    );
-    return false;
+      `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema validation function found for command '${commandName}' PDU validation`
+    )
+    return false
   }
 
-  private handleResponseBootNotification(
+  private handleResponseBootNotification (
     chargingStation: ChargingStation,
     payload: OCPP20BootNotificationResponse
   ): void {
     if (payload.status === RegistrationStatusEnumType.ACCEPTED) {
-      ChargingStationConfigurationUtils.addConfigurationKey(
+      addConfigurationKey(
         chargingStation,
         OCPP20OptionalVariableName.HeartbeatInterval,
         payload.interval.toString(),
         {},
         { overwrite: true, save: true }
-      );
-      OCPP20ServiceUtils.startHeartbeatInterval(chargingStation, payload.interval);
+      )
+      OCPP20ServiceUtils.startHeartbeatInterval(chargingStation, payload.interval)
     }
     if (Object.values(RegistrationStatusEnumType).includes(payload.status)) {
       const logMsg = `${chargingStation.logPrefix()} Charging station in '${
         payload.status
-      }' state on the central server`;
+      }' state on the central server`
       payload.status === RegistrationStatusEnumType.REJECTED
         ? logger.warn(logMsg)
-        : logger.info(logMsg);
+        : logger.info(logMsg)
     } else {
       logger.error(
         `${chargingStation.logPrefix()} Charging station boot notification response received: %j with undefined registration status`,
         payload
-      );
+      )
     }
   }
 }