Merge dependabot/npm_and_yarn/prettier-3.2.4 into combined-prs-branch

[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 e1651539699e8ffc0400f614c213ed5019cc9df6..5eaddae90976cef25602583412ebd02e899909bb 100644 (file)
--- a/src/charging-station/ocpp/OCPPIncomingRequestService.ts
+++ b/src/charging-station/ocpp/OCPPIncomingRequestService.ts
@@ -1,22 +1,138 @@
-import ChargingStation from '../ChargingStation';
-import { IncomingRequestCommand } from '../../types/ocpp/Requests';
-import { JsonType } from '../../types/JsonType';
-import logger from '../../utils/Logger';
+import _Ajv, { type JSONSchemaType, type ValidateFunction } from 'ajv'
+import _ajvFormats from 'ajv-formats'
 
-export default abstract class OCPPIncomingRequestService {
-  protected chargingStation: ChargingStation;
+import { OCPPConstants } from './OCPPConstants.js'
+import { OCPPServiceUtils } from './OCPPServiceUtils.js'
+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'
+type Ajv = _Ajv.default
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+const Ajv = _Ajv.default
+const ajvFormats = _ajvFormats.default
 
-  constructor(chargingStation: ChargingStation) {
-    this.chargingStation = chargingStation;
+const moduleName = 'OCPPIncomingRequestService'
+
+export abstract class OCPPIncomingRequestService {
+  private static instance: OCPPIncomingRequestService | null = null
+  private readonly version: OCPPVersion
+  private readonly ajv: Ajv
+  private readonly jsonValidateFunctions: Map<IncomingRequestCommand, ValidateFunction<JsonType>>
+  protected abstract jsonSchemas: Map<IncomingRequestCommand, JSONSchemaType<JsonType>>
+
+  protected constructor (version: OCPPVersion) {
+    this.version = version
+    this.ajv = new Ajv({
+      keywords: ['javaType'],
+      multipleOfPrecision: 2
+    })
+    ajvFormats(this.ajv)
+    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 {
+    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 === false && params.errorResponse != null) {
+      return params.errorResponse
+    }
+    if (params.throwError === true && params.errorResponse == null) {
+      throw error
+    }
+    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.stationInfo?.ocppStrictCompliance === false) {
+      return true
+    }
+    const validate = this.getJsonIncomingRequestValidateFunction<T>(commandName, 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, 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
   }
 
-  protected handleIncomingRequestError<T>(commandName: IncomingRequestCommand, error: Error, errorOcppResponse?: T): T {
-    logger.error(this.chargingStation.logPrefix() + ' Incoming request command %s error: %j', commandName, error);
-    if (errorOcppResponse) {
-      return errorOcppResponse;
+  private getJsonIncomingRequestValidateFunction<T extends JsonType>(
+    commandName: IncomingRequestCommand,
+    schema: JSONSchemaType<T>
+  ): ValidateFunction<JsonType> {
+    if (!this.jsonValidateFunctions.has(commandName)) {
+      this.jsonValidateFunctions.set(commandName, this.ajv.compile<T>(schema).bind(this))
     }
-    throw error;
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    return this.jsonValidateFunctions.get(commandName)!
   }
 
-  public abstract handleRequest(messageId: string, commandName: IncomingRequestCommand, commandPayload: JsonType): Promise<void>;
+  // 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>
 }