Validate response PDU (#137)
[e-mobility-charging-stations-simulator.git] / src / charging-station / ocpp / OCPPResponseService.ts
index ffcb888fe422bf35bb24549205ff4dfbc3ba09f5..905d972a3bc2348eee28bc6d9d347e4e8ec9e6b7 100644 (file)
@@ -1,12 +1,23 @@
+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 {
   private static instance: OCPPResponseService | null = null;
+  private ajv: Ajv;
 
   protected constructor() {
-    // This is intentional
+    this.ajv = new Ajv();
+    ajvFormats(this.ajv);
   }
 
   public static getInstance<T extends OCPPResponseService>(this: new () => T): T {
@@ -16,6 +27,31 @@ export default abstract class OCPPResponseService {
     return OCPPResponseService.instance as T;
   }
 
+  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 responseHandler(
     chargingStation: ChargingStation,
     commandName: RequestCommand,