X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPIncomingRequestService.ts;h=7c88547a6c63ce285e2009e6561b9d813fc99b53;hb=8f46463be058ed68cc4cc962c51722f7e3b55c54;hp=3fc960a9bef4dc27ebee284491b90e40110c8ff6;hpb=9f2e313013116428f5bce2be59e2f5c07502c026;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/OCPPIncomingRequestService.ts b/src/charging-station/ocpp/OCPPIncomingRequestService.ts index 3fc960a9..7c88547a 100644 --- a/src/charging-station/ocpp/OCPPIncomingRequestService.ts +++ b/src/charging-station/ocpp/OCPPIncomingRequestService.ts @@ -1,30 +1,114 @@ -import type ChargingStation from '../ChargingStation'; -import { IncomingRequestCommand } from '../../types/ocpp/Requests'; -import { JsonType } from '../../types/JsonType'; -import logger from '../../utils/Logger'; +import { EventEmitter } from 'node:events' -export default abstract class OCPPIncomingRequestService { - private static readonly instances: Map = new Map(); - protected chargingStation: ChargingStation; +import _Ajv, { type ValidateFunction } from 'ajv' +import _ajvFormats from 'ajv-formats' - protected constructor(chargingStation: ChargingStation) { - this.chargingStation = chargingStation; +import { type ChargingStation, getIdTagsFile } from '../../charging-station/index.js' +import { OCPPError } from '../../exception/index.js' +import type { + ClearCacheResponse, + HandleErrorParams, + IncomingRequestCommand, + JsonType, + OCPPVersion +} from '../../types/index.js' +import { logger, setDefaultErrorParams } from '../../utils/index.js' +import { OCPPConstants } from './OCPPConstants.js' +import { OCPPServiceUtils } from './OCPPServiceUtils.js' +type Ajv = _Ajv.default +// eslint-disable-next-line @typescript-eslint/no-redeclare +const Ajv = _Ajv.default +const ajvFormats = _ajvFormats.default + +const moduleName = 'OCPPIncomingRequestService' + +export abstract class OCPPIncomingRequestService extends EventEmitter { + private static instance: OCPPIncomingRequestService | null = null + private readonly version: OCPPVersion + protected readonly ajv: Ajv + protected abstract payloadValidateFunctions: Map< + IncomingRequestCommand, + ValidateFunction + > + + protected constructor (version: OCPPVersion) { + super() + this.version = version + this.ajv = new Ajv({ + keywords: ['javaType'], + multipleOfPrecision: 2 + }) + ajvFormats(this.ajv) + this.incomingRequestHandler = this.incomingRequestHandler.bind(this) + this.validateIncomingRequestPayload = this.validateIncomingRequestPayload.bind(this) + } + + public static getInstance(this: new () => T): T { + if (OCPPIncomingRequestService.instance === null) { + OCPPIncomingRequestService.instance = new this() + } + return OCPPIncomingRequestService.instance as T } - public static getInstance(this: new (chargingStation: ChargingStation) => T, chargingStation: ChargingStation): T { - if (!OCPPIncomingRequestService.instances.has(chargingStation.id)) { - OCPPIncomingRequestService.instances.set(chargingStation.id, new this(chargingStation)); + protected handleIncomingRequestError( + chargingStation: ChargingStation, + commandName: IncomingRequestCommand, + error: Error, + params: HandleErrorParams = { throwError: true, consoleOut: false } + ): T | undefined { + setDefaultErrorParams(params) + logger.error( + `${chargingStation.logPrefix()} ${moduleName}.handleIncomingRequestError: Incoming request command '${commandName}' error:`, + error + ) + if (params.throwError === false && params.errorResponse != null) { + return params.errorResponse + } + if (params.throwError === true && params.errorResponse == null) { + throw error + } + if (params.throwError === true && params.errorResponse != null) { + return params.errorResponse + } + } + + protected validateIncomingRequestPayload( + chargingStation: ChargingStation, + commandName: IncomingRequestCommand, + payload: T + ): boolean { + if (chargingStation.stationInfo?.ocppStrictCompliance === false) { + return true + } + const validate = this.payloadValidateFunctions.get(commandName) + if (validate?.(payload) === true) { + return true } - return OCPPIncomingRequestService.instances.get(chargingStation.id) as T; + 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 handleIncomingRequestError(commandName: IncomingRequestCommand, error: Error, errorOcppResponse?: T): T { - logger.error(this.chargingStation.logPrefix() + ' Incoming request command %s error: %j', commandName, error); - if (errorOcppResponse) { - return errorOcppResponse; + protected handleRequestClearCache (chargingStation: ChargingStation): ClearCacheResponse { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + if (chargingStation.idTagsCache.deleteIdTags(getIdTagsFile(chargingStation.stationInfo!)!)) { + return OCPPConstants.OCPP_RESPONSE_ACCEPTED } - throw error; + return OCPPConstants.OCPP_RESPONSE_REJECTED } - public abstract handleRequest(messageId: string, commandName: IncomingRequestCommand, commandPayload: JsonType): Promise; + // eslint-disable-next-line @typescript-eslint/no-unused-vars + public abstract incomingRequestHandler( + chargingStation: ChargingStation, + messageId: string, + commandName: IncomingRequestCommand, + commandPayload: ReqType + ): Promise }