X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F2.0%2FOCPP20IncomingRequestService.ts;h=b1cd51fc8e935a7cebfe05a935a623ca4e41dc6c;hb=456c58bcaa0653b69c47a1f4d11138599f1bab4a;hp=1c70027293887f8f06d5f6063b44784bcbdcf630;hpb=2896e06dc8d72adf7150b23c941079f622f6f37c;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 1c700272..b1cd51fc 100644 --- a/src/charging-station/ocpp/2.0/OCPP20IncomingRequestService.ts +++ b/src/charging-station/ocpp/2.0/OCPP20IncomingRequestService.ts @@ -1,58 +1,69 @@ -// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved. -import type { JSONSchemaType } from 'ajv'; +import type { ValidateFunction } from 'ajv' -import type { ChargingStation } from '../../../charging-station'; -import { OCPPError } from '../../../exception'; +import type { ChargingStation } from '../../../charging-station/index.js' +import { OCPPError } from '../../../exception/index.js' import { ErrorType, type IncomingRequestHandler, - type JsonObject, type JsonType, type OCPP20ClearCacheRequest, OCPP20IncomingRequestCommand, - OCPPVersion, -} from '../../../types'; -import { logger } from '../../../utils/Logger'; -import { OCPP20ServiceUtils, OCPPIncomingRequestService } from '../internal'; + OCPPVersion +} from '../../../types/index.js' +import { isAsyncFunction, logger } from '../../../utils/index.js' +import { OCPPIncomingRequestService } from '../OCPPIncomingRequestService.js' +import { OCPP20ServiceUtils } from './OCPP20ServiceUtils.js' -const moduleName = 'OCPP20IncomingRequestService'; +const moduleName = 'OCPP20IncomingRequestService' export class OCPP20IncomingRequestService extends OCPPIncomingRequestService { - protected jsonSchemas: Map>; - private incomingRequestHandlers: Map; + protected payloadValidateFunctions: Map> - public constructor() { - if (new.target?.name === moduleName) { - throw new TypeError(`Cannot construct ${new.target?.name} instances directly`); - } - super(OCPPVersion.VERSION_20); + 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_201) this.incomingRequestHandlers = new Map([ - [OCPP20IncomingRequestCommand.CLEAR_CACHE, this.handleRequestClearCache.bind(this)], - ]); - this.jsonSchemas = new Map>([ + [OCPP20IncomingRequestCommand.CLEAR_CACHE, this.handleRequestClearCache.bind(this)] + ]) + this.payloadValidateFunctions = new Map< + OCPP20IncomingRequestCommand, + ValidateFunction + >([ [ OCPP20IncomingRequestCommand.CLEAR_CACHE, - OCPP20ServiceUtils.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/2.0/ClearCacheRequest.json', - moduleName, - 'constructor' - ), - ], - ]); - this.validatePayload.bind(this); + 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 && + chargingStation.stationInfo?.ocppStrictCompliance === true && + chargingStation.inPendingState() && (commandName === OCPP20IncomingRequestCommand.REQUEST_START_TRANSACTION || commandName === OCPP20IncomingRequestCommand.REQUEST_STOP_TRANSACTION) ) { @@ -60,61 +71,64 @@ export class OCPP20IncomingRequestService extends OCPPIncomingRequestService { 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)( - chargingStation, - commandPayload - ); + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + const incomingRequestHandler = this.incomingRequestHandlers.get(commandName)! + if (isAsyncFunction(incomingRequestHandler)) { + response = (await incomingRequestHandler(chargingStation, commandPayload)) as ResType + } else { + response = incomingRequestHandler(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 throw new OCPPError( ErrorType.NOT_IMPLEMENTED, - `${commandName} is not implemented to handle request PDU ${JSON.stringify( + `'${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.`, + )} while the charging station is not registered on the central server`, commandName, commandPayload - ); + ) } // Send the built response await chargingStation.ocppRequestService.sendResponse( @@ -122,25 +136,22 @@ export class OCPP20IncomingRequestService extends OCPPIncomingRequestService { messageId, response, commandName - ); + ) + // Emit command name event to allow delayed handling + this.emit(commandName, chargingStation, commandPayload, response) } - private validatePayload( + private validatePayload ( chargingStation: ChargingStation, commandName: OCPP20IncomingRequestCommand, commandPayload: JsonType ): boolean { - if (this.jsonSchemas.has(commandName) === true) { - 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 } }