chore: version 1.3.2

[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 1206cede00d0493df941f54e73dc03cffedfc28c..7c88547a6c63ce285e2009e6561b9d813fc99b53 100644 (file)
--- a/src/charging-station/ocpp/OCPPIncomingRequestService.ts
+++ b/src/charging-station/ocpp/OCPPIncomingRequestService.ts
@@ -1,59 +1,53 @@
-import { AsyncResource } from 'node:async_hooks';
+import { EventEmitter } from 'node:events'
 
-import Ajv, { type JSONSchemaType } from 'ajv';
-import ajvFormats from 'ajv-formats';
+import _Ajv, { type ValidateFunction } from 'ajv'
+import _ajvFormats from 'ajv-formats'
 
-import { OCPPConstants } from './OCPPConstants';
-import { OCPPServiceUtils } from './OCPPServiceUtils';
-import { type ChargingStation, ChargingStationUtils } from '../../charging-station';
-import { OCPPError } from '../../exception';
+import { type ChargingStation, getIdTagsFile } from '../../charging-station/index.js'
+import { OCPPError } from '../../exception/index.js'
 import type {
   ClearCacheResponse,
   HandleErrorParams,
   IncomingRequestCommand,
-  JsonObject,
   JsonType,
-  OCPPVersion,
-} from '../../types';
-import { ErrorUtils, logger } from '../../utils';
+  OCPPVersion
+} from '../../types/index.js'
+import { logger, setDefaultErrorParams } from '../../utils/index.js'
+import { OCPPConstants } from './OCPPConstants.js'
+import { OCPPServiceUtils } from './OCPPServiceUtils.js'
+type Ajv = _Ajv.default
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+const Ajv = _Ajv.default
+const ajvFormats = _ajvFormats.default
 
-const moduleName = 'OCPPIncomingRequestService';
+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>>;
+export abstract class OCPPIncomingRequestService extends EventEmitter {
+  private static instance: OCPPIncomingRequestService | null = null
+  private readonly version: OCPPVersion
+  protected readonly ajv: Ajv
+  protected abstract payloadValidateFunctions: Map<
+  IncomingRequestCommand,
+  ValidateFunction<JsonType>
+  >
 
-  protected constructor(version: OCPPVersion) {
-    super(moduleName);
-    this.version = version;
+  protected constructor (version: OCPPVersion) {
+    super()
+    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;
+      multipleOfPrecision: 2
+    })
+    ajvFormats(this.ajv)
+    this.incomingRequestHandler = this.incomingRequestHandler.bind(this)
+    this.validateIncomingRequestPayload = this.validateIncomingRequestPayload.bind(this)
   }
 
   public static getInstance<T extends OCPPIncomingRequestService>(this: new () => T): T {
     if (OCPPIncomingRequestService.instance === null) {
-      OCPPIncomingRequestService.instance = new this();
+      OCPPIncomingRequestService.instance = new this()
     }
-    return OCPPIncomingRequestService.instance as T;
+    return OCPPIncomingRequestService.instance as T
   }
 
   protected handleIncomingRequestError<T extends JsonType>(
@@ -62,58 +56,59 @@ export abstract class OCPPIncomingRequestService extends AsyncResource {
     error: Error,
     params: HandleErrorParams<T> = { throwError: true, consoleOut: false }
   ): T | undefined {
-    ErrorUtils.handleErrorParams(params);
+    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 === false && params.errorResponse != null) {
+      return params.errorResponse
     }
-    if (params?.throwError && !params?.errorResponse) {
-      throw error;
+    if (params.throwError === true && params.errorResponse == null) {
+      throw error
     }
-    if (params?.throwError && params?.errorResponse) {
-      return params?.errorResponse;
+    if (params.throwError === true && params.errorResponse != null) {
+      return params.errorResponse
     }
   }
 
   protected validateIncomingRequestPayload<T extends JsonType>(
     chargingStation: ChargingStation,
     commandName: IncomingRequestCommand,
-    schema: JSONSchemaType<T>,
     payload: T
   ): boolean {
-    if (chargingStation.getPayloadSchemaValidation() === false) {
-      return true;
+    if (chargingStation.stationInfo?.ocppStrictCompliance === false) {
+      return true
     }
-    const validate = this.ajv.compile(schema);
-    if (validate(payload)) {
-      return true;
+    const validate = this.payloadValidateFunctions.get(commandName)
+    if (validate?.(payload) === true) {
+      return true
     }
     logger.error(
       `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestPayload: Command '${commandName}' incoming request PDU is invalid: %j`,
-      validate.errors
-    );
+      validate?.errors
+    )
     throw new OCPPError(
-      OCPPServiceUtils.ajvErrorsToErrorType(validate.errors),
+      OCPPServiceUtils.ajvErrorsToErrorType(validate?.errors),
       'Incoming request PDU is invalid',
       commandName,
-      JSON.stringify(validate.errors, null, 2)
-    );
+      JSON.stringify(validate?.errors, undefined, 2)
+    )
   }
 
-  protected handleRequestClearCache(chargingStation: ChargingStation): ClearCacheResponse {
-    chargingStation.idTagsCache.deleteIdTags(
-      ChargingStationUtils.getIdTagsFile(chargingStation.stationInfo)
-    );
-    return OCPPConstants.OCPP_RESPONSE_ACCEPTED;
+  protected handleRequestClearCache (chargingStation: ChargingStation): ClearCacheResponse {
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    if (chargingStation.idTagsCache.deleteIdTags(getIdTagsFile(chargingStation.stationInfo!)!)) {
+      return OCPPConstants.OCPP_RESPONSE_ACCEPTED
+    }
+    return OCPPConstants.OCPP_RESPONSE_REJECTED
   }
 
-  public abstract incomingRequestHandler(
+  // 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
-  ): Promise<void>;
+    commandPayload: ReqType
+  ): Promise<void>
 }