X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPRequestService.ts;h=07793a8fd7f5ba498cb5a23581f6d60a84d4c019;hb=9aa1a33f94dfe5b96a4715f87fb630a63b3250a6;hp=e78ca0c6dfa4d8fcec3049d05b67a11d62df82de;hpb=0afed85fd7e6cb8f4b5ea0d18800a8d7b3bd78a7;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/OCPPRequestService.ts b/src/charging-station/ocpp/OCPPRequestService.ts index e78ca0c6..07793a8f 100644 --- a/src/charging-station/ocpp/OCPPRequestService.ts +++ b/src/charging-station/ocpp/OCPPRequestService.ts @@ -1,52 +1,121 @@ -import type { JSONSchemaType } from 'ajv'; -import Ajv from 'ajv-draft-04'; +import Ajv, { type JSONSchemaType, type ValidateFunction } from 'ajv'; import ajvFormats from 'ajv-formats'; -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 { 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 JsonType, + MessageType, + type OCPPVersion, + type OutgoingRequest, RequestCommand, - RequestParams, - 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'; + type RequestParams, + type Response, + type ResponseCallback, + type ResponseType, +} from '../../types'; +import { + cloneObject, + formatDurationMilliSeconds, + handleSendMessageError, + isNullOrUndefined, + logger, +} from '../../utils'; const moduleName = 'OCPPRequestService'; -export default abstract class OCPPRequestService { - private static instance: OCPPRequestService | null = null; - private ajv: Ajv; +const defaultRequestParams: RequestParams = { + skipBufferingOnError: false, + triggerMessage: false, + throwError: false, +}; +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(ocppResponseService: OCPPResponseService) { - this.ocppResponseService = ocppResponseService; - this.ajv = new Ajv(); + protected constructor(version: OCPPVersion, ocppResponseService: OCPPResponseService) { + this.version = version; + this.ajv = new Ajv({ + keywords: ['javaType'], + multipleOfPrecision: 2, + }); ajvFormats(this.ajv); - this.requestHandler.bind(this); - this.sendResponse.bind(this); - this.sendError.bind(this); - this.internalSendMessage.bind(this); - this.buildMessageToSend.bind(this); - this.validateRequestPayload.bind(this); + this.jsonValidateFunctions = new Map>(); + this.ocppResponseService = ocppResponseService; + 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 (ocppResponseService: OCPPResponseService) => T, - ocppResponseService: OCPPResponseService + ocppResponseService: OCPPResponseService, ): T { if (OCPPRequestService.instance === null) { OCPPRequestService.instance = new this(ocppResponseService); @@ -58,7 +127,7 @@ export default abstract class OCPPRequestService { chargingStation: ChargingStation, messageId: string, messagePayload: JsonType, - commandName: IncomingRequestCommand + commandName: IncomingRequestCommand, ): Promise { try { // Send response message @@ -67,10 +136,13 @@ export default abstract class OCPPRequestService { messageId, messagePayload, MessageType.CALL_RESULT_MESSAGE, - commandName + commandName, ); } catch (error) { - this.handleRequestError(chargingStation, commandName, error as Error); + handleSendMessageError(chargingStation, commandName, error as Error, { + throwError: true, + }); + return null; } } @@ -78,7 +150,7 @@ export default abstract class OCPPRequestService { chargingStation: ChargingStation, messageId: string, ocppError: OCPPError, - commandName: RequestCommand | IncomingRequestCommand + commandName: RequestCommand | IncomingRequestCommand, ): Promise { try { // Send error message @@ -87,10 +159,11 @@ export default abstract class OCPPRequestService { messageId, ocppError, MessageType.CALL_ERROR_MESSAGE, - commandName + commandName, ); } catch (error) { - this.handleRequestError(chargingStation, commandName, error as Error); + handleSendMessageError(chargingStation, commandName, error as Error); + return null; } } @@ -99,11 +172,12 @@ export default abstract class OCPPRequestService { messageId: string, messagePayload: JsonType, commandName: RequestCommand, - params: RequestParams = { - skipBufferingOnError: false, - triggerMessage: false, - } + params?: RequestParams, ): Promise { + params = { + ...defaultRequestParams, + ...params, + }; try { return await this.internalSendMessage( chargingStation, @@ -111,188 +185,298 @@ export default abstract class OCPPRequestService { messagePayload, MessageType.CALL_MESSAGE, commandName, - params + params, ); } catch (error) { - this.handleRequestError(chargingStation, commandName, error as Error, { throwError: false }); + handleSendMessageError(chargingStation, commandName, error as Error, { + throwError: params.throwError, + }); + return null; } } - protected validateRequestPayload( + private validateRequestPayload( chargingStation: ChargingStation, - commandName: RequestCommand, - schema: JSONSchemaType, - payload: T + commandName: RequestCommand | IncomingRequestCommand, + payload: T, ): boolean { - if (!chargingStation.getPayloadSchemaValidation()) { + 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.ajv.compile(schema); + const validate = this.getJsonRequestValidateFunction(commandName as RequestCommand); + payload = cloneObject(payload); + OCPPServiceUtils.convertDateToISOString(payload); if (validate(payload)) { return true; } logger.error( - `${chargingStation.logPrefix()} ${moduleName}.validateRequestPayload: Request PDU is invalid: %j`, - validate.errors + `${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) + 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 ( - (chargingStation.isInUnknownState() && commandName === RequestCommand.BOOT_NOTIFICATION) || - (!chargingStation.getOcppStrictCompliance() && chargingStation.isInUnknownState()) || - chargingStation.isInAcceptedState() || - (chargingStation.isInPendingState() && - (params.triggerMessage || messageType === MessageType.CALL_RESULT_MESSAGE)) + (chargingStation.inUnknownState() === true && + commandName === RequestCommand.BOOT_NOTIFICATION) || + (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( - chargingStation, - messageId, - messagePayload, - messageType, - commandName, - responseCallback, - errorCallback - ); - if (chargingStation.getEnableStatistics()) { - chargingStation.performanceStatistics.addRequestStatistic(commandName, messageType); - } - // Check if wsConnection opened - if (chargingStation.isWebSocketConnectionOpened()) { - // Yes: Send Message - const beginId = PerformanceStatistics.beginMeasure(commandName); - // FIXME: Handle sending error - chargingStation.wsConnection.send(messageToSend); - PerformanceStatistics.endMeasure(commandName, beginId); - logger.debug( - `${chargingStation.logPrefix()} >> Command '${commandName}' sent ${this.getMessageTypeString( - messageType - )} payload: ${messageToSend}` - ); - } else if (!params.skipBufferingOnError) { - // Buffer it - chargingStation.bufferMessage(messageToSend); - const ocppError = new OCPPError( - ErrorType.GENERIC_ERROR, - `WebSocket closed for buffered message id '${messageId}' with content '${messageToSend}'`, + 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, - (messagePayload as JsonObject)?.details ?? {} + MessageType.CALL_RESULT_MESSAGE, ); - 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 - */ - async function responseCallback( - payload: JsonType, - requestPayload: JsonType - ): Promise { - if (chargingStation.getEnableStatistics()) { - chargingStation.performanceStatistics.addRequestStatistic( - commandName, - MessageType.CALL_RESULT_MESSAGE - ); - } - // Handle the request's response - try { - await self.ocppResponseService.responseHandler( - chargingStation, - commandName as RequestCommand, - payload, - requestPayload - ); + // Handle the request's response + self.ocppResponseService + .responseHandler( + chargingStation, + commandName as RequestCommand, + payload, + requestPayload, + ) + .then(() => { resolve(payload); - } catch (error) { - reject(error); - } finally { + }) + .catch(reject) + .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, + ); } + logger.error( + `${chargingStation.logPrefix()} Error occurred at ${OCPPServiceUtils.getMessageTypeString( + messageType, + )} command ${commandName} with PDU %j:`, + messagePayload, + ocppError, + ); + chargingStation.requests.delete(messageId); + reject(ocppError); + }; - /** - * 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( + 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, - MessageType.CALL_ERROR_MESSAGE + responseCallback, + errorCallback, ); } - logger.error( - `${chargingStation.logPrefix()} Error occurred when calling command ${commandName} with message data ${JSON.stringify( - messagePayload - )}:`, - error - ); + } else if ( + params?.skipBufferingOnError === true && + messageType === MessageType.CALL_MESSAGE + ) { + // Remove request from the cache chargingStation.requests.delete(messageId); - reject(error); } - }), - Constants.OCPP_WEBSOCKET_TIMEOUT, - new OCPPError( - ErrorType.GENERIC_ERROR, - `Timeout for message id '${messageId}'`, + return reject(ocppError); + }; + + if (chargingStation.stationInfo?.enableStatistics === true) { + chargingStation.performanceStatistics?.addRequestStatistic(commandName, messageType); + } + const messageToSend = this.buildMessageToSend( + chargingStation, + messageId, + messagePayload, + messageType, commandName, - (messagePayload as JsonObject)?.details ?? {} - ), - () => { - messageType === MessageType.CALL_MESSAGE && chargingStation.requests.delete(messageId); + ); + // Check if wsConnection opened + if (chargingStation.isWebSocketConnectionOpened() === true) { + const beginId = PerformanceStatistics.beginMeasure(commandName); + const sendTimeout = setTimeout(() => { + return handleSendError( + new OCPPError( + ErrorType.GENERIC_ERROR, + `Timeout ${formatDurationMilliSeconds( + OCPPConstants.OCPP_WEBSOCKET_TIMEOUT, + )} reached for ${ + params?.skipBufferingOnError === false ? '' : 'non ' + }buffered message id '${messageId}' with content '${messageToSend}`, + commandName, + (messagePayload as OCPPError).details, + ), + ); + }, 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 for ${ + params?.skipBufferingOnError === false ? '' : 'non ' + }buffered message id '${messageId}' with content '${messageToSend}'`, + commandName, + (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`, - commandName + commandName, ); } @@ -301,9 +485,7 @@ export default abstract class OCPPRequestService { messageId: string, messagePayload: JsonType | OCPPError, messageType: MessageType, - commandName?: RequestCommand | IncomingRequestCommand, - responseCallback?: (payload: JsonType, requestPayload: JsonType) => Promise, - errorCallback?: (error: OCPPError, requestStatistic?: boolean) => void + commandName: RequestCommand | IncomingRequestCommand, ): string { let messageToSend: string; // Type of message @@ -311,12 +493,7 @@ export default abstract class OCPPRequestService { // Request case MessageType.CALL_MESSAGE: // Build request - chargingStation.requests.set(messageId, [ - responseCallback, - errorCallback, - commandName, - messagePayload as JsonType, - ]); + this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonType); messageToSend = JSON.stringify([ messageType, messageId, @@ -327,6 +504,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 @@ -335,43 +517,39 @@ export default 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 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(`${chargingStation.logPrefix()} Request command '${commandName}' error:`, error); - if (params?.throwError) { - throw error; - } + chargingStation.requests.set(messageId, [ + responseCallback, + errorCallback, + commandName, + 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; }