refactor: add type parameter to OCPP stack for request and response

[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 5fadfb95d5ee5227327fe8fc0304a1aee2998f9b..b7ab8ef66382b1ac0e799294eccca7f676480855 100644 (file)
--- a/src/charging-station/ocpp/OCPPIncomingRequestService.ts
+++ b/src/charging-station/ocpp/OCPPIncomingRequestService.ts
@@ -1,26 +1,76 @@
-import type ChargingStation from '../ChargingStation';
-import { HandleErrorParams } from '../../types/Error';
-import { IncomingRequestCommand } from '../../types/ocpp/Requests';
-import { JsonType } from '../../types/JsonType';
-import logger from '../../utils/Logger';
-
-export default abstract class OCPPIncomingRequestService {
-  private static readonly instances: Map<string, OCPPIncomingRequestService> = new Map<string, OCPPIncomingRequestService>();
-  protected chargingStation: ChargingStation;
-
-  protected constructor(chargingStation: ChargingStation) {
-    this.chargingStation = chargingStation;
+import { AsyncResource } from 'node:async_hooks';
+
+import Ajv, { type JSONSchemaType } from 'ajv';
+import ajvFormats from 'ajv-formats';
+
+import { OCPPConstants } from './OCPPConstants';
+import { OCPPServiceUtils } from './OCPPServiceUtils';
+import { type ChargingStation, getIdTagsFile } 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 <
+      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 (chargingStation: ChargingStation) => T, chargingStation: ChargingStation): T {
-    if (!OCPPIncomingRequestService.instances.has(chargingStation.id)) {
-      OCPPIncomingRequestService.instances.set(chargingStation.id, new this(chargingStation));
+  public static getInstance<T extends OCPPIncomingRequestService>(this: new () => T): T {
+    if (OCPPIncomingRequestService.instance === null) {
+      OCPPIncomingRequestService.instance = new this();
     }
-    return OCPPIncomingRequestService.instances.get(chargingStation.id) as T;
+    return OCPPIncomingRequestService.instance as T;
   }
 
-  protected handleIncomingRequestError<T>(commandName: IncomingRequestCommand, error: Error, params: HandleErrorParams<T> = { throwError: true }): T {
-    logger.error(this.chargingStation.logPrefix() + ' Incoming request command %s error: %j', commandName, error);
+  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;
     }
@@ -32,5 +82,43 @@ export default abstract class OCPPIncomingRequestService {
     }
   }
 
-  public abstract handleRequest(messageId: string, commandName: IncomingRequestCommand, commandPayload: JsonType): Promise<void>;
+  protected validateIncomingRequestPayload<T extends JsonType>(
+    chargingStation: ChargingStation,
+    commandName: IncomingRequestCommand,
+    schema: JSONSchemaType<T>,
+    payload: T,
+  ): boolean {
+    if (chargingStation.getOcppStrictCompliance() === 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),
+    );
+  }
+
+  protected handleRequestClearCache(chargingStation: ChargingStation): ClearCacheResponse {
+    if (chargingStation.idTagsCache.deleteIdTags(getIdTagsFile(chargingStation.stationInfo)!)) {
+      return OCPPConstants.OCPP_RESPONSE_ACCEPTED;
+    }
+    return OCPPConstants.OCPP_RESPONSE_REJECTED;
+  }
+
+  // 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: ReqType,
+  ): Promise<void>;
 }