X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPResponseService.ts;h=738aa5ae4ffea2c8ea2f7ce7013826241eabb1c1;hb=66a7748ddeda8c94d7562a1ce58d440319654a4c;hp=ffcb888fe422bf35bb24549205ff4dfbc3ba09f5;hpb=8114d10e3893e96bb725ce2fca9744429ee4b75b;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/OCPPResponseService.ts b/src/charging-station/ocpp/OCPPResponseService.ts index ffcb888f..738aa5ae 100644 --- a/src/charging-station/ocpp/OCPPResponseService.ts +++ b/src/charging-station/ocpp/OCPPResponseService.ts @@ -1,25 +1,120 @@ -import { JsonType } from '../../types/JsonType'; -import { RequestCommand } from '../../types/ocpp/Requests'; -import type ChargingStation from '../ChargingStation'; +import _Ajv, { type JSONSchemaType, type ValidateFunction } from 'ajv' +import _ajvFormats from 'ajv-formats' -export default abstract class OCPPResponseService { - private static instance: OCPPResponseService | null = null; +import { OCPPServiceUtils } from './OCPPServiceUtils.js' +import type { ChargingStation } from '../../charging-station/index.js' +import { OCPPError } from '../../exception/index.js' +import type { + IncomingRequestCommand, + JsonType, + OCPPVersion, + RequestCommand +} from '../../types/index.js' +import { logger } from '../../utils/index.js' +type Ajv = _Ajv.default +// eslint-disable-next-line @typescript-eslint/no-redeclare +const Ajv = _Ajv.default +const ajvFormats = _ajvFormats.default - protected constructor() { - // This is intentional +const moduleName = 'OCPPResponseService' + +export abstract class OCPPResponseService { + private static instance: OCPPResponseService | null = null + + public jsonIncomingRequestResponseValidateFunctions: Map< + IncomingRequestCommand, + ValidateFunction + > + + private readonly version: OCPPVersion + private readonly ajv: Ajv + private readonly jsonRequestValidateFunctions: Map> + + public abstract jsonIncomingRequestResponseSchemas: Map< + IncomingRequestCommand, + JSONSchemaType + > + + protected constructor (version: OCPPVersion) { + this.version = version + this.ajv = new Ajv({ + keywords: ['javaType'], + multipleOfPrecision: 2 + }) + ajvFormats(this.ajv) + this.jsonRequestValidateFunctions = new Map>() + this.jsonIncomingRequestResponseValidateFunctions = new Map< + IncomingRequestCommand, + ValidateFunction + >() + this.responseHandler = this.responseHandler.bind(this) as < + ReqType extends JsonType, + ResType extends JsonType + >( + chargingStation: ChargingStation, + commandName: RequestCommand, + payload: ResType, + requestPayload: ReqType + ) => Promise + this.validateResponsePayload = this.validateResponsePayload.bind(this) as ( + chargingStation: ChargingStation, + commandName: RequestCommand, + schema: JSONSchemaType, + payload: T + ) => boolean } public static getInstance(this: new () => T): T { - if (!OCPPResponseService.instance) { - OCPPResponseService.instance = new this(); + if (OCPPResponseService.instance === null) { + OCPPResponseService.instance = new this() + } + return OCPPResponseService.instance as T + } + + protected validateResponsePayload( + chargingStation: ChargingStation, + commandName: RequestCommand, + schema: JSONSchemaType, + payload: T + ): boolean { + if (chargingStation.stationInfo?.ocppStrictCompliance === false) { + return true + } + const validate = this.getJsonRequestValidateFunction(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 (): void { + /* This is intentional */ + } + + private getJsonRequestValidateFunction( + commandName: RequestCommand, + schema: JSONSchemaType + ): ValidateFunction { + if (!this.jsonRequestValidateFunctions.has(commandName)) { + this.jsonRequestValidateFunctions.set(commandName, this.ajv.compile(schema).bind(this)) } - return OCPPResponseService.instance as T; + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + return this.jsonRequestValidateFunctions.get(commandName)! } - public abstract responseHandler( + public abstract responseHandler( chargingStation: ChargingStation, commandName: RequestCommand, - payload: JsonType, - requestPayload: JsonType - ): Promise; + payload: ResType, + requestPayload: ReqType + ): Promise }