X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPRequestService.ts;h=bdfffc3725973ab6b5521889cce9f9b245e8bc24;hb=ea32ea059bfdd7134abe2ba349985e5b15bc1d06;hp=021e09f369edb855d5be7d161e512f073d3504a3;hpb=9b75e3ab59b911697ad2f809e2aee6967a46e0c4;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/OCPPRequestService.ts b/src/charging-station/ocpp/OCPPRequestService.ts index 021e09f3..d7757eaa 100644 --- a/src/charging-station/ocpp/OCPPRequestService.ts +++ b/src/charging-station/ocpp/OCPPRequestService.ts @@ -1,343 +1,488 @@ +import _Ajv, { type ValidateFunction } from 'ajv' +import _ajvFormats from 'ajv-formats' + +import type { ChargingStation } from '../../charging-station/index.js' +import { OCPPError } from '../../exception/index.js' +import { PerformanceStatistics } from '../../performance/index.js' import { - IncomingRequestCommand, + ChargingStationEvents, + type ErrorCallback, + type ErrorResponse, + ErrorType, + type IncomingRequestCommand, + type JsonType, + MessageType, + type OCPPVersion, + type OutgoingRequest, RequestCommand, - ResponseType, - SendParams, -} from '../../types/ocpp/Requests'; + type RequestParams, + type Response, + type ResponseCallback, + type ResponseType +} from '../../types/index.js' +import { + clone, + formatDurationMilliSeconds, + handleSendMessageError, + logger +} from '../../utils/index.js' +import { OCPPConstants } from './OCPPConstants.js' +import type { OCPPResponseService } from './OCPPResponseService.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 -import type ChargingStation from '../ChargingStation'; -import Constants from '../../utils/Constants'; -import { EmptyObject } from '../../types/EmptyObject'; -import { ErrorType } from '../../types/ocpp/ErrorType'; -import { HandleErrorParams } from '../../types/Error'; -import { JsonType } from '../../types/JsonType'; -import { MessageType } from '../../types/ocpp/MessageType'; -import OCPPError from '../../exception/OCPPError'; -import type OCPPResponseService from './OCPPResponseService'; -import PerformanceStatistics from '../../performance/PerformanceStatistics'; -import Utils from '../../utils/Utils'; -import logger from '../../utils/Logger'; +const moduleName = 'OCPPRequestService' -export default abstract class OCPPRequestService { - private static readonly instances: Map = new Map< - string, - OCPPRequestService - >(); +const defaultRequestParams: RequestParams = { + skipBufferingOnError: false, + triggerMessage: false, + throwError: false +} - protected readonly chargingStation: ChargingStation; - private readonly ocppResponseService: OCPPResponseService; +export abstract class OCPPRequestService { + private static instance: OCPPRequestService | null = null + private readonly version: OCPPVersion + private readonly ocppResponseService: OCPPResponseService + protected readonly ajv: Ajv + protected abstract payloadValidateFunctions: Map> - protected constructor( - chargingStation: ChargingStation, - ocppResponseService: OCPPResponseService - ) { - this.chargingStation = chargingStation; - this.ocppResponseService = ocppResponseService; - this.sendMessageHandler.bind(this); - this.sendResult.bind(this); - this.sendError.bind(this); + protected constructor (version: OCPPVersion, ocppResponseService: OCPPResponseService) { + this.version = version + this.ajv = new Ajv({ + keywords: ['javaType'], + multipleOfPrecision: 2 + }) + ajvFormats(this.ajv) + this.ocppResponseService = ocppResponseService + this.requestHandler = this.requestHandler.bind(this) + this.sendMessage = this.sendMessage.bind(this) + this.sendResponse = this.sendResponse.bind(this) + this.sendError = this.sendError.bind(this) + this.internalSendMessage = this.internalSendMessage.bind(this) + this.buildMessageToSend = this.buildMessageToSend.bind(this) + this.validateRequestPayload = this.validateRequestPayload.bind(this) + this.validateIncomingRequestResponsePayload = + this.validateIncomingRequestResponsePayload.bind(this) } public static getInstance( - this: new (chargingStation: ChargingStation, ocppResponseService: OCPPResponseService) => T, - chargingStation: ChargingStation, + this: new (ocppResponseService: OCPPResponseService) => T, ocppResponseService: OCPPResponseService ): T { - if (!OCPPRequestService.instances.has(chargingStation.hashId)) { - OCPPRequestService.instances.set( - chargingStation.hashId, - new this(chargingStation, ocppResponseService) - ); + if (OCPPRequestService.instance === null) { + OCPPRequestService.instance = new this(ocppResponseService) } - return OCPPRequestService.instances.get(chargingStation.hashId) as T; + return OCPPRequestService.instance as T } - public async sendResult( + public async sendResponse ( + chargingStation: ChargingStation, messageId: string, messagePayload: JsonType, commandName: IncomingRequestCommand ): Promise { try { - // Send result message + // Send response message return await this.internalSendMessage( + chargingStation, messageId, messagePayload, MessageType.CALL_RESULT_MESSAGE, commandName - ); + ) } catch (error) { - this.handleRequestError(commandName, error as Error); + handleSendMessageError(chargingStation, commandName, error as Error, { + throwError: true + }) + return null } } - public async sendError( + public async sendError ( + chargingStation: ChargingStation, messageId: string, ocppError: OCPPError, - commandName: IncomingRequestCommand + commandName: RequestCommand | IncomingRequestCommand ): Promise { try { // Send error message return await this.internalSendMessage( + chargingStation, messageId, ocppError, MessageType.CALL_ERROR_MESSAGE, commandName - ); + ) } catch (error) { - this.handleRequestError(commandName, error as Error); + handleSendMessageError(chargingStation, commandName, error as Error) + return null } } - protected async sendMessage( + protected async sendMessage ( + chargingStation: ChargingStation, messageId: string, messagePayload: JsonType, commandName: RequestCommand, - params: SendParams = { - skipBufferingOnError: false, - triggerMessage: false, - } + params?: RequestParams ): Promise { + params = { + ...defaultRequestParams, + ...params + } try { return await this.internalSendMessage( + chargingStation, messageId, messagePayload, MessageType.CALL_MESSAGE, commandName, params - ); + ) } catch (error) { - this.handleRequestError(commandName, error as Error, { throwError: false }); + handleSendMessageError(chargingStation, commandName, error as Error, { + throwError: params.throwError + }) + return null + } + } + + private validateRequestPayload( + chargingStation: ChargingStation, + commandName: RequestCommand | IncomingRequestCommand, + payload: T + ): boolean { + if (chargingStation.stationInfo?.ocppStrictCompliance === false) { + return true + } + if (!this.payloadValidateFunctions.has(commandName as RequestCommand)) { + logger.warn( + `${chargingStation.logPrefix()} ${moduleName}.validateRequestPayload: No JSON schema found for command '${commandName}' PDU validation` + ) + return true + } + const validate = this.payloadValidateFunctions.get(commandName as RequestCommand) + payload = clone(payload) + OCPPServiceUtils.convertDateToISOString(payload) + if (validate?.(payload) === true) { + return true + } + logger.error( + `${chargingStation.logPrefix()} ${moduleName}.validateRequestPayload: Command '${commandName}' request PDU is invalid: %j`, + validate?.errors + ) + // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError(). + throw new OCPPError( + OCPPServiceUtils.ajvErrorsToErrorType(validate?.errors), + 'Request PDU is invalid', + commandName, + JSON.stringify(validate?.errors, undefined, 2) + ) + } + + private validateIncomingRequestResponsePayload( + chargingStation: ChargingStation, + commandName: RequestCommand | IncomingRequestCommand, + payload: T + ): boolean { + if (chargingStation.stationInfo?.ocppStrictCompliance === false) { + return true } + if ( + !this.ocppResponseService.incomingRequestResponsePayloadValidateFunctions.has( + commandName as IncomingRequestCommand + ) + ) { + logger.warn( + `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: No JSON schema validation function found for command '${commandName}' PDU validation` + ) + return true + } + const validate = this.ocppResponseService.incomingRequestResponsePayloadValidateFunctions.get( + commandName as IncomingRequestCommand + ) + payload = clone(payload) + OCPPServiceUtils.convertDateToISOString(payload) + if (validate?.(payload) === true) { + return true + } + logger.error( + `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: Command '${commandName}' response PDU is invalid: %j`, + validate?.errors + ) + // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError(). + throw new OCPPError( + OCPPServiceUtils.ajvErrorsToErrorType(validate?.errors), + 'Response PDU is invalid', + commandName, + JSON.stringify(validate?.errors, undefined, 2) + ) } - private async internalSendMessage( + private async internalSendMessage ( + chargingStation: ChargingStation, messageId: string, messagePayload: JsonType | OCPPError, messageType: MessageType, - commandName?: RequestCommand | IncomingRequestCommand, - params: SendParams = { - skipBufferingOnError: false, - triggerMessage: false, - } + commandName: RequestCommand | IncomingRequestCommand, + params?: RequestParams ): Promise { + params = { + ...defaultRequestParams, + ...params + } if ( - (this.chargingStation.isInUnknownState() && - commandName === RequestCommand.BOOT_NOTIFICATION) || - (!this.chargingStation.getOcppStrictCompliance() && - this.chargingStation.isInUnknownState()) || - this.chargingStation.isInAcceptedState() || - (this.chargingStation.isInPendingState() && - (params.triggerMessage || messageType === MessageType.CALL_RESULT_MESSAGE)) + (chargingStation.inUnknownState() && commandName === RequestCommand.BOOT_NOTIFICATION) || + (chargingStation.stationInfo?.ocppStrictCompliance === false && + chargingStation.inUnknownState()) || + chargingStation.inAcceptedState() || + (chargingStation.inPendingState() && + (params.triggerMessage === true || messageType === MessageType.CALL_RESULT_MESSAGE)) ) { // eslint-disable-next-line @typescript-eslint/no-this-alias - const self = this; + const self = this // Send a message through wsConnection - return Utils.promiseWithTimeout( - new Promise((resolve, reject) => { - const messageToSend = this.buildMessageToSend( - messageId, - messagePayload, - messageType, - commandName, - responseCallback, - rejectCallback - ); - if (this.chargingStation.getEnableStatistics()) { - this.chargingStation.performanceStatistics.addRequestStatistic( + return await new Promise((resolve, reject: (reason?: unknown) => void) => { + /** + * Function that will receive the request's response + * + * @param payload - + * @param requestPayload - + */ + const responseCallback = (payload: JsonType, requestPayload: JsonType): void => { + if (chargingStation.stationInfo?.enableStatistics === true) { + chargingStation.performanceStatistics?.addRequestStatistic( commandName, - messageType - ); + MessageType.CALL_RESULT_MESSAGE + ) } - // Check if wsConnection opened - if (this.chargingStation.isWebSocketConnectionOpened()) { - // Yes: Send Message - const beginId = PerformanceStatistics.beginMeasure(commandName); - // FIXME: Handle sending error - this.chargingStation.wsConnection.send(messageToSend); - PerformanceStatistics.endMeasure(commandName, beginId); - logger.debug( - `${this.chargingStation.logPrefix()} >> Command '${commandName}' sent ${this.getMessageTypeString( - messageType - )} payload: ${messageToSend}` - ); - } else if (!params.skipBufferingOnError) { - // Buffer it - this.chargingStation.bufferMessage(messageToSend); - const ocppError = new OCPPError( - ErrorType.GENERIC_ERROR, - `WebSocket closed for buffered message id '${messageId}' with content '${messageToSend}'`, + // Handle the request's response + self.ocppResponseService + .responseHandler( + chargingStation, + commandName as RequestCommand, + payload, + requestPayload + ) + .then(() => { + resolve(payload) + }) + .catch(reject) + .finally(() => { + chargingStation.requests.delete(messageId) + chargingStation.emit(ChargingStationEvents.updated) + }) + } + + /** + * Function that will receive the request's error response + * + * @param ocppError - + * @param requestStatistic - + */ + const errorCallback = (ocppError: OCPPError, requestStatistic = true): void => { + if (requestStatistic && chargingStation.stationInfo?.enableStatistics === true) { + chargingStation.performanceStatistics?.addRequestStatistic( commandName, - (messagePayload?.details as JsonType) ?? {} - ); - if (messageType === MessageType.CALL_MESSAGE) { - // Reject it but keep the request in the cache - return reject(ocppError); - } - return rejectCallback(ocppError, false); - } else { - // Reject it - return rejectCallback( - new OCPPError( - ErrorType.GENERIC_ERROR, - `WebSocket closed for non buffered message id '${messageId}' with content '${messageToSend}'`, - commandName, - (messagePayload?.details as JsonType) ?? {} - ), - false - ); - } - // Response? - if (messageType !== MessageType.CALL_MESSAGE) { - // Yes: send Ok - return resolve(messagePayload); + MessageType.CALL_ERROR_MESSAGE + ) } + logger.error( + `${chargingStation.logPrefix()} Error occurred at ${OCPPServiceUtils.getMessageTypeString( + messageType + )} command ${commandName} with PDU %j:`, + messagePayload, + ocppError + ) + chargingStation.requests.delete(messageId) + chargingStation.emit(ChargingStationEvents.updated) + reject(ocppError) + } - /** - * Function that will receive the request's response - * - * @param payload - * @param requestPayload - */ - async function responseCallback( - payload: JsonType | string, - requestPayload: JsonType - ): Promise { - if (self.chargingStation.getEnableStatistics()) { - self.chargingStation.performanceStatistics.addRequestStatistic( + const handleSendError = (ocppError: OCPPError): void => { + if (params.skipBufferingOnError === false) { + // Buffer + chargingStation.bufferMessage(messageToSend) + if (messageType === MessageType.CALL_MESSAGE) { + this.setCachedRequest( + chargingStation, + messageId, + messagePayload as JsonType, commandName, - MessageType.CALL_RESULT_MESSAGE - ); - } - // Handle the request's response - try { - await self.ocppResponseService.handleResponse( - commandName as RequestCommand, - payload, - requestPayload - ); - resolve(payload); - } catch (error) { - reject(error); - } finally { - self.chargingStation.requests.delete(messageId); + responseCallback, + errorCallback + ) } + } else if ( + params.skipBufferingOnError === true && + messageType === MessageType.CALL_MESSAGE + ) { + // Remove request from the cache + chargingStation.requests.delete(messageId) } + reject(ocppError) + } - /** - * Function that will receive the request's error response - * - * @param error - * @param requestStatistic - */ - function rejectCallback(error: OCPPError, requestStatistic = true): void { - if (requestStatistic && self.chargingStation.getEnableStatistics()) { - self.chargingStation.performanceStatistics.addRequestStatistic( + if (chargingStation.stationInfo?.enableStatistics === true) { + chargingStation.performanceStatistics?.addRequestStatistic(commandName, messageType) + } + const messageToSend = this.buildMessageToSend( + chargingStation, + messageId, + messagePayload, + messageType, + commandName + ) + // Check if wsConnection opened + if (chargingStation.isWebSocketConnectionOpened()) { + const beginId = PerformanceStatistics.beginMeasure(commandName) + const sendTimeout = setTimeout(() => { + handleSendError( + new OCPPError( + ErrorType.GENERIC_ERROR, + `Timeout ${formatDurationMilliSeconds( + OCPPConstants.OCPP_WEBSOCKET_TIMEOUT + )} reached for ${ + params.skipBufferingOnError === false ? '' : 'non ' + }buffered message id '${messageId}' with content '${messageToSend}'`, commandName, - MessageType.CALL_ERROR_MESSAGE - ); + (messagePayload as OCPPError).details + ) + ) + }, OCPPConstants.OCPP_WEBSOCKET_TIMEOUT) + chargingStation.wsConnection?.send(messageToSend, (error?: Error) => { + PerformanceStatistics.endMeasure(commandName, beginId) + clearTimeout(sendTimeout) + if (error == null) { + logger.debug( + `${chargingStation.logPrefix()} >> Command '${commandName}' sent ${OCPPServiceUtils.getMessageTypeString( + messageType + )} payload: ${messageToSend}` + ) + if (messageType === MessageType.CALL_MESSAGE) { + this.setCachedRequest( + chargingStation, + messageId, + messagePayload as JsonType, + commandName, + responseCallback, + errorCallback + ) + } else { + // Resolve response + resolve(messagePayload) + } + } else { + handleSendError( + new OCPPError( + ErrorType.GENERIC_ERROR, + `WebSocket errored for ${ + params.skipBufferingOnError === false ? '' : 'non ' + }buffered message id '${messageId}' with content '${messageToSend}'`, + commandName, + { name: error.name, message: error.message, stack: error.stack } + ) + ) } - logger.error( - `${self.chargingStation.logPrefix()} Error %j occurred when calling command %s with message data %j`, - error, + }) + } else { + handleSendError( + new OCPPError( + ErrorType.GENERIC_ERROR, + `WebSocket closed for ${ + params.skipBufferingOnError === false ? '' : 'non ' + }buffered message id '${messageId}' with content '${messageToSend}'`, commandName, - messagePayload - ); - self.chargingStation.requests.delete(messageId); - reject(error); - } - }), - Constants.OCPP_WEBSOCKET_TIMEOUT, - new OCPPError( - ErrorType.GENERIC_ERROR, - `Timeout for message id '${messageId}'`, - commandName, - (messagePayload?.details as JsonType) ?? {} - ), - () => { - messageType === MessageType.CALL_MESSAGE && - this.chargingStation.requests.delete(messageId); + (messagePayload as OCPPError).details + ) + ) } - ); + }) } throw new OCPPError( ErrorType.SECURITY_ERROR, - `Cannot send command ${commandName} payload when the charging station is in ${this.chargingStation.getRegistrationStatus()} state on the central server`, + `Cannot send command ${commandName} PDU when the charging station is in ${chargingStation.bootNotificationResponse?.status} state on the central server`, commandName - ); + ) } - private buildMessageToSend( + private buildMessageToSend ( + chargingStation: ChargingStation, messageId: string, messagePayload: JsonType | OCPPError, messageType: MessageType, - commandName?: RequestCommand | IncomingRequestCommand, - responseCallback?: (payload: JsonType | string, requestPayload: JsonType) => Promise, - rejectCallback?: (error: OCPPError, requestStatistic?: boolean) => void + commandName: RequestCommand | IncomingRequestCommand ): string { - let messageToSend: string; + let messageToSend: string // Type of message switch (messageType) { // Request case MessageType.CALL_MESSAGE: // Build request - this.chargingStation.requests.set(messageId, [ - responseCallback, - rejectCallback, - commandName, - messagePayload, - ]); - messageToSend = JSON.stringify([messageType, messageId, commandName, messagePayload]); - break; + this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonType) + messageToSend = JSON.stringify([ + messageType, + messageId, + commandName as RequestCommand, + messagePayload as JsonType + ] satisfies OutgoingRequest) + break // Response case MessageType.CALL_RESULT_MESSAGE: // Build response - messageToSend = JSON.stringify([messageType, messageId, messagePayload]); - break; + this.validateIncomingRequestResponsePayload( + chargingStation, + commandName, + messagePayload as JsonType + ) + messageToSend = JSON.stringify([ + messageType, + messageId, + messagePayload as JsonType + ] satisfies Response) + break // Error Message case MessageType.CALL_ERROR_MESSAGE: // Build Error Message messageToSend = JSON.stringify([ messageType, messageId, - messagePayload?.code ?? ErrorType.GENERIC_ERROR, - messagePayload?.message ?? '', - messagePayload?.details ?? { commandName }, - ]); - break; - } - return messageToSend; - } - - private getMessageTypeString(messageType: MessageType): string { - switch (messageType) { - case MessageType.CALL_MESSAGE: - return 'request'; - case MessageType.CALL_RESULT_MESSAGE: - return 'response'; - case MessageType.CALL_ERROR_MESSAGE: - return 'error'; + (messagePayload as OCPPError).code, + (messagePayload as OCPPError).message, + (messagePayload as OCPPError).details ?? { + command: (messagePayload as OCPPError).command + } + ] satisfies ErrorResponse) + break } + return messageToSend } - private handleRequestError( + private setCachedRequest ( + chargingStation: ChargingStation, + messageId: string, + messagePayload: JsonType, commandName: RequestCommand | IncomingRequestCommand, - error: Error, - params: HandleErrorParams = { throwError: true } + responseCallback: ResponseCallback, + errorCallback: ErrorCallback ): void { - logger.error( - this.chargingStation.logPrefix() + ' Request command %s error: %j', + chargingStation.requests.set(messageId, [ + responseCallback, + errorCallback, commandName, - error - ); - if (params?.throwError) { - throw error; - } + messagePayload + ]) } // eslint-disable-next-line @typescript-eslint/no-unused-vars - public abstract sendMessageHandler( + public abstract requestHandler( + chargingStation: ChargingStation, commandName: RequestCommand, + // FIXME: should be ReqType commandParams?: JsonType, - params?: SendParams - ): Promise; + params?: RequestParams + ): Promise }