refactor: remove payloadSchemaValidation from template in favor of ocppStrictCompliance
[e-mobility-charging-stations-simulator.git] / src / charging-station / ocpp / OCPPResponseService.ts
index 3faa4351e7ef8867096c2844ef5d243110dcfb0d..1bc4a8a8f6ae3a713da40be7ca0079aa96ae5865 100644 (file)
@@ -1,25 +1,48 @@
-import type { JSONSchemaType } from 'ajv';
-import Ajv from 'ajv-draft-04';
+import Ajv, { type JSONSchemaType } from 'ajv';
 import ajvFormats from 'ajv-formats';
 
-import OCPPError from '../../exception/OCPPError';
-import type { JsonType } from '../../types/JsonType';
-import type { RequestCommand } from '../../types/ocpp/Requests';
-import logger from '../../utils/Logger';
-import type ChargingStation from '../ChargingStation';
 import { OCPPServiceUtils } from './OCPPServiceUtils';
+import type { ChargingStation } from '../../charging-station';
+import { OCPPError } from '../../exception';
+import type {
+  IncomingRequestCommand,
+  JsonObject,
+  JsonType,
+  OCPPVersion,
+  RequestCommand,
+} from '../../types';
+import { logger } from '../../utils';
 
 const moduleName = 'OCPPResponseService';
 
-export default abstract class OCPPResponseService {
+export abstract class OCPPResponseService {
   private static instance: OCPPResponseService | null = null;
-  private ajv: Ajv;
+  private readonly version: OCPPVersion;
+  private readonly ajv: Ajv;
+  public abstract jsonIncomingRequestResponseSchemas: Map<
+    IncomingRequestCommand,
+    JSONSchemaType<JsonObject>
+  >;
 
-  protected constructor() {
-    this.ajv = new Ajv();
+  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);
+    this.responseHandler = this.responseHandler.bind(this) as (
+      chargingStation: ChargingStation,
+      commandName: RequestCommand,
+      payload: JsonType,
+      requestPayload: JsonType
+    ) => Promise<void>;
+    this.validateResponsePayload = this.validateResponsePayload.bind(this) as <T extends JsonType>(
+      chargingStation: ChargingStation,
+      commandName: RequestCommand,
+      schema: JSONSchemaType<T>,
+      payload: T
+    ) => boolean;
   }
 
   public static getInstance<T extends OCPPResponseService>(this: new () => T): T {
@@ -35,7 +58,7 @@ export default abstract class OCPPResponseService {
     schema: JSONSchemaType<T>,
     payload: T
   ): boolean {
-    if (!chargingStation.getPayloadSchemaValidation()) {
+    if (chargingStation.getOcppStrictCompliance() === false) {
       return true;
     }
     const validate = this.ajv.compile(schema);
@@ -43,7 +66,7 @@ export default abstract class OCPPResponseService {
       return true;
     }
     logger.error(
-      `${chargingStation.logPrefix()} ${moduleName}.validateResponsePayload: Response PDU is invalid: %j`,
+      `${chargingStation.logPrefix()} ${moduleName}.validateResponsePayload: Command '${commandName}' response PDU is invalid: %j`,
       validate.errors
     );
     throw new OCPPError(
@@ -54,8 +77,9 @@ export default abstract class OCPPResponseService {
     );
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-empty-function
-  protected emptyResponseHandler() {}
+  protected emptyResponseHandler() {
+    /* This is intentional */
+  }
 
   public abstract responseHandler(
     chargingStation: ChargingStation,