fix: ensure OCPP request timeouting cancel it

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

diff --git a/src/charging-station/ocpp/OCPPIncomingRequestService.ts b/src/charging-station/ocpp/OCPPIncomingRequestService.ts
index 509eebd57b16bd8beacb924aafba3b5e2c5e8423..4b27f9d82f8de91b38bd1a19c4a826ebe6800d6b 100644 (file)
--- a/src/charging-station/ocpp/OCPPIncomingRequestService.ts
+++ b/src/charging-station/ocpp/OCPPIncomingRequestService.ts
@@ -1,26 +1,57 @@
-import type { JSONSchemaType } from 'ajv';
-import Ajv from 'ajv-draft-04';
+import { AsyncResource } from 'node:async_hooks';
+
+import Ajv, { type JSONSchemaType, type ValidateFunction } from 'ajv';
 import ajvFormats from 'ajv-formats';
 
-import OCPPError from '../../exception/OCPPError';
-import type { HandleErrorParams } from '../../types/Error';
-import type { JsonType } from '../../types/JsonType';
-import type { IncomingRequestCommand } from '../../types/ocpp/Requests';
-import logger from '../../utils/Logger';
-import type ChargingStation from '../ChargingStation';
+import { OCPPConstants } from './OCPPConstants';
 import { OCPPServiceUtils } from './OCPPServiceUtils';
+import { type ChargingStation, getIdTagsFile } from '../../charging-station';
+import { OCPPError } from '../../exception';
+import type {
+  ClearCacheResponse,
+  HandleErrorParams,
+  IncomingRequestCommand,
+  JsonType,
+  OCPPVersion,
+} from '../../types';
+import { logger, setDefaultErrorParams } from '../../utils';
 
 const moduleName = 'OCPPIncomingRequestService';
 
-export default abstract class OCPPIncomingRequestService {
+export abstract class OCPPIncomingRequestService extends AsyncResource {
   private static instance: OCPPIncomingRequestService | null = null;
-  private ajv: Ajv;
+  private readonly version: OCPPVersion;
+  private readonly ajv: Ajv;
+  private jsonValidateFunctions: Map<IncomingRequestCommand, ValidateFunction<JsonType>>;
+  protected abstract jsonSchemas: Map<IncomingRequestCommand, JSONSchemaType<JsonType>>;
 
-  protected constructor() {
-    this.ajv = new Ajv();
+  protected constructor(version: OCPPVersion) {
+    super(moduleName);
+    this.version = version;
+    this.ajv = new Ajv({
+      keywords: ['javaType'],
+      multipleOfPrecision: 2,
+    });
     ajvFormats(this.ajv);
-    this.incomingRequestHandler.bind(this);
-    this.validateIncomingRequestPayload.bind(this);
+    this.jsonValidateFunctions = new Map<IncomingRequestCommand, ValidateFunction<JsonType>>();
+    this.incomingRequestHandler = this.incomingRequestHandler.bind(this) as <
+      ReqType extends JsonType,
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      ResType extends JsonType,
+    >(
+      chargingStation: ChargingStation,
+      messageId: string,
+      commandName: IncomingRequestCommand,
+      commandPayload: ReqType,
+    ) => Promise<void>;
+    this.validateIncomingRequestPayload = this.validateIncomingRequestPayload.bind(this) as <
+      T extends JsonType,
+    >(
+      chargingStation: ChargingStation,
+      commandName: IncomingRequestCommand,
+      schema: JSONSchemaType<T>,
+      payload: T,
+    ) => boolean;
   }
 
   public static getInstance<T extends OCPPIncomingRequestService>(this: new () => T): T {
@@ -30,15 +61,16 @@ export default abstract class OCPPIncomingRequestService {
     return OCPPIncomingRequestService.instance as T;
   }
 
-  protected handleIncomingRequestError<T>(
+  protected handleIncomingRequestError<T extends JsonType>(
     chargingStation: ChargingStation,
     commandName: IncomingRequestCommand,
     error: Error,
-    params: HandleErrorParams<T> = { throwError: true }
-  ): T {
+    params: HandleErrorParams<T> = { throwError: true, consoleOut: false },
+  ): T | undefined {
+    setDefaultErrorParams(params);
     logger.error(
       `${chargingStation.logPrefix()} ${moduleName}.handleIncomingRequestError: Incoming request command '${commandName}' error:`,
-      error
+      error,
     );
     if (!params?.throwError && params?.errorResponse) {
       return params?.errorResponse;
@@ -55,31 +87,49 @@ export default abstract class OCPPIncomingRequestService {
     chargingStation: ChargingStation,
     commandName: IncomingRequestCommand,
     schema: JSONSchemaType<T>,
-    payload: T
+    payload: T,
   ): boolean {
-    if (chargingStation.getPayloadSchemaValidation() === false) {
+    if (chargingStation.stationInfo?.ocppStrictCompliance === false) {
       return true;
     }
-    const validate = this.ajv.compile(schema);
+    const validate = this.getJsonIncomingRequestValidateFunction<T>(commandName, schema);
     if (validate(payload)) {
       return true;
     }
     logger.error(
-      `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestPayload: Incoming request PDU is invalid: %j`,
-      validate.errors
+      `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestPayload: Command '${commandName}' incoming request PDU is invalid: %j`,
+      validate.errors,
     );
     throw new OCPPError(
       OCPPServiceUtils.ajvErrorsToErrorType(validate.errors),
       'Incoming request PDU is invalid',
       commandName,
-      JSON.stringify(validate.errors, null, 2)
+      JSON.stringify(validate.errors, undefined, 2),
     );
   }
 
-  public abstract incomingRequestHandler(
+  protected handleRequestClearCache(chargingStation: ChargingStation): ClearCacheResponse {
+    if (chargingStation.idTagsCache.deleteIdTags(getIdTagsFile(chargingStation.stationInfo)!)) {
+      return OCPPConstants.OCPP_RESPONSE_ACCEPTED;
+    }
+    return OCPPConstants.OCPP_RESPONSE_REJECTED;
+  }
+
+  private getJsonIncomingRequestValidateFunction<T extends JsonType>(
+    commandName: IncomingRequestCommand,
+    schema: JSONSchemaType<T>,
+  ) {
+    if (this.jsonValidateFunctions.has(commandName) === false) {
+      this.jsonValidateFunctions.set(commandName, this.ajv.compile<T>(schema).bind(this));
+    }
+    return this.jsonValidateFunctions.get(commandName)!;
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  public abstract incomingRequestHandler<ReqType extends JsonType, ResType extends JsonType>(
     chargingStation: ChargingStation,
     messageId: string,
     commandName: IncomingRequestCommand,
-    commandPayload: JsonType
+    commandPayload: ReqType,
   ): Promise<void>;
 }