-import ChargingStation from '../ChargingStation';
+import { JSONSchemaType } from 'ajv';
+import Ajv from 'ajv-draft-04';
+import ajvFormats from 'ajv-formats';
+
+import OCPPError from '../../exception/OCPPError';
+import { HandleErrorParams } from '../../types/Error';
+import { JsonType } from '../../types/JsonType';
import { IncomingRequestCommand } from '../../types/ocpp/Requests';
import logger from '../../utils/Logger';
+import type ChargingStation from '../ChargingStation';
+import { OCPPServiceUtils } from './OCPPServiceUtils';
+
+const moduleName = 'OCPPIncomingRequestService';
export default abstract class OCPPIncomingRequestService {
- protected chargingStation: ChargingStation;
+ private static instance: OCPPIncomingRequestService | null = null;
+ private ajv: Ajv;
+
+ protected constructor() {
+ this.ajv = new Ajv();
+ ajvFormats(this.ajv);
+ this.incomingRequestHandler.bind(this);
+ this.validateIncomingRequestPayload.bind(this);
+ }
+
+ public static getInstance<T extends OCPPIncomingRequestService>(this: new () => T): T {
+ if (OCPPIncomingRequestService.instance === null) {
+ OCPPIncomingRequestService.instance = new this();
+ }
+ return OCPPIncomingRequestService.instance as T;
+ }
- constructor(chargingStation: ChargingStation) {
- this.chargingStation = chargingStation;
+ protected handleIncomingRequestError<T>(
+ chargingStation: ChargingStation,
+ commandName: IncomingRequestCommand,
+ error: Error,
+ params: HandleErrorParams<T> = { throwError: true }
+ ): T {
+ logger.error(
+ `${chargingStation.logPrefix()} ${moduleName}.handleIncomingRequestError: Incoming request command %s error:`,
+ commandName,
+ error
+ );
+ if (!params?.throwError && params?.errorResponse) {
+ return params?.errorResponse;
+ }
+ if (params?.throwError && !params?.errorResponse) {
+ throw error;
+ }
+ if (params?.throwError && params?.errorResponse) {
+ return params?.errorResponse;
+ }
}
- public handleIncomingRequestError(commandName: IncomingRequestCommand, error: Error): void {
- logger.error(this.chargingStation.logPrefix() + ' Incoming request command ' + commandName + ' error: %j', error);
- throw error;
+ protected validateIncomingRequestPayload<T extends JsonType>(
+ chargingStation: ChargingStation,
+ commandName: IncomingRequestCommand,
+ 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}.validateIncomingRequestPayload: Incoming request PDU is invalid: %j`,
+ validate.errors
+ );
+ throw new OCPPError(
+ OCPPServiceUtils.ajvErrorsToErrorType(validate.errors),
+ 'Incoming request PDU is invalid',
+ commandName,
+ JSON.stringify(validate.errors, null, 2)
+ );
}
- public abstract handleRequest(messageId: string, commandName: IncomingRequestCommand, commandPayload: Record<string, unknown>): Promise<void>;
+ public abstract incomingRequestHandler(
+ chargingStation: ChargingStation,
+ messageId: string,
+ commandName: IncomingRequestCommand,
+ commandPayload: JsonType
+ ): Promise<void>;
}