perf: cache only JSON payload validation functions

[e-mobility-charging-stations-simulator.git] / src / charging-station / ocpp / 2.0 / OCPP20IncomingRequestService.ts

diff --git a/src/charging-station/ocpp/2.0/OCPP20IncomingRequestService.ts b/src/charging-station/ocpp/2.0/OCPP20IncomingRequestService.ts
index 95169e2b0d88f548a6829bde7cbeed6a314f3991..cfc58323ed8ad4cf597c1a2b3b9227b86f8ba2cd 100644 (file)
--- a/src/charging-station/ocpp/2.0/OCPP20IncomingRequestService.ts
+++ b/src/charging-station/ocpp/2.0/OCPP20IncomingRequestService.ts
@@ -1,59 +1,72 @@
-// 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 { OCPP20ServiceUtils } from './OCPP20ServiceUtils';
-import { OCPPError } from '../../../exception';
+import { OCPP20ServiceUtils } from './OCPP20ServiceUtils.js'
+import type { ChargingStation } from '../../../charging-station/index.js'
+import { OCPPError } from '../../../exception/index.js'
 import {
   ErrorType,
   type IncomingRequestHandler,
-  type JsonObject,
   type JsonType,
   type OCPP20ClearCacheRequest,
   OCPP20IncomingRequestCommand,
-  OCPPVersion,
-} from '../../../types';
-import { logger } from '../../../utils/Logger';
-import type { ChargingStation } from '../../ChargingStation';
-import { OCPPIncomingRequestService } from '../OCPPIncomingRequestService';
+  OCPPVersion
+} from '../../../types/index.js'
+import { logger } from '../../../utils/index.js'
+import { OCPPIncomingRequestService } from '../OCPPIncomingRequestService.js'
 
