fix: ensure id tags cache is properly cleaned

[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 ff2dfd4c18d4f4098d1374cdb45767a48dd27c55..390feda8fbc6f7930964e884bddbf0061ec8ada5 100644 (file)
--- a/src/charging-station/ocpp/OCPPIncomingRequestService.ts
+++ b/src/charging-station/ocpp/OCPPIncomingRequestService.ts
@@ -1,21 +1,123 @@
-import ChargingStation from '../ChargingStation';
-import { IncomingRequestCommand } from '../../types/ocpp/Requests';
-import logger from '../../utils/Logger';
+import { AsyncResource } from 'node:async_hooks';
 
-export default abstract class OCPPIncomingRequestService {
-  protected chargingStation: ChargingStation;
+import Ajv, { type JSONSchemaType } from 'ajv';
+import ajvFormats from 'ajv-formats';
 
-  constructor(chargingStation: ChargingStation) {
-    this.chargingStation = chargingStation;
+import { OCPPConstants } from './OCPPConstants';
+import { OCPPServiceUtils } from './OCPPServiceUtils';
+import { type ChargingStation, ChargingStationUtils } from '../../charging-station';
+import { OCPPError } from '../../exception';
+import type {
+  ClearCacheResponse,
+  HandleErrorParams,
+  IncomingRequestCommand,
+  JsonObject,
+  JsonType,
+  OCPPVersion,
+} from '../../types';
+import { logger, setDefaultErrorParams } from '../../utils';
+
+const moduleName = 'OCPPIncomingRequestService';
+
+export abstract class OCPPIncomingRequestService extends AsyncResource {
+  private static instance: OCPPIncomingRequestService | null = null;
+  private readonly version: OCPPVersion;
+  private readonly ajv: Ajv;
+  protected abstract jsonSchemas: Map<IncomingRequestCommand, JSONSchemaType<JsonObject>>;
+
+  protected constructor(version: OCPPVersion) {
+    super(moduleName);
+    this.version = version;
+    this.ajv = new Ajv({
+      keywords: ['javaType'],
+      multipleOfPrecision: 2,
+    });
+    ajvFormats(this.ajv);
+    this.incomingRequestHandler = this.incomingRequestHandler.bind(this) as (
+      chargingStation: ChargingStation,
+      messageId: string,
+      commandName: IncomingRequestCommand,
+      commandPayload: JsonType
+    ) => 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 {
+    if (OCPPIncomingRequestService.instance === null) {
+      OCPPIncomingRequestService.instance = new this();
+    }
+    return OCPPIncomingRequestService.instance as T;
+  }
+
+  protected handleIncomingRequestError<T extends JsonType>(
+    chargingStation: ChargingStation,
+    commandName: IncomingRequestCommand,
+    error: Error,
+    params: HandleErrorParams<T> = { throwError: true, consoleOut: false }
+  ): T | undefined {
+    setDefaultErrorParams(params);
+    logger.error(
+      `${chargingStation.logPrefix()} ${moduleName}.handleIncomingRequestError: Incoming request command '${commandName}' error:`,
+      error
+    );
+    if (!params?.throwError && params?.errorResponse) {
+      return params?.errorResponse;
+    }
+    if (params?.throwError && !params?.errorResponse) {
+      throw error;
+    }
+    if (params?.throwError && params?.errorResponse) {
+      return params?.errorResponse;
+    }
+  }
+
+  protected validateIncomingRequestPayload<T extends JsonType>(
+    chargingStation: ChargingStation,
+    commandName: IncomingRequestCommand,
+    schema: JSONSchemaType<T>,
+    payload: T
+  ): boolean {
+    if (chargingStation.getPayloadSchemaValidation() === false) {
+      return true;
+    }
+    const validate = this.ajv.compile(schema);
+    if (validate(payload)) {
+      return true;
+    }
+    logger.error(
+      `${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)
+    );
   }
 
-  public handleIncomingRequestError(commandName: IncomingRequestCommand, error: Error, ocppResponse?): unknown {
-    logger.error(this.chargingStation.logPrefix() + ' Incoming request command ' + commandName + ' error: %j', error);
-    if (ocppResponse) {
-      return ocppResponse;
+  protected handleRequestClearCache(chargingStation: ChargingStation): ClearCacheResponse {
+    if (
+      chargingStation.idTagsCache.deleteIdTags(
+        ChargingStationUtils.getIdTagsFile(chargingStation.stationInfo)
+      )
+    ) {
+      return OCPPConstants.OCPP_RESPONSE_ACCEPTED;
     }
-    throw error;
+    return OCPPConstants.OCPP_RESPONSE_REJECTED;
   }
 
-  public abstract handleRequest(messageId: string, commandName: IncomingRequestCommand, commandPayload: Record<string, unknown>): Promise<void>;
+  public abstract incomingRequestHandler(
+    chargingStation: ChargingStation,
+    messageId: string,
+    commandName: IncomingRequestCommand,
+    commandPayload: JsonType
+  ): Promise<void>;
 }