X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPRequestService.ts;h=0d59131fd157804c3de02cd4037fde289d82beed;hb=69dae411c7e64a265f8199ef149b745dff595ed7;hp=e71409056552773921a8f45cf710454e6e354080;hpb=c75a66757c7a26aa7b9fbdbcaaed413c77a45df1;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/OCPPRequestService.ts b/src/charging-station/ocpp/OCPPRequestService.ts index e7140905..0d59131f 100644 --- a/src/charging-station/ocpp/OCPPRequestService.ts +++ b/src/charging-station/ocpp/OCPPRequestService.ts @@ -1,280 +1,496 @@ -import { ErrorResponse, Response } from '../../types/ocpp/Responses'; +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 { - IncomingRequestCommand, - OutgoingRequest, + type ErrorCallback, + type ErrorResponse, + ErrorType, + type IncomingRequestCommand, + type JsonObject, + type JsonType, + MessageType, + type OCPPVersion, + type OutgoingRequest, RequestCommand, - RequestParams, - ResponseType, -} from '../../types/ocpp/Requests'; + type RequestParams, + type Response, + type ResponseCallback, + type ResponseType, +} from '../../types'; +import { + Constants, + cloneObject, + handleSendMessageError, + isNullOrUndefined, + logger, +} from '../../utils'; -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; +export abstract class OCPPRequestService { + private static instance: OCPPRequestService | null = null; + private readonly version: OCPPVersion; + private readonly ajv: Ajv; private readonly ocppResponseService: OCPPResponseService; + private readonly jsonValidateFunctions: Map>; + protected abstract jsonSchemas: Map>; - protected 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.jsonValidateFunctions = new Map>(); this.ocppResponseService = ocppResponseService; - this.requestHandler.bind(this); - this.sendResponse.bind(this); - this.sendError.bind(this); + this.requestHandler = this.requestHandler.bind(this) as < + // eslint-disable-next-line @typescript-eslint/no-unused-vars + ReqType extends JsonType, + ResType extends JsonType, + >( + chargingStation: ChargingStation, + commandName: RequestCommand, + commandParams?: JsonType, + params?: RequestParams, + ) => Promise; + this.sendMessage = this.sendMessage.bind(this) as ( + chargingStation: ChargingStation, + messageId: string, + messagePayload: JsonType, + commandName: RequestCommand, + params?: RequestParams, + ) => Promise; + this.sendResponse = this.sendResponse.bind(this) as ( + chargingStation: ChargingStation, + messageId: string, + messagePayload: JsonType, + commandName: IncomingRequestCommand, + ) => Promise; + this.sendError = this.sendError.bind(this) as ( + chargingStation: ChargingStation, + messageId: string, + ocppError: OCPPError, + commandName: RequestCommand | IncomingRequestCommand, + ) => Promise; + this.internalSendMessage = this.internalSendMessage.bind(this) as ( + chargingStation: ChargingStation, + messageId: string, + messagePayload: JsonType | OCPPError, + messageType: MessageType, + commandName: RequestCommand | IncomingRequestCommand, + params?: RequestParams, + ) => Promise; + this.buildMessageToSend = this.buildMessageToSend.bind(this) as ( + chargingStation: ChargingStation, + messageId: string, + messagePayload: JsonType | OCPPError, + messageType: MessageType, + commandName: RequestCommand | IncomingRequestCommand, + ) => string; + this.validateRequestPayload = this.validateRequestPayload.bind(this) as ( + chargingStation: ChargingStation, + commandName: RequestCommand | IncomingRequestCommand, + payload: T, + ) => boolean; + this.validateIncomingRequestResponsePayload = this.validateIncomingRequestResponsePayload.bind( + this, + ) as ( + chargingStation: ChargingStation, + commandName: RequestCommand | IncomingRequestCommand, + payload: T, + ) => boolean; } public static getInstance( - this: new (chargingStation: ChargingStation, ocppResponseService: OCPPResponseService) => T, - chargingStation: ChargingStation, - ocppResponseService: OCPPResponseService + 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 sendResponse( + chargingStation: ChargingStation, messageId: string, messagePayload: JsonType, - commandName: IncomingRequestCommand + commandName: IncomingRequestCommand, ): Promise { try { // Send response message return await this.internalSendMessage( + chargingStation, messageId, messagePayload, MessageType.CALL_RESULT_MESSAGE, - commandName + commandName, ); } catch (error) { - this.handleRequestError(commandName, error as Error); + handleSendMessageError(chargingStation, commandName, error as Error, { + throwError: true, + }); + return null; } } public async sendError( + chargingStation: ChargingStation, messageId: string, ocppError: OCPPError, - commandName: RequestCommand | IncomingRequestCommand + commandName: RequestCommand | IncomingRequestCommand, ): Promise { try { // Send error message return await this.internalSendMessage( + chargingStation, messageId, ocppError, MessageType.CALL_ERROR_MESSAGE, - commandName + commandName, ); } catch (error) { - this.handleRequestError(commandName, error as Error); + handleSendMessageError(chargingStation, commandName, error as Error); + return null; } } protected async sendMessage( + chargingStation: ChargingStation, messageId: string, messagePayload: JsonType, commandName: RequestCommand, - params: RequestParams = { - skipBufferingOnError: false, - triggerMessage: false, - } + params?: RequestParams, ): Promise { + params = { + ...defaultRequestParams, + ...params, + }; try { return await this.internalSendMessage( + chargingStation, messageId, messagePayload, MessageType.CALL_MESSAGE, commandName, - params + 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.jsonSchemas.has(commandName as RequestCommand) === false) { + logger.warn( + `${chargingStation.logPrefix()} ${moduleName}.validateRequestPayload: No JSON schema found for command '${commandName}' PDU validation`, + ); + return true; + } + const validate = this.getJsonRequestValidateFunction(commandName as RequestCommand); + payload = cloneObject(payload); + 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, undefined, 2), + ); + } + + 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.stationInfo?.ocppStrictCompliance === false) { + return true; + } + if ( + this.ocppResponseService.jsonIncomingRequestResponseSchemas.has( + commandName as IncomingRequestCommand, + ) === false + ) { + logger.warn( + `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: No JSON schema found for command '${commandName}' PDU validation`, + ); + return true; + } + const validate = this.getJsonRequestResponseValidateFunction( + commandName as IncomingRequestCommand, + ); + payload = cloneObject(payload); + OCPPServiceUtils.convertDateToISOString(payload); + if (validate(payload)) { + return true; + } + logger.error( + `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: Command '${commandName}' reponse 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 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, messagePayload: JsonType | OCPPError, messageType: MessageType, - commandName?: RequestCommand | IncomingRequestCommand, - params: RequestParams = { - skipBufferingOnError: false, - triggerMessage: false, - } + commandName: RequestCommand | IncomingRequestCommand, + params?: RequestParams, ): Promise { + params = { + ...defaultRequestParams, + ...params, + }; if ( - (this.chargingStation.isInUnknownState() && + (chargingStation.inUnknownState() === true && commandName === RequestCommand.BOOT_NOTIFICATION) || - (!this.chargingStation.getOcppStrictCompliance() && - this.chargingStation.isInUnknownState()) || - this.chargingStation.isInAcceptedState() || - (this.chargingStation.isInPendingState() && - (params.triggerMessage || messageType === MessageType.CALL_RESULT_MESSAGE)) + (chargingStation.stationInfo?.ocppStrictCompliance === false && + chargingStation.inUnknownState() === true) || + chargingStation.inAcceptedState() === true || + (chargingStation.inPendingState() === 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( - messageId, - messagePayload, - messageType, - commandName, - responseCallback, - rejectCallback - ); - if (this.chargingStation.getEnableStatistics()) { - this.chargingStation.performanceStatistics.addRequestStatistic( + 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 + 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}` + // 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 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, ); - } 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}'`, + } + logger.error( + `${chargingStation.logPrefix()} Error occurred at ${OCPPServiceUtils.getMessageTypeString( + messageType, + )} command ${commandName} with PDU %j:`, + messagePayload, + ocppError, + ); + chargingStation.requests.delete(messageId); + reject(ocppError); + }; + + const rejectWithOcppError = (ocppError: OCPPError): void => { + // Reject response + if (messageType !== MessageType.CALL_MESSAGE) { + return reject(ocppError); + } + // Reject and remove request from the cache + return errorCallback(ocppError, false); + }; + + const bufferAndRejectWithOcppError = (ocppError: OCPPError): void => { + // Buffer + chargingStation.bufferMessage(messageToSend); + if (messageType === MessageType.CALL_MESSAGE) { + this.cacheRequestPromise( + chargingStation, + messageId, + messagePayload as JsonType, commandName, - (messagePayload?.details as JsonType) ?? {} + responseCallback, + errorCallback, ); - 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( + } + // Reject and keep request in the cache + 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 rejectWithOcppError( new OCPPError( ErrorType.GENERIC_ERROR, - `WebSocket closed for non buffered message id '${messageId}' with content '${messageToSend}'`, + `Timeout for message id '${messageId}'`, commandName, - (messagePayload?.details as JsonType) ?? {} + (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FROZEN_OBJECT, ), - 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 - */ - async function responseCallback( - payload: JsonType, - 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.responseHandler( - commandName as RequestCommand, - payload, - requestPayload + }, 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}`, ); - resolve(payload); - } catch (error) { - reject(error); - } finally { - self.chargingStation.requests.delete(messageId); - } - } - - /** - * 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 (messageType === MessageType.CALL_MESSAGE) { + this.cacheRequestPromise( + chargingStation, + messageId, + messagePayload as JsonType, + commandName, + responseCallback, + errorCallback, + ); + } else { + // Resolve response + return resolve(messagePayload); + } + } else if (error) { + const ocppError = new OCPPError( + ErrorType.GENERIC_ERROR, + `WebSocket errored for ${ + params?.skipBufferingOnError === false ? '' : 'non ' + }buffered message id '${messageId}' with content '${messageToSend}'`, commandName, - MessageType.CALL_ERROR_MESSAGE + { name: error.name, message: error.message, stack: error.stack }, ); + if (params?.skipBufferingOnError === false) { + return bufferAndRejectWithOcppError(ocppError); + } + return rejectWithOcppError(ocppError); } - logger.error( - `${self.chargingStation.logPrefix()} Error %j occurred when calling command %s with message data %j`, - error, - commandName, - messagePayload - ); - self.chargingStation.requests.delete(messageId); - reject(error); + }); + } else { + const ocppError = new OCPPError( + ErrorType.GENERIC_ERROR, + `WebSocket closed for ${ + params?.skipBufferingOnError === false ? '' : 'non ' + }buffered message id '${messageId}' with content '${messageToSend}'`, + commandName, + (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FROZEN_OBJECT, + ); + if (params?.skipBufferingOnError === false) { + return bufferAndRejectWithOcppError(ocppError); } - }), - 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); + return rejectWithOcppError(ocppError); } - ); + }); } 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 + `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?: (payload: JsonType, requestPayload: JsonType) => Promise, - rejectCallback?: (error: OCPPError, requestStatistic?: boolean) => void + commandName: RequestCommand | IncomingRequestCommand, ): string { let messageToSend: string; // Type of message @@ -282,12 +498,7 @@ export default abstract class OCPPRequestService { // Request case MessageType.CALL_MESSAGE: // Build request - this.chargingStation.requests.set(messageId, [ - responseCallback, - rejectCallback, - commandName, - messagePayload as JsonType, - ]); + this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonType); messageToSend = JSON.stringify([ messageType, messageId, @@ -298,6 +509,11 @@ export default abstract class OCPPRequestService { // Response case MessageType.CALL_RESULT_MESSAGE: // Build response + this.validateIncomingRequestResponsePayload( + chargingStation, + commandName, + messagePayload as JsonType, + ); messageToSend = JSON.stringify([messageType, messageId, messagePayload] as Response); break; // Error Message @@ -315,36 +531,28 @@ export default abstract class OCPPRequestService { 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'; - } - } - - private handleRequestError( + private cacheRequestPromise( + 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 requestHandler( + public abstract requestHandler( + chargingStation: ChargingStation, commandName: RequestCommand, + // FIXME: should be ReqType commandParams?: JsonType, - params?: RequestParams - ): Promise; + params?: RequestParams, + ): Promise; }