-const moduleName = 'OCPP20IncomingRequestService';
+const moduleName = 'OCPP20IncomingRequestService'
 
 export class OCPP20IncomingRequestService extends OCPPIncomingRequestService {
-  protected jsonSchemas: Map<OCPP20IncomingRequestCommand, JSONSchemaType<JsonObject>>;
-  private incomingRequestHandlers: Map<OCPP20IncomingRequestCommand, IncomingRequestHandler>;
+  protected jsonSchemasValidateFunction: Map<
+  OCPP20IncomingRequestCommand,
+  ValidateFunction<JsonType>
+  >
 
-  public constructor() {
-    if (new.target?.name === moduleName) {
-      throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
-    }
-    super(OCPPVersion.VERSION_20);
+  private readonly incomingRequestHandlers: Map<
+  OCPP20IncomingRequestCommand,
+  IncomingRequestHandler
+  >
+
+  public constructor () {
+    // if (new.target.name === moduleName) {
+    //   throw new TypeError(`Cannot construct ${new.target.name} instances directly`)
+    // }
+    super(OCPPVersion.VERSION_20)
     this.incomingRequestHandlers = new Map<OCPP20IncomingRequestCommand, IncomingRequestHandler>([
-      [OCPP20IncomingRequestCommand.CLEAR_CACHE, this.handleRequestClearCache.bind(this)],
-    ]);
-    this.jsonSchemas = new Map<OCPP20IncomingRequestCommand, JSONSchemaType<JsonObject>>([
+      [OCPP20IncomingRequestCommand.CLEAR_CACHE, this.handleRequestClearCache.bind(this)]
+    ])
+    this.jsonSchemasValidateFunction = new Map<
+    OCPP20IncomingRequestCommand,
+    ValidateFunction<JsonType>
+    >([
       [
         OCPP20IncomingRequestCommand.CLEAR_CACHE,
-        OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20ClearCacheRequest>(
-          '../../../assets/json-schemas/ocpp/2.0/ClearCacheRequest.json',
-          moduleName,
-          'constructor'
-        ),
-      ],
-    ]);
-    this.validatePayload.bind(this);
+        this.ajv
+          .compile(
+            OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20ClearCacheRequest>(
+              'assets/json-schemas/ocpp/2.0/ClearCacheRequest.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
+      ]
+    ])
+    this.validatePayload = this.validatePayload.bind(this)
   }
 
-  public async incomingRequestHandler(
+  public async incomingRequestHandler<ReqType extends JsonType, ResType extends JsonType>(
     chargingStation: ChargingStation,
     messageId: string,
     commandName: OCPP20IncomingRequestCommand,
-    commandPayload: JsonType
+    commandPayload: ReqType
   ): Promise<void> {
-    let response: JsonType;
+    let response: ResType
     if (
-      chargingStation.getOcppStrictCompliance() === true &&
-      chargingStation.isInPendingState() === true &&
+      chargingStation.stationInfo?.ocppStrictCompliance === true &&
+      chargingStation.inPendingState() &&
       (commandName === OCPP20IncomingRequestCommand.REQUEST_START_TRANSACTION ||
         commandName === OCPP20IncomingRequestCommand.REQUEST_STOP_TRANSACTION)
     ) {
@@ -61,36 +74,37 @@ export class OCPP20IncomingRequestService extends OCPPIncomingRequestService {
         ErrorType.SECURITY_ERROR,
         `${commandName} cannot be issued to handle request PDU ${JSON.stringify(
           commandPayload,
-          null,
+          undefined,
           2
         )} while the charging station is in pending state on the central server`,
         commandName,
         commandPayload
-      );
+      )
     }
     if (
-      chargingStation.isRegistered() === true ||
-      (chargingStation.getOcppStrictCompliance() === false &&
-        chargingStation.isInUnknownState() === true)
+      chargingStation.isRegistered() ||
+      (chargingStation.stationInfo?.ocppStrictCompliance === false &&
+        chargingStation.inUnknownState())
     ) {
       if (
-        this.incomingRequestHandlers.has(commandName) === true &&
-        OCPP20ServiceUtils.isIncomingRequestCommandSupported(chargingStation, commandName) === true
+        this.incomingRequestHandlers.has(commandName) &&
+        OCPP20ServiceUtils.isIncomingRequestCommandSupported(chargingStation, commandName)
       ) {
         try {
-          this.validatePayload(chargingStation, commandName, commandPayload);
+          this.validatePayload(chargingStation, commandName, commandPayload)
           // Call the method to build the response
-          response = await this.incomingRequestHandlers.get(commandName)(
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          response = (await this.incomingRequestHandlers.get(commandName)!(
             chargingStation,
             commandPayload
-          );
+          )) as ResType
         } catch (error) {
           // Log
           logger.error(
             `${chargingStation.logPrefix()} ${moduleName}.incomingRequestHandler: Handle incoming request error:`,
             error
-          );
-          throw error;
+          )
+          throw error
         }
       } else {
         // Throw exception
@@ -98,24 +112,24 @@ export class OCPP20IncomingRequestService extends OCPPIncomingRequestService {
           ErrorType.NOT_IMPLEMENTED,
           `${commandName} is not implemented to handle request PDU ${JSON.stringify(
             commandPayload,
-            null,
+            undefined,
             2
           )}`,
           commandName,
           commandPayload
-        );
+        )
       }
     } else {
       throw new OCPPError(
         ErrorType.SECURITY_ERROR,
         `${commandName} cannot be issued to handle request PDU ${JSON.stringify(
           commandPayload,
-          null,
+          undefined,
           2
         )} while the charging station is not registered on the central server.`,
         commandName,
         commandPayload
-      );
+      )
     }
     // Send the built response
     await chargingStation.ocppRequestService.sendResponse(
@@ -123,25 +137,20 @@ export class OCPP20IncomingRequestService extends OCPPIncomingRequestService {
       messageId,
       response,
       commandName
-    );
+    )
   }
 
-  private validatePayload(
+  private validatePayload (
     chargingStation: ChargingStation,
     commandName: OCPP20IncomingRequestCommand,
     commandPayload: JsonType
   ): boolean {
-    if (this.jsonSchemas.has(commandName) === true) {
-      return this.validateIncomingRequestPayload(
-        chargingStation,
-        commandName,
-        this.jsonSchemas.get(commandName),
-        commandPayload
-      );
+    if (this.jsonSchemasValidateFunction.has(commandName)) {
+      return this.validateIncomingRequestPayload(chargingStation, commandName, commandPayload)
     }
     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
   }
 }