X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F2.0%2FOCPP20ResponseService.ts;h=9851d3339371d8fe3e47cb7a5dcaa835d7bcace0;hb=9388120364d5a2f3b9103f05802e1756d2dad04f;hp=98f2afb61ebe816a675181a033c06be715f8ecd1;hpb=a6ef1ece74c0d08e86a905571f4f6045c28131cb;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/2.0/OCPP20ResponseService.ts b/src/charging-station/ocpp/2.0/OCPP20ResponseService.ts index 98f2afb6..9851d333 100644 --- a/src/charging-station/ocpp/2.0/OCPP20ResponseService.ts +++ b/src/charging-station/ocpp/2.0/OCPP20ResponseService.ts @@ -1,11 +1,11 @@ -// 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 { OCPP20ServiceUtils } from './OCPP20ServiceUtils.js'; -import { type ChargingStation, addConfigurationKey } from '../../../charging-station/index.js'; -import { OCPPError } from '../../../exception/index.js'; +import { addConfigurationKey, type ChargingStation } from '../../../charging-station/index.js' +import { OCPPError } from '../../../exception/index.js' import { + ChargingStationEvents, ErrorType, type JsonType, type OCPP20BootNotificationResponse, @@ -17,104 +17,126 @@ import { type OCPP20StatusNotificationResponse, OCPPVersion, RegistrationStatusEnumType, - type ResponseHandler, -} from '../../../types/index.js'; -import { logger } from '../../../utils/index.js'; -import { OCPPResponseService } from '../OCPPResponseService.js'; + type ResponseHandler +} from '../../../types/index.js' +import { isAsyncFunction, logger } from '../../../utils/index.js' +import { OCPPResponseService } from '../OCPPResponseService.js' +import { OCPP20ServiceUtils } from './OCPP20ServiceUtils.js' -const moduleName = 'OCPP20ResponseService'; +const moduleName = 'OCPP20ResponseService' export class OCPP20ResponseService extends OCPPResponseService { - public jsonIncomingRequestResponseSchemas: Map< - OCPP20IncomingRequestCommand, - JSONSchemaType - >; + public incomingRequestResponsePayloadValidateFunctions: Map< + OCPP20IncomingRequestCommand, + ValidateFunction + > - private responseHandlers: Map; - private jsonSchemas: Map>; + protected payloadValidateFunctions: Map> + private readonly responseHandlers: Map - public constructor() { - // if (new.target?.name === moduleName) { - // throw new TypeError(`Cannot construct ${new.target?.name} instances directly`); + public constructor () { + // if (new.target.name === moduleName) { + // throw new TypeError(`Cannot construct ${new.target.name} instances directly`) // } - super(OCPPVersion.VERSION_20); + super(OCPPVersion.VERSION_201) this.responseHandlers = new Map([ [ OCPP20RequestCommand.BOOT_NOTIFICATION, - this.handleResponseBootNotification.bind(this) as ResponseHandler, + this.handleResponseBootNotification.bind(this) as ResponseHandler ], - [OCPP20RequestCommand.HEARTBEAT, this.emptyResponseHandler.bind(this) as ResponseHandler], - [ - OCPP20RequestCommand.STATUS_NOTIFICATION, - this.emptyResponseHandler.bind(this) as ResponseHandler, - ], - ]); - this.jsonSchemas = new Map>([ + [OCPP20RequestCommand.HEARTBEAT, this.emptyResponseHandler], + [OCPP20RequestCommand.STATUS_NOTIFICATION, this.emptyResponseHandler] + ]) + this.payloadValidateFunctions = new Map>([ [ OCPP20RequestCommand.BOOT_NOTIFICATION, - OCPP20ServiceUtils.parseJsonSchemaFile( - 'assets/json-schemas/ocpp/2.0/BootNotificationResponse.json', - moduleName, - 'constructor', - ), + this.ajv + .compile( + OCPP20ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/2.0/BootNotificationResponse.json', + moduleName, + 'constructor' + ) + ) + .bind(this) ], [ OCPP20RequestCommand.HEARTBEAT, - OCPP20ServiceUtils.parseJsonSchemaFile( - 'assets/json-schemas/ocpp/2.0/HeartbeatResponse.json', - moduleName, - 'constructor', - ), + this.ajv + .compile( + OCPP20ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/2.0/HeartbeatResponse.json', + moduleName, + 'constructor' + ) + ) + .bind(this) ], [ OCPP20RequestCommand.STATUS_NOTIFICATION, - OCPP20ServiceUtils.parseJsonSchemaFile( - 'assets/json-schemas/ocpp/2.0/StatusNotificationResponse.json', - moduleName, - 'constructor', - ), - ], - ]); - this.jsonIncomingRequestResponseSchemas = new Map([ + this.ajv + .compile( + OCPP20ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/2.0/StatusNotificationResponse.json', + moduleName, + 'constructor' + ) + ) + .bind(this) + ] + ]) + this.incomingRequestResponsePayloadValidateFunctions = new Map< + OCPP20IncomingRequestCommand, + ValidateFunction + >([ [ OCPP20IncomingRequestCommand.CLEAR_CACHE, - OCPP20ServiceUtils.parseJsonSchemaFile( - 'assets/json-schemas/ocpp/2.0/ClearCacheResponse.json', - moduleName, - 'constructor', - ), - ], - ]); - this.validatePayload = this.validatePayload.bind(this) as ( - chargingStation: ChargingStation, - commandName: OCPP20RequestCommand, - payload: JsonType, - ) => boolean; + this.ajvIncomingRequest + .compile( + OCPP20ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/2.0/ClearCacheResponse.json', + moduleName, + 'constructor' + ) + ) + .bind(this) + ] + ]) + this.validatePayload = this.validatePayload.bind(this) } public async responseHandler( chargingStation: ChargingStation, commandName: OCPP20RequestCommand, payload: ResType, - requestPayload: ReqType, + requestPayload: ReqType ): Promise { - if ( - chargingStation.isRegistered() === true || - commandName === OCPP20RequestCommand.BOOT_NOTIFICATION - ) { + if (chargingStation.isRegistered() || commandName === OCPP20RequestCommand.BOOT_NOTIFICATION) { if ( - this.responseHandlers.has(commandName) === true && - OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true + this.responseHandlers.has(commandName) && + OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName) ) { try { - this.validatePayload(chargingStation, commandName, payload); - await this.responseHandlers.get(commandName)!(chargingStation, payload, requestPayload); + this.validatePayload(chargingStation, commandName, payload) + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + const responseHandler = this.responseHandlers.get(commandName)! + if (isAsyncFunction(responseHandler)) { + await responseHandler(chargingStation, payload, requestPayload) + } else { + ( + responseHandler as ( + chargingStation: ChargingStation, + payload: JsonType, + requestPayload?: JsonType + ) => void + )(chargingStation, payload, requestPayload) + } } catch (error) { logger.error( `${chargingStation.logPrefix()} ${moduleName}.responseHandler: Handle response error:`, - error, - ); - throw error; + error + ) + throw error } } else { // Throw exception @@ -123,11 +145,11 @@ export class OCPP20ResponseService extends OCPPResponseService { `${commandName} is not implemented to handle response PDU ${JSON.stringify( payload, undefined, - 2, + 2 )}`, commandName, - payload, - ); + payload + ) } } else { throw new OCPPError( @@ -135,59 +157,61 @@ export class OCPP20ResponseService extends OCPPResponseService { `${commandName} cannot be issued to handle response PDU ${JSON.stringify( payload, undefined, - 2, - )} while the charging station is not registered on the central server.`, + 2 + )} while the charging station is not registered on the central server`, commandName, - payload, - ); + payload + ) } } - private validatePayload( + private validatePayload ( chargingStation: ChargingStation, commandName: OCPP20RequestCommand, - payload: JsonType, + payload: JsonType ): boolean { - if (this.jsonSchemas.has(commandName) === true) { - return this.validateResponsePayload( - chargingStation, - commandName, - this.jsonSchemas.get(commandName)!, - payload, - ); + if (this.payloadValidateFunctions.has(commandName)) { + return this.validateResponsePayload(chargingStation, commandName, payload) } 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 } - private handleResponseBootNotification( + private handleResponseBootNotification ( chargingStation: ChargingStation, - payload: OCPP20BootNotificationResponse, + payload: OCPP20BootNotificationResponse ): void { - if (payload.status === RegistrationStatusEnumType.ACCEPTED) { - addConfigurationKey( - chargingStation, - OCPP20OptionalVariableName.HeartbeatInterval, - payload.interval.toString(), - {}, - { overwrite: true, save: true }, - ); - OCPP20ServiceUtils.startHeartbeatInterval(chargingStation, payload.interval); - } if (Object.values(RegistrationStatusEnumType).includes(payload.status)) { + chargingStation.bootNotificationResponse = payload + if (chargingStation.isRegistered()) { + chargingStation.emit(ChargingStationEvents.registered) + if (chargingStation.inAcceptedState()) { + addConfigurationKey( + chargingStation, + OCPP20OptionalVariableName.HeartbeatInterval, + payload.interval.toString(), + {}, + { overwrite: true, save: true } + ) + chargingStation.emit(ChargingStationEvents.accepted) + } + } else if (chargingStation.inRejectedState()) { + chargingStation.emit(ChargingStationEvents.rejected) + } const logMsg = `${chargingStation.logPrefix()} Charging station in '${ payload.status - }' state on the central server`; + }' state on the central server` payload.status === RegistrationStatusEnumType.REJECTED ? logger.warn(logMsg) - : logger.info(logMsg); + : logger.info(logMsg) } else { + delete chargingStation.bootNotificationResponse logger.error( `${chargingStation.logPrefix()} Charging station boot notification response received: %j with undefined registration status`, - payload, - ); + payload + ) } } }