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 bf5170956f499d4c9e41897f879bc0a1e095c320..7c88547a6c63ce285e2009e6561b9d813fc99b53 100644 (file)
--- a/src/charging-station/ocpp/OCPPIncomingRequestService.ts
+++ b/src/charging-station/ocpp/OCPPIncomingRequestService.ts
@@ -1,49 +1,114 @@
-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';
+import { EventEmitter } from 'node:events'
 
-export default abstract class OCPPIncomingRequestService {
-  private static instance: OCPPIncomingRequestService | null = null;
+import _Ajv, { type ValidateFunction } from 'ajv'
+import _ajvFormats from 'ajv-formats'
 
-  protected constructor() {
-    // This is intentional
+import { type ChargingStation, getIdTagsFile } from '../../charging-station/index.js'
+import { OCPPError } from '../../exception/index.js'
+import type {
+  ClearCacheResponse,
+  HandleErrorParams,
+  IncomingRequestCommand,
+  JsonType,
+  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'
+
+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()
+    this.version = version
+    this.ajv = new Ajv({
+      keywords: ['javaType'],
+      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) {
-      OCPPIncomingRequestService.instance = new this();
+    if (OCPPIncomingRequestService.instance === null) {
+      OCPPIncomingRequestService.instance = new this()
     }
-    return OCPPIncomingRequestService.instance as T;
+    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() + ' Incoming request command %s error: %j',
-      commandName,
+      `${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,
+    payload: T
+  ): boolean {
+    if (chargingStation.stationInfo?.ocppStrictCompliance === false) {
+      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
+    )
+    throw new OCPPError(
+      OCPPServiceUtils.ajvErrorsToErrorType(validate?.errors),
+      'Incoming request PDU is invalid',
+      commandName,
+      JSON.stringify(validate?.errors, undefined, 2)
+    )
+  }
+
+  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>
 }