Validate response PDU (#137)

[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..905d972a3bc2348eee28bc6d9d347e4e8ec9e6b7 100644 (file)
--- a/src/charging-station/ocpp/OCPPResponseService.ts
+++ b/src/charging-station/ocpp/OCPPResponseService.ts
@@ -1,12 +1,61 @@
-import ChargingStation from '../ChargingStation';
+import { JSONSchemaType } from 'ajv';
+import Ajv from 'ajv-draft-04';
+import ajvFormats from 'ajv-formats';
+
+import OCPPError from '../../exception/OCPPError';
+import { JsonType } from '../../types/JsonType';
+import { ErrorType } from '../../types/ocpp/ErrorType';
 import { 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 ajv: Ajv;
+
+  protected constructor() {
+    this.ajv = new Ajv();
+    ajvFormats(this.ajv);
+  }
+
+  public static getInstance<T extends OCPPResponseService>(this: new () => T): T {
+    if (!OCPPResponseService.instance) {
+      OCPPResponseService.instance = new this();
+    }
+    return OCPPResponseService.instance as T;
+  }
 
-  constructor(chargingStation: ChargingStation) {
-    this.chargingStation = chargingStation;
+  protected validateResponsePayload<T extends JsonType>(
+    chargingStation: ChargingStation,
+    commandName: RequestCommand,
+    schema: JSONSchemaType<T>,
+    payload: T
+  ): boolean {
+    if (!chargingStation.getPayloadSchemaValidation()) {
+      return true;
+    }
+    const validate = this.ajv.compile(schema);
+    if (validate(payload)) {
+      return true;
+    }
+    logger.error(
+      `${chargingStation.logPrefix()} ${moduleName}.validateResponsePayload: Response PDU is invalid: %j`,
+      validate.errors
+    );
+    throw new OCPPError(
+      ErrorType.FORMATION_VIOLATION,
+      'Response PDU is invalid',
+      commandName,
+      JSON.stringify(validate.errors, null, 2)
+    );
   }
 
-  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>;
 }