-import type ChargingStation from '../ChargingStation';
-import { JsonObject } from '../../types/JsonType';
+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 { RequestCommand } from '../../types/ocpp/Requests';
+import logger from '../../utils/Logger';
+import type ChargingStation from '../ChargingStation';
+import { OCPPServiceUtils } from './OCPPServiceUtils';
+
+const moduleName = 'OCPPResponseService';
export default abstract class OCPPResponseService {
- private static readonly instances: Map<string, OCPPResponseService> = new Map<
- string,
- OCPPResponseService
- >();
+ private static instance: OCPPResponseService | null = null;
+ private ajv: Ajv;
- protected readonly chargingStation: ChargingStation;
+ protected constructor() {
+ this.ajv = new Ajv();
+ ajvFormats(this.ajv);
+ this.responseHandler.bind(this);
+ this.validateResponsePayload.bind(this);
+ }
- protected constructor(chargingStation: ChargingStation) {
- this.chargingStation = chargingStation;
+ 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()) {
+ return true;
}
- return OCPPResponseService.instances.get(chargingStation.hashId) as T;
+ 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(
+ OCPPServiceUtils.ajvErrorsToErrorType(validate.errors),
+ 'Response PDU is invalid',
+ commandName,
+ JSON.stringify(validate.errors, null, 2)
+ );
}
+ // eslint-disable-next-line @typescript-eslint/no-empty-function
+ protected emptyResponseHandler() {}
+
public abstract responseHandler(
+ chargingStation: ChargingStation,
commandName: RequestCommand,
- payload: JsonObject,
- requestPayload: JsonObject
+ payload: JsonType,
+ requestPayload: JsonType
): Promise<void>;
}