X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPRequestService.ts;h=8b5f0cc3aaf1e19aadafcf965d1dd49af4acb234;hb=f5a1ff8ce8f87a149791c2c98fe7c5e8a20b5392;hp=52a8a6e5246eb5f06df450f4ed320589129bf57b;hpb=ec0eebcce06f18b41e6639b72728110bda55c250;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/OCPPRequestService.ts b/src/charging-station/ocpp/OCPPRequestService.ts index 52a8a6e5..8b5f0cc3 100644 --- a/src/charging-station/ocpp/OCPPRequestService.ts +++ b/src/charging-station/ocpp/OCPPRequestService.ts @@ -1,18 +1,18 @@ -import Ajv, { type JSONSchemaType, type ValidateFunction } from 'ajv'; -import ajvFormats from 'ajv-formats'; +import _Ajv, { type JSONSchemaType, type ValidateFunction } from 'ajv'; +import _ajvFormats from 'ajv-formats'; -import { OCPPConstants } from './OCPPConstants'; -import type { OCPPResponseService } from './OCPPResponseService'; -import { OCPPServiceUtils } from './OCPPServiceUtils'; -import type { ChargingStation } from '../../charging-station'; -import { OCPPError } from '../../exception'; -import { PerformanceStatistics } from '../../performance'; +import { OCPPConstants } from './OCPPConstants.js'; +import type { OCPPResponseService } from './OCPPResponseService.js'; +import { OCPPServiceUtils } from './OCPPServiceUtils.js'; +import type { ChargingStation } from '../../charging-station/index.js'; +import { OCPPError } from '../../exception/index.js'; +import { PerformanceStatistics } from '../../performance/index.js'; import { + ChargingStationEvents, type ErrorCallback, type ErrorResponse, ErrorType, type IncomingRequestCommand, - type JsonObject, type JsonType, MessageType, type OCPPVersion, @@ -22,14 +22,17 @@ import { type Response, type ResponseCallback, type ResponseType, -} from '../../types'; +} from '../../types/index.js'; import { - Constants, cloneObject, + formatDurationMilliSeconds, handleSendMessageError, + isNullOrUndefined, logger, - promiseWithTimeout, -} from '../../utils'; +} from '../../utils/index.js'; +type Ajv = _Ajv.default; +const Ajv = _Ajv.default; +const ajvFormats = _ajvFormats.default; const moduleName = 'OCPPRequestService'; @@ -44,8 +47,8 @@ export abstract class OCPPRequestService { private readonly version: OCPPVersion; private readonly ajv: Ajv; private readonly ocppResponseService: OCPPResponseService; - private readonly jsonValidateFunctions: Map>; - protected abstract jsonSchemas: Map>; + private readonly jsonValidateFunctions: Map>; + protected abstract jsonSchemas: Map>; protected constructor(version: OCPPVersion, ocppResponseService: OCPPResponseService) { this.version = version; @@ -54,7 +57,7 @@ export abstract class OCPPRequestService { multipleOfPrecision: 2, }); ajvFormats(this.ajv); - this.jsonValidateFunctions = new Map>(); + this.jsonValidateFunctions = new Map>(); this.ocppResponseService = ocppResponseService; this.requestHandler = this.requestHandler.bind(this) as < // eslint-disable-next-line @typescript-eslint/no-unused-vars @@ -99,17 +102,15 @@ export abstract class OCPPRequestService { messagePayload: JsonType | OCPPError, messageType: MessageType, commandName: RequestCommand | IncomingRequestCommand, - responseCallback: ResponseCallback, - errorCallback: ErrorCallback, ) => string; - this.validateRequestPayload = this.validateRequestPayload.bind(this) as ( + this.validateRequestPayload = this.validateRequestPayload.bind(this) as ( chargingStation: ChargingStation, commandName: RequestCommand | IncomingRequestCommand, payload: T, ) => boolean; this.validateIncomingRequestResponsePayload = this.validateIncomingRequestResponsePayload.bind( this, - ) as ( + ) as ( chargingStation: ChargingStation, commandName: RequestCommand | IncomingRequestCommand, payload: T, @@ -198,12 +199,12 @@ export abstract class OCPPRequestService { } } - private validateRequestPayload( + private validateRequestPayload( chargingStation: ChargingStation, commandName: RequestCommand | IncomingRequestCommand, payload: T, ): boolean { - if (chargingStation.getOcppStrictCompliance() === false) { + if (chargingStation.stationInfo?.ocppStrictCompliance === false) { return true; } if (this.jsonSchemas.has(commandName as RequestCommand) === false) { @@ -212,13 +213,7 @@ export abstract class OCPPRequestService { ); return true; } - if (this.jsonValidateFunctions.has(commandName as RequestCommand) === false) { - this.jsonValidateFunctions.set( - commandName as RequestCommand, - this.ajv.compile(this.jsonSchemas.get(commandName as RequestCommand)!).bind(this), - ); - } - const validate = this.jsonValidateFunctions.get(commandName as RequestCommand)!; + const validate = this.getJsonRequestValidateFunction(commandName as RequestCommand); payload = cloneObject(payload); OCPPServiceUtils.convertDateToISOString(payload); if (validate(payload)) { @@ -230,19 +225,29 @@ export abstract class OCPPRequestService { ); // 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!), + OCPPServiceUtils.ajvErrorsToErrorType(validate.errors), 'Request PDU is invalid', commandName, JSON.stringify(validate.errors, undefined, 2), ); } - private validateIncomingRequestResponsePayload( + private getJsonRequestValidateFunction(commandName: RequestCommand) { + if (this.jsonValidateFunctions.has(commandName) === false) { + this.jsonValidateFunctions.set( + commandName, + this.ajv.compile(this.jsonSchemas.get(commandName)!).bind(this), + ); + } + return this.jsonValidateFunctions.get(commandName)!; + } + + private validateIncomingRequestResponsePayload( chargingStation: ChargingStation, commandName: RequestCommand | IncomingRequestCommand, payload: T, ): boolean { - if (chargingStation.getOcppStrictCompliance() === false) { + if (chargingStation.stationInfo?.ocppStrictCompliance === false) { return true; } if ( @@ -255,25 +260,9 @@ export abstract class OCPPRequestService { ); return true; } - if ( - this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.has( - commandName as IncomingRequestCommand, - ) === false - ) { - this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.set( - commandName as IncomingRequestCommand, - this.ajv - .compile( - this.ocppResponseService.jsonIncomingRequestResponseSchemas.get( - commandName as IncomingRequestCommand, - )!, - ) - .bind(this), - ); - } - const validate = this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.get( + const validate = this.getJsonRequestResponseValidateFunction( commandName as IncomingRequestCommand, - )!; + ); payload = cloneObject(payload); OCPPServiceUtils.convertDateToISOString(payload); if (validate(payload)) { @@ -285,13 +274,30 @@ export abstract class OCPPRequestService { ); // 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!), + OCPPServiceUtils.ajvErrorsToErrorType(validate.errors), 'Response PDU is invalid', commandName, JSON.stringify(validate.errors, undefined, 2), ); } + private getJsonRequestResponseValidateFunction( + commandName: IncomingRequestCommand, + ) { + if ( + this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.has(commandName) === + false + ) { + this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.set( + commandName, + this.ajv + .compile(this.ocppResponseService.jsonIncomingRequestResponseSchemas.get(commandName)!) + .bind(this), + ); + } + return this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.get(commandName)!; + } + private async internalSendMessage( chargingStation: ChargingStation, messageId: string, @@ -307,7 +313,7 @@ export abstract class OCPPRequestService { if ( (chargingStation.inUnknownState() === true && commandName === RequestCommand.BOOT_NOTIFICATION) || - (chargingStation.getOcppStrictCompliance() === false && + (chargingStation.stationInfo?.ocppStrictCompliance === false && chargingStation.inUnknownState() === true) || chargingStation.inAcceptedState() === true || (chargingStation.inPendingState() === true && @@ -316,146 +322,166 @@ export abstract class OCPPRequestService { // eslint-disable-next-line @typescript-eslint/no-this-alias const self = this; // Send a message through wsConnection - return promiseWithTimeout( - new Promise((resolve, reject) => { - /** - * Function that will receive the request's response - * - * @param payload - - * @param requestPayload - - */ - const responseCallback = (payload: JsonType, requestPayload: JsonType): void => { - if (chargingStation.getEnableStatistics() === true) { - chargingStation.performanceStatistics?.addRequestStatistic( - commandName, - MessageType.CALL_RESULT_MESSAGE, - ); - } - // Handle the request's response - self.ocppResponseService - .responseHandler( - chargingStation, - commandName as RequestCommand, - payload, - requestPayload, - ) - .then(() => { - resolve(payload); - }) - .catch((error) => { - reject(error); - }) - .finally(() => { - chargingStation.requests.delete(messageId); - }); - }; - - /** - * Function that will receive the request's error response - * - * @param error - - * @param requestStatistic - - */ - const errorCallback = (error: OCPPError, requestStatistic = true): void => { - if (requestStatistic === true && chargingStation.getEnableStatistics() === true) { - chargingStation.performanceStatistics?.addRequestStatistic( - commandName, - MessageType.CALL_ERROR_MESSAGE, - ); - } - logger.error( - `${chargingStation.logPrefix()} Error occurred at ${OCPPServiceUtils.getMessageTypeString( - messageType, - )} command ${commandName} with PDU %j:`, - messagePayload, - error, + return new Promise((resolve, reject) => { + /** + * 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.CALL_RESULT_MESSAGE, ); - chargingStation.requests.delete(messageId); - reject(error); - }; + } + // 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); + }); + }; - if (chargingStation.getEnableStatistics() === true) { - chargingStation.performanceStatistics?.addRequestStatistic(commandName, messageType); + /** + * Function that will receive the request's error response + * + * @param ocppError - + * @param requestStatistic - + */ + const errorCallback = (ocppError: OCPPError, requestStatistic = true): void => { + if (requestStatistic === true && chargingStation.stationInfo?.enableStatistics === true) { + chargingStation.performanceStatistics?.addRequestStatistic( + commandName, + MessageType.CALL_ERROR_MESSAGE, + ); } - const messageToSend = this.buildMessageToSend( - chargingStation, - messageId, + logger.error( + `${chargingStation.logPrefix()} Error occurred at ${OCPPServiceUtils.getMessageTypeString( + messageType, + )} command ${commandName} with PDU %j:`, messagePayload, - messageType, - commandName, - responseCallback, - errorCallback, + ocppError, ); - let sendError = false; - // Check if wsConnection opened - const wsOpened = chargingStation.isWebSocketConnectionOpened() === true; - if (wsOpened) { - const beginId = PerformanceStatistics.beginMeasure(commandName); - try { - chargingStation.wsConnection?.send(messageToSend); - logger.debug( - `${chargingStation.logPrefix()} >> Command '${commandName}' sent ${OCPPServiceUtils.getMessageTypeString( - messageType, - )} payload: ${messageToSend}`, - ); - } catch (error) { - logger.error( - `${chargingStation.logPrefix()} >> Command '${commandName}' failed to send ${OCPPServiceUtils.getMessageTypeString( - messageType, - )} payload: ${messageToSend}:`, - error, + chargingStation.requests.delete(messageId); + chargingStation.emit(ChargingStationEvents.updated); + reject(ocppError); + }; + + const handleSendError = (ocppError: OCPPError): void => { + if (params?.skipBufferingOnError === false) { + // Buffer + chargingStation.bufferMessage(messageToSend); + if (messageType === MessageType.CALL_MESSAGE) { + this.cacheRequestPromise( + chargingStation, + messageId, + messagePayload as JsonType, + commandName, + responseCallback, + errorCallback, ); - sendError = true; } - PerformanceStatistics.endMeasure(commandName, beginId); + } else if ( + params?.skipBufferingOnError === true && + messageType === MessageType.CALL_MESSAGE + ) { + // Remove request from the cache + chargingStation.requests.delete(messageId); } - const wsClosedOrErrored = !wsOpened || sendError === true; - if (wsClosedOrErrored && params?.skipBufferingOnError === false) { - // Buffer - chargingStation.bufferMessage(messageToSend); - // Reject and keep request in the cache - return reject( + return reject(ocppError); + }; + + 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() === true) { + const beginId = PerformanceStatistics.beginMeasure(commandName); + const sendTimeout = setTimeout(() => { + return handleSendError( new OCPPError( ErrorType.GENERIC_ERROR, - `WebSocket closed or errored for buffered message id '${messageId}' with content '${messageToSend}'`, + `Timeout ${formatDurationMilliSeconds( + OCPPConstants.OCPP_WEBSOCKET_TIMEOUT, + )} reached for ${ + params?.skipBufferingOnError === false ? '' : 'non ' + }buffered message id '${messageId}' with content '${messageToSend}'`, commandName, - (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FROZEN_OBJECT, + (messagePayload as OCPPError).details, ), ); - } else if (wsClosedOrErrored) { - const ocppError = new OCPPError( + }, OCPPConstants.OCPP_WEBSOCKET_TIMEOUT); + chargingStation.wsConnection?.send(messageToSend, (error?: Error) => { + PerformanceStatistics.endMeasure(commandName, beginId); + clearTimeout(sendTimeout); + if (isNullOrUndefined(error)) { + logger.debug( + `${chargingStation.logPrefix()} >> Command '${commandName}' sent ${OCPPServiceUtils.getMessageTypeString( + messageType, + )} payload: ${messageToSend}`, + ); + if (messageType === MessageType.CALL_MESSAGE) { + this.cacheRequestPromise( + chargingStation, + messageId, + messagePayload as JsonType, + commandName, + responseCallback, + errorCallback, + ); + } else { + // Resolve response + return resolve(messagePayload); + } + } else if (error) { + return 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 }, + ), + ); + } + }); + } else { + return handleSendError( + new OCPPError( ErrorType.GENERIC_ERROR, - `WebSocket closed or errored for non buffered message id '${messageId}' with content '${messageToSend}'`, + `WebSocket closed for ${ + params?.skipBufferingOnError === false ? '' : 'non ' + }buffered message id '${messageId}' with content '${messageToSend}'`, commandName, - (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FROZEN_OBJECT, - ); - // Reject response - if (messageType !== MessageType.CALL_MESSAGE) { - return reject(ocppError); - } - // Reject and remove request from the cache - return errorCallback(ocppError, false); - } - // Resolve response - if (messageType !== MessageType.CALL_MESSAGE) { - return resolve(messagePayload); - } - }), - OCPPConstants.OCPP_WEBSOCKET_TIMEOUT, - new OCPPError( - ErrorType.GENERIC_ERROR, - `Timeout for message id '${messageId}'`, - commandName, - (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FROZEN_OBJECT, - ), - () => { - messageType === MessageType.CALL_MESSAGE && chargingStation.requests.delete(messageId); - }, - ); + (messagePayload as OCPPError).details, + ), + ); + } + }); } throw new OCPPError( ErrorType.SECURITY_ERROR, - `Cannot send command ${commandName} PDU when the charging station is in ${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, ); } @@ -466,8 +492,6 @@ export abstract class OCPPRequestService { messagePayload: JsonType | OCPPError, messageType: MessageType, commandName: RequestCommand | IncomingRequestCommand, - responseCallback: ResponseCallback, - errorCallback: ErrorCallback, ): string { let messageToSend: string; // Type of message @@ -475,13 +499,7 @@ export abstract class OCPPRequestService { // Request case MessageType.CALL_MESSAGE: // Build request - this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonObject); - chargingStation.requests.set(messageId, [ - responseCallback, - errorCallback, - commandName, - messagePayload as JsonType, - ]); + this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonType); messageToSend = JSON.stringify([ messageType, messageId, @@ -495,7 +513,7 @@ export abstract class OCPPRequestService { this.validateIncomingRequestResponsePayload( chargingStation, commandName, - messagePayload as JsonObject, + messagePayload as JsonType, ); messageToSend = JSON.stringify([messageType, messageId, messagePayload] as Response); break; @@ -505,15 +523,33 @@ export abstract class OCPPRequestService { messageToSend = JSON.stringify([ messageType, messageId, - (messagePayload as OCPPError)?.code ?? ErrorType.GENERIC_ERROR, - (messagePayload as OCPPError)?.message ?? '', - (messagePayload as OCPPError)?.details ?? { commandName }, + (messagePayload as OCPPError).code, + (messagePayload as OCPPError).message, + (messagePayload as OCPPError).details ?? { + command: (messagePayload as OCPPError).command ?? commandName, + }, ] as ErrorResponse); break; } return messageToSend; } + private cacheRequestPromise( + chargingStation: ChargingStation, + messageId: string, + messagePayload: JsonType, + commandName: RequestCommand | IncomingRequestCommand, + responseCallback: ResponseCallback, + errorCallback: ErrorCallback, + ): void { + chargingStation.requests.set(messageId, [ + responseCallback, + errorCallback, + commandName, + messagePayload, + ]); + } + // eslint-disable-next-line @typescript-eslint/no-unused-vars public abstract requestHandler( chargingStation: ChargingStation,