X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPRequestService.ts;h=fc5e60ad855bc5f7ff21efaaebf3cc8aa8681b52;hb=32b0224999178acf1101ff9075c95072d207206e;hp=6ebb4e3841bc1b57c914fc890b1cc2f911d0cc07;hpb=52748e2c6d0b08cecaa3e626f615c92ba6bbf758;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/OCPPRequestService.ts b/src/charging-station/ocpp/OCPPRequestService.ts index 6ebb4e38..fc5e60ad 100644 --- a/src/charging-station/ocpp/OCPPRequestService.ts +++ b/src/charging-station/ocpp/OCPPRequestService.ts @@ -1,5 +1,5 @@ import { AuthorizeResponse, StartTransactionResponse, StopTransactionReason, StopTransactionResponse } from '../../types/ocpp/Transaction'; -import { IncomingRequestCommand, Request, RequestCommand } from '../../types/ocpp/Requests'; +import { DiagnosticsStatus, IncomingRequestCommand, RequestCommand } from '../../types/ocpp/Requests'; import { BootNotificationResponse } from '../../types/ocpp/Responses'; import { ChargePointErrorCode } from '../../types/ocpp/ChargePointErrorCode'; @@ -8,8 +8,10 @@ import ChargingStation from '../ChargingStation'; import Constants from '../../utils/Constants'; import { ErrorType } from '../../types/ocpp/ErrorType'; import { MessageType } from '../../types/ocpp/MessageType'; -import OCPPError from '../OcppError'; +import { MeterValue } from '../../types/ocpp/MeterValues'; +import OCPPError from './OCPPError'; import OCPPResponseService from './OCPPResponseService'; +import PerformanceStatistics from '../../performance/PerformanceStatistics'; import logger from '../../utils/Logger'; export default abstract class OCPPRequestService { @@ -21,89 +23,108 @@ export default abstract class OCPPRequestService { this.ocppResponseService = ocppResponseService; } - public async sendMessage(messageId: string, commandParams: any, messageType: MessageType = MessageType.CALL_RESULT_MESSAGE, commandName: RequestCommand | IncomingRequestCommand): Promise { + public async sendMessage(messageId: string, commandParams: any, messageType: MessageType, commandName: RequestCommand | IncomingRequestCommand, + skipBufferingOnError = false): Promise { // eslint-disable-next-line @typescript-eslint/no-this-alias const self = this; // Send a message through wsConnection - return new Promise((resolve: (value?: any | PromiseLike) => void, reject: (reason?: any) => void) => { - let messageToSend: string; - // Type of message - switch (messageType) { - // Request - case MessageType.CALL_MESSAGE: - // Build request - this.chargingStation.requests[messageId] = [responseCallback, rejectCallback, commandParams] as Request; - messageToSend = JSON.stringify([messageType, messageId, commandName, commandParams]); - break; - // Response - case MessageType.CALL_RESULT_MESSAGE: - // Build response - messageToSend = JSON.stringify([messageType, messageId, commandParams]); - break; - // Error Message - case MessageType.CALL_ERROR_MESSAGE: - // Build Error Message - messageToSend = JSON.stringify([messageType, messageId, commandParams.code ? commandParams.code : ErrorType.GENERIC_ERROR, commandParams.message ? commandParams.message : '', commandParams.details ? commandParams.details : {}]); - break; + return new Promise((resolve, reject) => { + const messageToSend = this.buildMessageToSend(messageId, commandParams, messageType, commandName, responseCallback, rejectCallback); + if (this.chargingStation.getEnableStatistics()) { + this.chargingStation.performanceStatistics.addRequestStatistic(commandName, messageType); } - // Check if wsConnection opened and charging station registered - if (this.chargingStation.isWebSocketOpen() && (this.chargingStation.isRegistered() || commandName === RequestCommand.BOOT_NOTIFICATION)) { - if (this.chargingStation.getEnableStatistics()) { - this.chargingStation.statistics.addMessage(commandName, messageType); - } + // Check if wsConnection opened + if (this.chargingStation.isWebSocketConnectionOpened()) { // Yes: Send Message + const beginId = PerformanceStatistics.beginMeasure(commandName); this.chargingStation.wsConnection.send(messageToSend); - } else if (commandName !== RequestCommand.BOOT_NOTIFICATION) { + PerformanceStatistics.endMeasure(commandName, beginId); + } else if (!skipBufferingOnError) { // Buffer it - this.chargingStation.addMessageToBuffer(messageToSend); - // Reject it - return rejectCallback(new OCPPError(commandParams.code ? commandParams.code : ErrorType.GENERIC_ERROR, commandParams.message ? commandParams.message : `WebSocket closed for message id '${messageId}' with content '${messageToSend}', message buffered`, commandParams.details ? commandParams.details : {})); + this.chargingStation.addToMessageQueue(messageToSend); + // Reject it but keep the request in the cache + reject(new OCPPError(commandParams?.code ?? ErrorType.GENERIC_ERROR, commandParams?.message ?? `WebSocket closed for message id '${messageId}' with content '${messageToSend}', message buffered`, commandParams?.details ?? {})); } // Response? if (messageType === MessageType.CALL_RESULT_MESSAGE) { // Yes: send Ok - resolve(); - } else if (messageType === MessageType.CALL_ERROR_MESSAGE) { + resolve(commandName); + } else { // Send timeout - setTimeout(() => rejectCallback(new OCPPError(commandParams.code ? commandParams.code : ErrorType.GENERIC_ERROR, commandParams.message ? commandParams.message : `Timeout for message id '${messageId}' with content '${messageToSend}'`, commandParams.details ? commandParams.details : {})), Constants.OCPP_ERROR_TIMEOUT); + setTimeout(() => rejectCallback(new OCPPError(commandParams?.code ?? ErrorType.GENERIC_ERROR, commandParams?.message ?? `Timeout for message id '${messageId}' with content '${messageToSend}'`, commandParams?.details ?? {})), Constants.OCPP_SOCKET_TIMEOUT); } - // Function that will receive the request's response + /** + * Function that will receive the request's response + * + * @param payload + * @param requestPayload + */ async function responseCallback(payload: Record | string, requestPayload: Record): Promise { if (self.chargingStation.getEnableStatistics()) { - self.chargingStation.statistics.addMessage(commandName, messageType); + self.chargingStation.performanceStatistics.addRequestStatistic(commandName, MessageType.CALL_RESULT_MESSAGE); } // Send the response await self.ocppResponseService.handleResponse(commandName as RequestCommand, payload, requestPayload); + self.chargingStation.requests.delete(messageId); resolve(payload); } - // Function that will receive the request's rejection + /** + * Function that will receive the request's error response + * + * @param error + */ function rejectCallback(error: OCPPError): void { if (self.chargingStation.getEnableStatistics()) { - self.chargingStation.statistics.addMessage(commandName, messageType); + self.chargingStation.performanceStatistics.addRequestStatistic(commandName, MessageType.CALL_ERROR_MESSAGE); } - logger.debug(`${self.chargingStation.logPrefix()} Error: %j occurred when calling command %s with parameters: %j`, error, commandName, commandParams); - // Build Exception - // eslint-disable-next-line no-empty-function - self.chargingStation.requests[messageId] = [() => { }, () => { }, {}]; - // Send error + logger.debug(`${self.chargingStation.logPrefix()} Error %j occurred when calling command %s with parameters %j`, error, commandName, commandParams); + self.chargingStation.requests.delete(messageId); reject(error); } }); } - public handleRequestError(commandName: RequestCommand, error: Error): void { - logger.error(this.chargingStation.logPrefix() + ' Send ' + commandName + ' error: %j', error); + protected handleRequestError(commandName: RequestCommand, error: Error): void { + logger.error(this.chargingStation.logPrefix() + ' Request command ' + commandName + ' error: %j', error); throw error; } + private buildMessageToSend(messageId: string, commandParams: any, messageType: MessageType, commandName: RequestCommand | IncomingRequestCommand, + responseCallback: (payload: Record | string, requestPayload: Record) => Promise, rejectCallback: (error: OCPPError) => void): string { + let messageToSend: string; + // Type of message + switch (messageType) { + // Request + case MessageType.CALL_MESSAGE: + // Build request + this.chargingStation.requests.set(messageId, [responseCallback, rejectCallback, commandName, commandParams as Record]); + messageToSend = JSON.stringify([messageType, messageId, commandName, commandParams]); + break; + // Response + case MessageType.CALL_RESULT_MESSAGE: + // Build response + messageToSend = JSON.stringify([messageType, messageId, commandParams]); + break; + // Error Message + case MessageType.CALL_ERROR_MESSAGE: + // Build Error Message + messageToSend = JSON.stringify([messageType, messageId, commandParams?.code ?? ErrorType.GENERIC_ERROR, commandParams?.message ?? '', commandParams?.details ?? {}]); + break; + } + return messageToSend; + } + public abstract sendHeartbeat(): Promise; public abstract sendBootNotification(chargePointModel: string, chargePointVendor: string, chargeBoxSerialNumber?: string, firmwareVersion?: string, chargePointSerialNumber?: string, iccid?: string, imsi?: string, meterSerialNumber?: string, meterType?: string): Promise; public abstract sendStatusNotification(connectorId: number, status: ChargePointStatus, errorCode?: ChargePointErrorCode): Promise; - public abstract sendAuthorize(idTag?: string): Promise; + public abstract sendAuthorize(connectorId: number, idTag?: string): Promise; public abstract sendStartTransaction(connectorId: number, idTag?: string): Promise; public abstract sendStopTransaction(transactionId: number, meterStop: number, idTag?: string, reason?: StopTransactionReason): Promise; - public abstract sendMeterValues(connectorId: number, transactionId: number, interval: number, self: OCPPRequestService): Promise; + public abstract sendMeterValues(connectorId: number, transactionId: number, interval: number): Promise; + public abstract sendTransactionBeginMeterValues(connectorId: number, transactionId: number, beginMeterValue: MeterValue): Promise; + public abstract sendTransactionEndMeterValues(connectorId: number, transactionId: number, endMeterValue: MeterValue): Promise; + public abstract sendDiagnosticsStatusNotification(diagnosticsStatus: DiagnosticsStatus): Promise; public abstract sendError(messageId: string, error: OCPPError, commandName: RequestCommand | IncomingRequestCommand): Promise; }