X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F2.0%2FOCPP20IncomingRequestService.ts;h=94401593b6d0f5ae772bdb9098d60162914e377d;hb=dd21af153ed64c6220b6b14a5165c11443032f4f;hp=076832af515a78f80b8820ccf92eef3bab81ba1e;hpb=953d6b028e82d6997897802afefbb4ce0d225dee;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/2.0/OCPP20IncomingRequestService.ts b/src/charging-station/ocpp/2.0/OCPP20IncomingRequestService.ts index 076832af..94401593 100644 --- a/src/charging-station/ocpp/2.0/OCPP20IncomingRequestService.ts +++ b/src/charging-station/ocpp/2.0/OCPP20IncomingRequestService.ts @@ -1,80 +1,107 @@ -// Partial Copyright Jerome Benoit. 2021. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved. -import type { JSONSchemaType } from 'ajv'; +import type { ValidateFunction } from 'ajv' -import OCPPError from '../../../exception/OCPPError'; -import type { JsonObject, JsonType } from '../../../types/JsonType'; -import type { OCPP20IncomingRequestCommand } from '../../../types/ocpp/2.0/Requests'; -import { ErrorType } from '../../../types/ocpp/ErrorType'; -import type { IncomingRequestHandler } from '../../../types/ocpp/Requests'; -import logger from '../../../utils/Logger'; -import type ChargingStation from '../../ChargingStation'; -import OCPPIncomingRequestService from '../OCPPIncomingRequestService'; -import { OCPP20ServiceUtils } from './OCPP20ServiceUtils'; +import { OCPP20ServiceUtils } from './OCPP20ServiceUtils.js' +import type { ChargingStation } from '../../../charging-station/index.js' +import { OCPPError } from '../../../exception/index.js' +import { + ErrorType, + type IncomingRequestHandler, + type JsonType, + type OCPP20ClearCacheRequest, + OCPP20IncomingRequestCommand, + OCPPVersion +} from '../../../types/index.js' +import { logger } from '../../../utils/index.js' +import { OCPPIncomingRequestService } from '../OCPPIncomingRequestService.js' -const moduleName = 'OCPP20IncomingRequestService'; +const moduleName = 'OCPP20IncomingRequestService' -export default class OCPP20IncomingRequestService extends OCPPIncomingRequestService { - private incomingRequestHandlers: Map; - private jsonSchemas: Map>; +export class OCPP20IncomingRequestService extends OCPPIncomingRequestService { + protected payloadValidateFunctions: Map> - public constructor() { - if (new.target?.name === moduleName) { - throw new TypeError(`Cannot construct ${new.target?.name} instances directly`); - } - super(); - this.incomingRequestHandlers = new Map(); - this.jsonSchemas = new Map>(); - this.validatePayload.bind(this); + private readonly incomingRequestHandlers: Map< + OCPP20IncomingRequestCommand, + IncomingRequestHandler + > + + public constructor () { + // if (new.target.name === moduleName) { + // throw new TypeError(`Cannot construct ${new.target.name} instances directly`) + // } + super(OCPPVersion.VERSION_20) + this.incomingRequestHandlers = new Map([ + [OCPP20IncomingRequestCommand.CLEAR_CACHE, this.handleRequestClearCache.bind(this)] + ]) + this.payloadValidateFunctions = new Map< + OCPP20IncomingRequestCommand, + ValidateFunction + >([ + [ + OCPP20IncomingRequestCommand.CLEAR_CACHE, + this.ajv + .compile( + OCPP20ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/2.0/ClearCacheRequest.json', + moduleName, + 'constructor' + ) + ) + .bind(this) + ] + ]) + this.validatePayload = this.validatePayload.bind(this) } - public async incomingRequestHandler( + public async incomingRequestHandler( chargingStation: ChargingStation, messageId: string, commandName: OCPP20IncomingRequestCommand, - commandPayload: JsonType + commandPayload: ReqType ): Promise { - let response: JsonType; + let response: ResType if ( - chargingStation.getOcppStrictCompliance() === true && - chargingStation.isInPendingState() === true /* && - (commandName === OCPP20IncomingRequestCommand.REMOTE_START_TRANSACTION || - commandName === OCPP20IncomingRequestCommand.REMOTE_STOP_TRANSACTION ) */ + chargingStation.stationInfo?.ocppStrictCompliance === true && + chargingStation.inPendingState() && + (commandName === OCPP20IncomingRequestCommand.REQUEST_START_TRANSACTION || + commandName === OCPP20IncomingRequestCommand.REQUEST_STOP_TRANSACTION) ) { throw new OCPPError( ErrorType.SECURITY_ERROR, `${commandName} cannot be issued to handle request PDU ${JSON.stringify( commandPayload, - null, + undefined, 2 )} while the charging station is in pending state on the central server`, commandName, commandPayload - ); + ) } if ( - chargingStation.isRegistered() === true || - (chargingStation.getOcppStrictCompliance() === false && - chargingStation.isInUnknownState() === true) + chargingStation.isRegistered() || + (chargingStation.stationInfo?.ocppStrictCompliance === false && + chargingStation.inUnknownState()) ) { if ( - this.incomingRequestHandlers.has(commandName) === true && - OCPP20ServiceUtils.isIncomingRequestCommandSupported(chargingStation, commandName) === true + this.incomingRequestHandlers.has(commandName) && + OCPP20ServiceUtils.isIncomingRequestCommandSupported(chargingStation, commandName) ) { try { - this.validatePayload(chargingStation, commandName, commandPayload); + this.validatePayload(chargingStation, commandName, commandPayload) // Call the method to build the response - response = await this.incomingRequestHandlers.get(commandName)( + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + response = (await this.incomingRequestHandlers.get(commandName)!( chargingStation, commandPayload - ); + )) as ResType } catch (error) { // Log logger.error( `${chargingStation.logPrefix()} ${moduleName}.incomingRequestHandler: Handle incoming request error:`, error - ); - throw error; + ) + throw error } } else { // Throw exception @@ -82,24 +109,24 @@ export default class OCPP20IncomingRequestService extends OCPPIncomingRequestSer ErrorType.NOT_IMPLEMENTED, `${commandName} is not implemented to handle request PDU ${JSON.stringify( commandPayload, - null, + undefined, 2 )}`, commandName, commandPayload - ); + ) } } else { throw new OCPPError( ErrorType.SECURITY_ERROR, `${commandName} cannot be issued to handle request PDU ${JSON.stringify( commandPayload, - null, + undefined, 2 )} while the charging station is not registered on the central server.`, commandName, commandPayload - ); + ) } // Send the built response await chargingStation.ocppRequestService.sendResponse( @@ -107,25 +134,20 @@ export default class OCPP20IncomingRequestService extends OCPPIncomingRequestSer messageId, response, commandName - ); + ) } - private validatePayload( + private validatePayload ( chargingStation: ChargingStation, commandName: OCPP20IncomingRequestCommand, commandPayload: JsonType ): boolean { - if (this.jsonSchemas.has(commandName)) { - return this.validateIncomingRequestPayload( - chargingStation, - commandName, - this.jsonSchemas.get(commandName), - commandPayload - ); + if (this.payloadValidateFunctions.has(commandName)) { + return this.validateIncomingRequestPayload(chargingStation, commandName, commandPayload) } logger.warn( - `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command ${commandName} PDU validation` - ); - return false; + `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema validation function found for command '${commandName}' PDU validation` + ) + return false } }