Linter fixes

[e-mobility-charging-stations-simulator.git] / src / charging-station / ocpp / OCPPResponseService.ts

diff --git a/src/charging-station/ocpp/OCPPResponseService.ts b/src/charging-station/ocpp/OCPPResponseService.ts
index 0a1cd0c610a117ad9c7b0af8211c6ef2efe037c5..80d5a68687b0ef1011feb4637cd3862acba608a3 100644 (file)
--- a/src/charging-station/ocpp/OCPPResponseService.ts
+++ b/src/charging-station/ocpp/OCPPResponseService.ts
@@ -1,12 +1,76 @@
-import ChargingStation from '../ChargingStation';
-import { RequestCommand } from '../../types/ocpp/Requests';
+import Ajv, { type JSONSchemaType } from 'ajv';
+import ajvFormats from 'ajv-formats';
+
+import { OCPPServiceUtils } from './OCPPServiceUtils';
+import OCPPError from '../../exception/OCPPError';
+import type { JsonObject, JsonType } from '../../types/JsonType';
+import type { OCPPVersion } from '../../types/ocpp/OCPPVersion';
+import type { IncomingRequestCommand, RequestCommand } from '../../types/ocpp/Requests';
+import logger from '../../utils/Logger';
+import type ChargingStation from '../ChargingStation';
+
+const moduleName = 'OCPPResponseService';
 
 export default abstract class OCPPResponseService {
-  protected chargingStation: ChargingStation;
+  private static instance: OCPPResponseService | null = null;
+  private readonly version: OCPPVersion;
+  private readonly ajv: Ajv;
+  public abstract jsonIncomingRequestResponseSchemas: Map<
+    IncomingRequestCommand,
+    JSONSchemaType<JsonObject>
+  >;
+
+  protected constructor(version: OCPPVersion) {
+    this.version = version;
+    this.ajv = new Ajv({
+      keywords: ['javaType'],
+      multipleOfPrecision: 2,
+    });
+    ajvFormats(this.ajv);
+    this.responseHandler.bind(this);
+    this.validateResponsePayload.bind(this);
+  }
+
+  public static getInstance<T extends OCPPResponseService>(this: new () => T): T {
+    if (OCPPResponseService.instance === null) {
+      OCPPResponseService.instance = new this();
+    }
+    return OCPPResponseService.instance as T;
+  }
+
+  protected validateResponsePayload<T extends JsonType>(
+    chargingStation: ChargingStation,
+    commandName: RequestCommand,
+    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}.validateResponsePayload: Command '${commandName}' response PDU is invalid: %j`,
+      validate.errors
+    );
+    throw new OCPPError(
+      OCPPServiceUtils.ajvErrorsToErrorType(validate.errors),
+      'Response PDU is invalid',
+      commandName,
+      JSON.stringify(validate.errors, null, 2)
+    );
+  }
 
-  constructor(chargingStation: ChargingStation) {
-    this.chargingStation = chargingStation;
+  protected emptyResponseHandler() {
+    /* This is intentional */
   }
 
-  public abstract handleResponse(commandName: RequestCommand, payload: Record<string, unknown> | string, requestPayload: Record<string, unknown>): Promise<void>;
+  public abstract responseHandler(
+    chargingStation: ChargingStation,
+    commandName: RequestCommand,
+    payload: JsonType,
+    requestPayload: JsonType
+  ): Promise<void>;
 }