X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPRequestService.ts;h=e4890a91d8a6a88e2c8d282fcd603c2b2c31baef;hb=98fc1389a2464ce8738047f8990731ae31938ee5;hp=1bc8e70cd275cab6decf2049d12e6bfc9316eaef;hpb=6198eef3947754c7ad85050cb56014794f60c846;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/OCPPRequestService.ts b/src/charging-station/ocpp/OCPPRequestService.ts index 1bc8e70c..e4890a91 100644 --- a/src/charging-station/ocpp/OCPPRequestService.ts +++ b/src/charging-station/ocpp/OCPPRequestService.ts @@ -1,138 +1,401 @@ -import { AuthorizeResponse, StartTransactionResponse, StopTransactionReason, StopTransactionResponse } from '../../types/ocpp/Transaction'; -import { DiagnosticsStatus, IncomingRequestCommand, RequestCommand } from '../../types/ocpp/Requests'; +import Ajv, { type JSONSchemaType } from 'ajv'; +import ajvFormats from 'ajv-formats'; -import { BootNotificationResponse } from '../../types/ocpp/Responses'; -import { ChargePointErrorCode } from '../../types/ocpp/ChargePointErrorCode'; -import { ChargePointStatus } from '../../types/ocpp/ChargePointStatus'; -import ChargingStation from '../ChargingStation'; -import Constants from '../../utils/Constants'; +import OCPPError from '../../exception/OCPPError'; +import PerformanceStatistics from '../../performance/PerformanceStatistics'; +import type { EmptyObject } from '../../types/EmptyObject'; +import type { HandleErrorParams } from '../../types/Error'; +import type { JsonObject, JsonType } from '../../types/JsonType'; import { ErrorType } from '../../types/ocpp/ErrorType'; import { MessageType } from '../../types/ocpp/MessageType'; -import { MeterValue } from '../../types/ocpp/MeterValues'; -import OCPPError from './OCPPError'; -import OCPPResponseService from './OCPPResponseService'; -import PerformanceStatistics from '../../performance/PerformanceStatistics'; +import type { OCPPVersion } from '../../types/ocpp/OCPPVersion'; +import { + type ErrorCallback, + type IncomingRequestCommand, + type OutgoingRequest, + RequestCommand, + type RequestParams, + type ResponseCallback, + type ResponseType, +} from '../../types/ocpp/Requests'; +import type { ErrorResponse, Response } from '../../types/ocpp/Responses'; +import Constants from '../../utils/Constants'; import logger from '../../utils/Logger'; +import Utils from '../../utils/Utils'; +import type ChargingStation from '../ChargingStation'; +import type OCPPResponseService from './OCPPResponseService'; +import { OCPPServiceUtils } from './OCPPServiceUtils'; + +const moduleName = 'OCPPRequestService'; export default abstract class OCPPRequestService { - public chargingStation: ChargingStation; - protected ocppResponseService: OCPPResponseService; + private static instance: OCPPRequestService | null = null; + private readonly version: OCPPVersion; + private readonly ajv: Ajv; + + private readonly ocppResponseService: OCPPResponseService; - constructor(chargingStation: ChargingStation, ocppResponseService: OCPPResponseService) { - this.chargingStation = chargingStation; + 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.bind(this); + this.sendMessage.bind(this); + this.sendResponse.bind(this); + this.sendError.bind(this); + this.internalSendMessage.bind(this); + this.buildMessageToSend.bind(this); + this.validateRequestPayload.bind(this); } - 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, 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 - 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 (!skipBufferingOnError) { - // Buffer it - this.chargingStation.addToMessageQueue(messageToSend); - const ocppError = new OCPPError(ErrorType.GENERIC_ERROR, `WebSocket closed for buffered message id '${messageId}' with content '${messageToSend}'`, commandParams?.details ?? {}); - if (messageType === MessageType.CALL_MESSAGE) { - // Reject it but keep the request in the cache - return reject(ocppError); - } - return rejectCallback(ocppError); - } else { - // Reject it - return rejectCallback(new OCPPError(ErrorType.GENERIC_ERROR, `WebSocket closed for non buffered message id '${messageId}' with content '${messageToSend}'`, commandParams?.details ?? {})); - } - // Response? - if (messageType !== MessageType.CALL_MESSAGE) { - // Yes: send Ok - resolve({ commandName, commandParams }); - } else { - // Send timeout - setTimeout(() => rejectCallback(new OCPPError(ErrorType.GENERIC_ERROR, `Timeout for message id '${messageId}' with content '${messageToSend}'`, commandParams?.details ?? {})), Constants.OCPP_SOCKET_TIMEOUT); - } - - /** - * 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.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({ commandName, payload, requestPayload }); - } - - /** - * Function that will receive the request's error response - * - * @param error - */ - function rejectCallback(error: OCPPError): void { - if (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 parameters %j`, error, commandName, commandParams); - self.chargingStation.requests.delete(messageId); - reject(error); - } - }); + public static getInstance( + this: new (ocppResponseService: OCPPResponseService) => T, + ocppResponseService: OCPPResponseService + ): T { + if (OCPPRequestService.instance === null) { + OCPPRequestService.instance = new this(ocppResponseService); + } + return OCPPRequestService.instance as T; + } + + public async sendResponse( + chargingStation: ChargingStation, + messageId: string, + messagePayload: JsonType, + commandName: IncomingRequestCommand + ): Promise { + try { + // Send response message + return await this.internalSendMessage( + chargingStation, + messageId, + messagePayload, + MessageType.CALL_RESULT_MESSAGE, + commandName + ); + } catch (error) { + this.handleSendMessageError(chargingStation, commandName, error as Error, { + throwError: true, + }); + } } - protected handleRequestError(commandName: RequestCommand, error: Error): void { - logger.error(this.chargingStation.logPrefix() + ' Request command ' + commandName + ' error: %j', error); - throw error; + public async sendError( + chargingStation: ChargingStation, + messageId: string, + ocppError: OCPPError, + commandName: RequestCommand | IncomingRequestCommand + ): Promise { + try { + // Send error message + return await this.internalSendMessage( + chargingStation, + messageId, + ocppError, + MessageType.CALL_ERROR_MESSAGE, + commandName + ); + } catch (error) { + this.handleSendMessageError(chargingStation, commandName, error as Error); + } } - private buildMessageToSend(messageId: string, commandParams: Record, messageType: MessageType, commandName: RequestCommand | IncomingRequestCommand, - responseCallback: (payload: Record | string, requestPayload: Record) => Promise, rejectCallback: (error: OCPPError) => void): string { + protected async sendMessage( + chargingStation: ChargingStation, + messageId: string, + messagePayload: JsonType, + commandName: RequestCommand, + params: RequestParams = { + skipBufferingOnError: false, + triggerMessage: false, + } + ): Promise { + try { + return await this.internalSendMessage( + chargingStation, + messageId, + messagePayload, + MessageType.CALL_MESSAGE, + commandName, + params + ); + } catch (error) { + this.handleSendMessageError(chargingStation, commandName, error as Error); + } + } + + protected validateRequestPayload( + chargingStation: ChargingStation, + commandName: RequestCommand | IncomingRequestCommand, + payload: T + ): boolean { + if (chargingStation.getPayloadSchemaValidation() === false) { + return true; + } + const schema = this.getRequestPayloadValidationSchema(chargingStation, commandName); + if (schema === false) { + return true; + } + const validate = this.ajv.compile(schema); + OCPPServiceUtils.convertDateToISOString(payload); + if (validate(payload)) { + 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, null, 2) + ); + } + + private async internalSendMessage( + chargingStation: ChargingStation, + messageId: string, + messagePayload: JsonType | OCPPError, + messageType: MessageType, + commandName?: RequestCommand | IncomingRequestCommand, + params: RequestParams = { + skipBufferingOnError: false, + triggerMessage: false, + } + ): Promise { + if ( + (chargingStation.isInUnknownState() === true && + commandName === RequestCommand.BOOT_NOTIFICATION) || + (chargingStation.getOcppStrictCompliance() === false && + chargingStation.isInUnknownState() === true) || + chargingStation.isInAcceptedState() === true || + (chargingStation.isInPendingState() === true && + (params.triggerMessage === true || messageType === MessageType.CALL_RESULT_MESSAGE)) + ) { + // 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( + chargingStation, + messageId, + messagePayload, + messageType, + commandName, + responseCallback, + errorCallback + ); + if (chargingStation.getEnableStatistics() === true) { + chargingStation.performanceStatistics.addRequestStatistic(commandName, messageType); + } + // Check if wsConnection opened + if (chargingStation.isWebSocketConnectionOpened() === true) { + // Yes: Send Message + const beginId = PerformanceStatistics.beginMeasure(commandName as string); + // FIXME: Handle sending error + chargingStation.wsConnection.send(messageToSend); + PerformanceStatistics.endMeasure(commandName as string, beginId); + logger.debug( + `${chargingStation.logPrefix()} >> Command '${commandName}' sent ${this.getMessageTypeString( + messageType + )} payload: ${messageToSend}` + ); + } else if (params.skipBufferingOnError === false) { + // Buffer it + chargingStation.bufferMessage(messageToSend); + const ocppError = new OCPPError( + ErrorType.GENERIC_ERROR, + `WebSocket closed for buffered message id '${messageId}' with content '${messageToSend}'`, + commandName, + (messagePayload as JsonObject)?.details ?? {} + ); + if (messageType === MessageType.CALL_MESSAGE) { + // Reject it but keep the request in the cache + return reject(ocppError); + } + return errorCallback(ocppError, false); + } else { + // Reject it + return errorCallback( + new OCPPError( + ErrorType.GENERIC_ERROR, + `WebSocket closed for non buffered message id '${messageId}' with content '${messageToSend}'`, + commandName, + (messagePayload as JsonObject)?.details ?? {} + ), + false + ); + } + // Response? + if (messageType !== MessageType.CALL_MESSAGE) { + // Yes: send Ok + return resolve(messagePayload); + } + + /** + * Function that will receive the request's response + * + * @param payload - + * @param requestPayload - + */ + function 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 - + */ + function 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 when calling command ${commandName} with message data ${JSON.stringify( + messagePayload + )}:`, + error + ); + chargingStation.requests.delete(messageId); + reject(error); + } + }), + Constants.OCPP_WEBSOCKET_TIMEOUT, + new OCPPError( + ErrorType.GENERIC_ERROR, + `Timeout for message id '${messageId}'`, + commandName, + (messagePayload as JsonObject)?.details ?? {} + ), + () => { + messageType === MessageType.CALL_MESSAGE && chargingStation.requests.delete(messageId); + } + ); + } + throw new OCPPError( + ErrorType.SECURITY_ERROR, + `Cannot send command ${commandName} PDU when the charging station is in ${chargingStation.getRegistrationStatus()} state on the central server`, + commandName + ); + } + + private buildMessageToSend( + chargingStation: ChargingStation, + messageId: string, + messagePayload: JsonType | OCPPError, + messageType: MessageType, + commandName?: RequestCommand | IncomingRequestCommand, + responseCallback?: ResponseCallback, + errorCallback?: ErrorCallback + ): 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]); - messageToSend = JSON.stringify([messageType, messageId, commandName, commandParams]); + chargingStation.requests.set(messageId, [ + responseCallback, + errorCallback, + commandName, + messagePayload as JsonType, + ]); + this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonType); + messageToSend = JSON.stringify([ + messageType, + messageId, + commandName, + messagePayload, + ] as OutgoingRequest); break; // Response case MessageType.CALL_RESULT_MESSAGE: // Build response - messageToSend = JSON.stringify([messageType, messageId, commandParams]); + // FIXME: Validate response payload + messageToSend = JSON.stringify([messageType, messageId, messagePayload] as Response); 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 ?? {}]); + messageToSend = JSON.stringify([ + messageType, + messageId, + (messagePayload as OCPPError)?.code ?? ErrorType.GENERIC_ERROR, + (messagePayload as OCPPError)?.message ?? '', + (messagePayload as OCPPError)?.details ?? { commandName }, + ] as ErrorResponse); 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(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): 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; + 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'; + } + } + + private handleSendMessageError( + chargingStation: ChargingStation, + commandName: RequestCommand | IncomingRequestCommand, + error: Error, + params: HandleErrorParams = { throwError: false } + ): void { + logger.error(`${chargingStation.logPrefix()} Request command '${commandName}' error:`, error); + if (params?.throwError === true) { + throw error; + } + } + + // eslint-disable-next-line @typescript-eslint/no-unused-vars + public abstract requestHandler( + chargingStation: ChargingStation, + commandName: RequestCommand, + commandParams?: JsonType, + params?: RequestParams + ): Promise; + + protected abstract getRequestPayloadValidationSchema( + chargingStation: ChargingStation, + commandName: RequestCommand | IncomingRequestCommand + ): JSONSchemaType | false; }