X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPIncomingRequestService.ts;h=28de507774a281aeeb0d32b4d17b1348b45d50c5;hb=856e8f67312da4acabeff1bd8452f02658a22fdb;hp=bf5170956f499d4c9e41897f879bc0a1e095c320;hpb=08f130a055123f5e47c59e1a64875f8cff44d020;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/OCPPIncomingRequestService.ts b/src/charging-station/ocpp/OCPPIncomingRequestService.ts index bf517095..28de5077 100644 --- a/src/charging-station/ocpp/OCPPIncomingRequestService.ts +++ b/src/charging-station/ocpp/OCPPIncomingRequestService.ts @@ -1,33 +1,76 @@ -import type ChargingStation from '../ChargingStation'; -import { HandleErrorParams } from '../../types/Error'; -import { IncomingRequestCommand } from '../../types/ocpp/Requests'; -import { JsonType } from '../../types/JsonType'; -import logger from '../../utils/Logger'; +import { AsyncResource } from 'node:async_hooks'; -export default abstract class OCPPIncomingRequestService { +import Ajv, { type JSONSchemaType, type ValidateFunction } from 'ajv'; +import ajvFormats from 'ajv-formats'; + +import { OCPPConstants } from './OCPPConstants'; +import { OCPPServiceUtils } from './OCPPServiceUtils'; +import { type ChargingStation, getIdTagsFile } from '../../charging-station'; +import { OCPPError } from '../../exception'; +import type { + ClearCacheResponse, + HandleErrorParams, + IncomingRequestCommand, + JsonType, + OCPPVersion, +} from '../../types'; +import { logger, setDefaultErrorParams } from '../../utils'; + +const moduleName = 'OCPPIncomingRequestService'; + +export abstract class OCPPIncomingRequestService extends AsyncResource { private static instance: OCPPIncomingRequestService | null = null; + private readonly version: OCPPVersion; + private readonly ajv: Ajv; + private jsonValidateFunctions: Map>; + protected abstract jsonSchemas: Map>; - protected constructor() { - // This is intentional + protected constructor(version: OCPPVersion) { + super(moduleName); + this.version = version; + this.ajv = new Ajv({ + keywords: ['javaType'], + multipleOfPrecision: 2, + }); + ajvFormats(this.ajv); + this.jsonValidateFunctions = new Map>(); + this.incomingRequestHandler = this.incomingRequestHandler.bind(this) as < + ReqType extends JsonType, + // eslint-disable-next-line @typescript-eslint/no-unused-vars + ResType extends JsonType, + >( + chargingStation: ChargingStation, + messageId: string, + commandName: IncomingRequestCommand, + commandPayload: ReqType, + ) => Promise; + this.validateIncomingRequestPayload = this.validateIncomingRequestPayload.bind(this) as < + T extends JsonType, + >( + chargingStation: ChargingStation, + commandName: IncomingRequestCommand, + schema: JSONSchemaType, + payload: T, + ) => boolean; } public static getInstance(this: new () => T): T { - if (!OCPPIncomingRequestService.instance) { + if (OCPPIncomingRequestService.instance === null) { OCPPIncomingRequestService.instance = new this(); } return OCPPIncomingRequestService.instance as T; } - protected handleIncomingRequestError( + protected handleIncomingRequestError( chargingStation: ChargingStation, commandName: IncomingRequestCommand, error: Error, - params: HandleErrorParams = { throwError: true } - ): T { + params: HandleErrorParams = { throwError: true, consoleOut: false }, + ): T | undefined { + setDefaultErrorParams(params); logger.error( - chargingStation.logPrefix() + ' Incoming request command %s error: %j', - commandName, - error + `${chargingStation.logPrefix()} ${moduleName}.handleIncomingRequestError: Incoming request command '${commandName}' error:`, + error, ); if (!params?.throwError && params?.errorResponse) { return params?.errorResponse; @@ -40,10 +83,46 @@ export default abstract class OCPPIncomingRequestService { } } - public abstract incomingRequestHandler( + protected validateIncomingRequestPayload( + chargingStation: ChargingStation, + commandName: IncomingRequestCommand, + schema: JSONSchemaType, + payload: T, + ): boolean { + if (chargingStation.stationInfo?.ocppStrictCompliance === false) { + return true; + } + if (this.jsonValidateFunctions.has(commandName) === false) { + this.jsonValidateFunctions.set(commandName, this.ajv.compile(schema).bind(this)); + } + const validate = this.jsonValidateFunctions.get(commandName)!; + if (validate(payload)) { + return true; + } + logger.error( + `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestPayload: Command '${commandName}' 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, undefined, 2), + ); + } + + protected handleRequestClearCache(chargingStation: ChargingStation): ClearCacheResponse { + if (chargingStation.idTagsCache.deleteIdTags(getIdTagsFile(chargingStation.stationInfo)!)) { + return OCPPConstants.OCPP_RESPONSE_ACCEPTED; + } + return OCPPConstants.OCPP_RESPONSE_REJECTED; + } + + // eslint-disable-next-line @typescript-eslint/no-unused-vars + public abstract incomingRequestHandler( chargingStation: ChargingStation, messageId: string, commandName: IncomingRequestCommand, - commandPayload: JsonType + commandPayload: ReqType, ): Promise; }