refactor: revert internal exports

[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 e838bd9fb1d4ae2280ca08d2e9516917ffac37fc..caf826e0eef5fdab24396a9adda464243602128a 100644 (file)
--- a/src/charging-station/ocpp/OCPPResponseService.ts
+++ b/src/charging-station/ocpp/OCPPResponseService.ts
@@ -1,30 +1,88 @@
-import type ChargingStation from '../ChargingStation';
-import { JsonType } from '../../types/JsonType';
-import { RequestCommand } from '../../types/ocpp/Requests';
+import Ajv, { type JSONSchemaType } from 'ajv';
+import ajvFormats from 'ajv-formats';
 
-export default abstract class OCPPResponseService {
-  private static readonly instances: Map<string, OCPPResponseService> = new Map<
-    string,
-    OCPPResponseService
-  >();
+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';
 
-  protected readonly chargingStation: ChargingStation;
+const moduleName = 'OCPPResponseService';
 
-  protected constructor(chargingStation: ChargingStation) {
-    this.chargingStation = chargingStation;
+export abstract class OCPPResponseService {
+  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 = 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 {
+    if (OCPPResponseService.instance === null) {
+      OCPPResponseService.instance = new this();
+    }
+    return OCPPResponseService.instance as T;
   }
 
-  public static getInstance<T extends OCPPResponseService>(
-    this: new (chargingStation: ChargingStation) => T,
-    chargingStation: ChargingStation
-  ): T {
-    if (!OCPPResponseService.instances.has(chargingStation.hashId)) {
-      OCPPResponseService.instances.set(chargingStation.hashId, new this(chargingStation));
+  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;
     }
-    return OCPPResponseService.instances.get(chargingStation.hashId) as T;
+    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)
+    );
+  }
+
+  protected emptyResponseHandler() {
+    /* This is intentional */
   }
 
   public abstract responseHandler(
+    chargingStation: ChargingStation,
     commandName: RequestCommand,
     payload: JsonType,
     requestPayload: JsonType