X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPRequestService.ts;h=8eaeb833009be16deaeaece0da07609f84c65448;hb=9f2e313013116428f5bce2be59e2f5c07502c026;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..8eaeb833 100644 --- a/src/charging-station/ocpp/OCPPRequestService.ts +++ b/src/charging-station/ocpp/OCPPRequestService.ts @@ -1,109 +1,164 @@ import { AuthorizeResponse, StartTransactionResponse, StopTransactionReason, StopTransactionResponse } from '../../types/ocpp/Transaction'; -import { IncomingRequestCommand, Request, RequestCommand } from '../../types/ocpp/Requests'; +import { DiagnosticsStatus, IncomingRequestCommand, RequestCommand, SendParams } from '../../types/ocpp/Requests'; import { BootNotificationResponse } from '../../types/ocpp/Responses'; import { ChargePointErrorCode } from '../../types/ocpp/ChargePointErrorCode'; import { ChargePointStatus } from '../../types/ocpp/ChargePointStatus'; -import ChargingStation from '../ChargingStation'; +import type ChargingStation from '../ChargingStation'; import Constants from '../../utils/Constants'; import { ErrorType } from '../../types/ocpp/ErrorType'; +import { JsonType } from '../../types/JsonType'; import { MessageType } from '../../types/ocpp/MessageType'; -import OCPPError from '../OcppError'; -import OCPPResponseService from './OCPPResponseService'; +import { MeterValue } from '../../types/ocpp/MeterValues'; +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'; export default abstract class OCPPRequestService { - public chargingStation: ChargingStation; - protected ocppResponseService: OCPPResponseService; + private static readonly instances: Map = new Map(); + protected readonly chargingStation: ChargingStation; + private readonly ocppResponseService: OCPPResponseService; - constructor(chargingStation: ChargingStation, ocppResponseService: OCPPResponseService) { + protected constructor(chargingStation: ChargingStation, ocppResponseService: OCPPResponseService) { this.chargingStation = chargingStation; this.ocppResponseService = ocppResponseService; } - public async sendMessage(messageId: string, commandParams: any, messageType: MessageType = MessageType.CALL_RESULT_MESSAGE, commandName: RequestCommand | IncomingRequestCommand): 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; - } - // Check if wsConnection opened and charging station registered - if (this.chargingStation.isWebSocketOpen() && (this.chargingStation.isRegistered() || commandName === RequestCommand.BOOT_NOTIFICATION)) { + public static getInstance(this: new (chargingStation: ChargingStation, ocppResponseService: OCPPResponseService) => T, chargingStation: ChargingStation, ocppResponseService: OCPPResponseService): T { + if (!OCPPRequestService.instances.has(chargingStation.id)) { + OCPPRequestService.instances.set(chargingStation.id, new this(chargingStation, ocppResponseService)); + } + return OCPPRequestService.instances.get(chargingStation.id) as T; + } + + protected async sendMessage(messageId: string, messageData: JsonType | OCPPError, messageType: MessageType, commandName: RequestCommand | IncomingRequestCommand, + params: SendParams = { + skipBufferingOnError: false, + triggerMessage: false + }): Promise { + if ((this.chargingStation.isInUnknownState() && commandName === RequestCommand.BOOT_NOTIFICATION) + || (!this.chargingStation.getOcppStrictCompliance() && this.chargingStation.isInUnknownState()) + || this.chargingStation.isInAcceptedState() || (this.chargingStation.isInPendingState() && params.triggerMessage)) { + // eslint-disable-next-line @typescript-eslint/no-this-alias + const self = this; + // Send a message through wsConnection + return Utils.promiseWithTimeout(new Promise((resolve, reject) => { + const messageToSend = this.buildMessageToSend(messageId, messageData, messageType, commandName, responseCallback, rejectCallback); if (this.chargingStation.getEnableStatistics()) { - this.chargingStation.statistics.addMessage(commandName, messageType); + this.chargingStation.performanceStatistics.addRequestStatistic(commandName, messageType); + } + // 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); + } 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}'`, commandName, messageData?.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, messageData?.details as JsonType ?? {}), false); + } + // Response? + if (messageType !== MessageType.CALL_MESSAGE) { + // Yes: send Ok + return resolve(messageData); } - // Yes: Send Message - this.chargingStation.wsConnection.send(messageToSend); - } else if (commandName !== RequestCommand.BOOT_NOTIFICATION) { - // 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 : {})); - } - // Response? - if (messageType === MessageType.CALL_RESULT_MESSAGE) { - // Yes: send Ok - resolve(); - } else if (messageType === MessageType.CALL_ERROR_MESSAGE) { - // 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); - } - // Function that will receive the request's response - async function responseCallback(payload: Record | string, requestPayload: Record): Promise { - if (self.chargingStation.getEnableStatistics()) { - self.chargingStation.statistics.addMessage(commandName, messageType); + /** + * 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(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); + throw error; + } finally { + self.chargingStation.requests.delete(messageId); + } } - // Send the response - await self.ocppResponseService.handleResponse(commandName as RequestCommand, payload, requestPayload); - resolve(payload); - } - // Function that will receive the request's rejection - function rejectCallback(error: OCPPError): void { - if (self.chargingStation.getEnableStatistics()) { - self.chargingStation.statistics.addMessage(commandName, messageType); + /** + * 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(commandName, MessageType.CALL_ERROR_MESSAGE); + } + logger.error(`${self.chargingStation.logPrefix()} Error %j occurred when calling command %s with message data %j`, error, commandName, messageData); + self.chargingStation.requests.delete(messageId); + reject(error); } - 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 - reject(error); - } - }); + }), Constants.OCPP_WEBSOCKET_TIMEOUT, new OCPPError(ErrorType.GENERIC_ERROR, `Timeout for message id '${messageId}'`, commandName, messageData?.details as JsonType ?? {}), () => { + messageType === MessageType.CALL_MESSAGE && this.chargingStation.requests.delete(messageId); + }); + } + 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`, commandName); } - 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 %s error: %j', commandName, error); throw error; } - 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; + private buildMessageToSend(messageId: string, messageData: JsonType | OCPPError, messageType: MessageType, commandName: RequestCommand | IncomingRequestCommand, + responseCallback: (payload: JsonType | string, requestPayload: JsonType) => Promise, + rejectCallback: (error: OCPPError, requestStatistic?: boolean) => 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, messageData]); + messageToSend = JSON.stringify([messageType, messageId, commandName, messageData]); + break; + // Response + case MessageType.CALL_RESULT_MESSAGE: + // Build response + messageToSend = JSON.stringify([messageType, messageId, messageData]); + break; + // Error Message + case MessageType.CALL_ERROR_MESSAGE: + // Build Error Message + messageToSend = JSON.stringify([messageType, messageId, messageData?.code ?? ErrorType.GENERIC_ERROR, messageData?.message ?? '', messageData?.details ?? {}]); + break; + } + return messageToSend; + } + + public abstract sendHeartbeat(params?: SendParams): Promise; + public abstract sendBootNotification(chargePointModel: string, chargePointVendor: string, chargeBoxSerialNumber?: string, firmwareVersion?: string, chargePointSerialNumber?: string, iccid?: string, imsi?: string, meterSerialNumber?: string, meterType?: string, params?: SendParams): 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 sendError(messageId: string, error: OCPPError, commandName: RequestCommand | IncomingRequestCommand): 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 sendResult(messageId: string, resultMessageData: JsonType, commandName: RequestCommand | IncomingRequestCommand): Promise; + public abstract sendError(messageId: string, error: OCPPError, commandName: RequestCommand | IncomingRequestCommand): Promise; }