-import type ChargingStation from '../ChargingStation';
-import { JsonType } from '../../types/JsonType';
-import { RequestCommand } from '../../types/ocpp/Requests';
+import Ajv, { type JSONSchemaType, type ValidateFunction } 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, 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;
+
+ public jsonIncomingRequestResponseValidateFunctions: Map<
+ IncomingRequestCommand,
+ ValidateFunction<JsonType>
+ >;
+
+ private readonly version: OCPPVersion;
+ private readonly ajv: Ajv;
+ private jsonRequestValidateFunctions: Map<RequestCommand, ValidateFunction<JsonType>>;
+
+ public abstract jsonIncomingRequestResponseSchemas: Map<
+ IncomingRequestCommand,
+ JSONSchemaType<JsonType>
+ >;
+
+ protected constructor(version: OCPPVersion) {
+ this.version = version;
+ this.ajv = new Ajv({
+ keywords: ['javaType'],
+ multipleOfPrecision: 2,
+ });
+ ajvFormats(this.ajv);
+ this.jsonRequestValidateFunctions = new Map<RequestCommand, ValidateFunction<JsonType>>();
+ this.jsonIncomingRequestResponseValidateFunctions = new Map<
+ IncomingRequestCommand,
+ ValidateFunction<JsonType>
+ >();
+ this.responseHandler = this.responseHandler.bind(this) as <
+ ReqType extends JsonType,
+ ResType extends JsonType,
+ >(
+ chargingStation: ChargingStation,
+ commandName: RequestCommand,
+ payload: ResType,
+ requestPayload: ReqType,
+ ) => 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 (chargingStation: ChargingStation) => T,
- chargingStation: ChargingStation
- ): T {
- if (!OCPPResponseService.instances.has(chargingStation.hashId)) {
- OCPPResponseService.instances.set(chargingStation.hashId, new this(chargingStation));
+ public static getInstance<T extends OCPPResponseService>(this: new () => T): T {
+ if (OCPPResponseService.instance === null) {
+ OCPPResponseService.instance = new this();
+ }
+ return OCPPResponseService.instance as T;
+ }
+
+ protected validateResponsePayload<T extends JsonType>(
+ chargingStation: ChargingStation,
+ commandName: RequestCommand,
+ schema: JSONSchemaType<T>,
+ payload: T,
+ ): boolean {
+ if (chargingStation.stationInfo?.ocppStrictCompliance === false) {
+ return true;
+ }
+ const validate = this.getJsonRequestValidateFunction<T>(commandName, schema);
+ if (validate(payload)) {
+ return true;
+ }
+ 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, undefined, 2),
+ );
+ }
+
+ protected emptyResponseHandler() {
+ /* This is intentional */
+ }
+
+ private getJsonRequestValidateFunction<T extends JsonType>(
+ commandName: RequestCommand,
+ schema: JSONSchemaType<T>,
+ ) {
+ if (this.jsonRequestValidateFunctions.has(commandName) === false) {
+ this.jsonRequestValidateFunctions.set(commandName, this.ajv.compile<T>(schema).bind(this));
}
- return OCPPResponseService.instances.get(chargingStation.hashId) as T;
+ return this.jsonRequestValidateFunctions.get(commandName)!;
}
- public abstract responseHandler(
+ public abstract responseHandler<ReqType extends JsonType, ResType extends JsonType>(
+ chargingStation: ChargingStation,
commandName: RequestCommand,
- payload: JsonType | string,
- requestPayload: JsonType
+ payload: ResType,
+ requestPayload: ReqType,
): Promise<void>;
}