X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPRequestService.ts;h=07793a8fd7f5ba498cb5a23581f6d60a84d4c019;hb=9aa1a33f94dfe5b96a4715f87fb630a63b3250a6;hp=a50500dc24047f7a7eb3276a03d725cedf69fb44;hpb=d8b1fab113850cb6c18747bd39d482d39a611b3f;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/OCPPRequestService.ts b/src/charging-station/ocpp/OCPPRequestService.ts index a50500dc..07793a8f 100644 --- a/src/charging-station/ocpp/OCPPRequestService.ts +++ b/src/charging-station/ocpp/OCPPRequestService.ts @@ -1,18 +1,17 @@ -import Ajv, { type JSONSchemaType } from 'ajv'; +import Ajv, { type JSONSchemaType, type ValidateFunction } from 'ajv'; import ajvFormats from 'ajv-formats'; -import { OCPPConstants, type OCPPResponseService, OCPPServiceUtils } from './internal'; +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 { - type EmptyObject, type ErrorCallback, type ErrorResponse, ErrorType, - type HandleErrorParams, type IncomingRequestCommand, - type JsonObject, type JsonType, MessageType, type OCPPVersion, @@ -23,16 +22,29 @@ import { type ResponseCallback, type ResponseType, } from '../../types'; -import { Constants, Utils, logger } from '../../utils'; +import { + cloneObject, + formatDurationMilliSeconds, + handleSendMessageError, + isNullOrUndefined, + logger, +} from '../../utils'; const moduleName = 'OCPPRequestService'; +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; - protected abstract jsonSchemas: Map>; + private readonly jsonValidateFunctions: Map>; + protected abstract jsonSchemas: Map>; protected constructor(version: OCPPVersion, ocppResponseService: OCPPResponseService) { this.version = version; @@ -41,34 +53,36 @@ export abstract class OCPPRequestService { multipleOfPrecision: 2, }); ajvFormats(this.ajv); + 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 + ResType extends JsonType, >( chargingStation: ChargingStation, commandName: RequestCommand, commandParams?: JsonType, - params?: RequestParams + params?: RequestParams, ) => Promise; this.sendMessage = this.sendMessage.bind(this) as ( chargingStation: ChargingStation, messageId: string, messagePayload: JsonType, commandName: RequestCommand, - params?: RequestParams + params?: RequestParams, ) => Promise; this.sendResponse = this.sendResponse.bind(this) as ( chargingStation: ChargingStation, messageId: string, messagePayload: JsonType, - commandName: IncomingRequestCommand + commandName: IncomingRequestCommand, ) => Promise; this.sendError = this.sendError.bind(this) as ( chargingStation: ChargingStation, messageId: string, ocppError: OCPPError, - commandName: RequestCommand | IncomingRequestCommand + commandName: RequestCommand | IncomingRequestCommand, ) => Promise; this.internalSendMessage = this.internalSendMessage.bind(this) as ( chargingStation: ChargingStation, @@ -76,7 +90,7 @@ export abstract class OCPPRequestService { messagePayload: JsonType | OCPPError, messageType: MessageType, commandName: RequestCommand | IncomingRequestCommand, - params?: RequestParams + params?: RequestParams, ) => Promise; this.buildMessageToSend = this.buildMessageToSend.bind(this) as ( chargingStation: ChargingStation, @@ -84,26 +98,24 @@ export abstract class OCPPRequestService { messagePayload: JsonType | OCPPError, messageType: MessageType, commandName: RequestCommand | IncomingRequestCommand, - responseCallback: ResponseCallback, - errorCallback: ErrorCallback ) => string; - this.validateRequestPayload = this.validateRequestPayload.bind(this) as ( + this.validateRequestPayload = this.validateRequestPayload.bind(this) as ( chargingStation: ChargingStation, commandName: RequestCommand | IncomingRequestCommand, - payload: T + payload: T, ) => boolean; this.validateIncomingRequestResponsePayload = this.validateIncomingRequestResponsePayload.bind( - this - ) as ( + this, + ) as ( chargingStation: ChargingStation, commandName: RequestCommand | IncomingRequestCommand, - payload: T + 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); @@ -115,7 +127,7 @@ export abstract class OCPPRequestService { chargingStation: ChargingStation, messageId: string, messagePayload: JsonType, - commandName: IncomingRequestCommand + commandName: IncomingRequestCommand, ): Promise { try { // Send response message @@ -124,12 +136,13 @@ export abstract class OCPPRequestService { messageId, messagePayload, MessageType.CALL_RESULT_MESSAGE, - commandName + commandName, ); } catch (error) { - this.handleSendMessageError(chargingStation, commandName, error as Error, { + handleSendMessageError(chargingStation, commandName, error as Error, { throwError: true, }); + return null; } } @@ -137,7 +150,7 @@ export abstract class OCPPRequestService { chargingStation: ChargingStation, messageId: string, ocppError: OCPPError, - commandName: RequestCommand | IncomingRequestCommand + commandName: RequestCommand | IncomingRequestCommand, ): Promise { try { // Send error message @@ -146,10 +159,11 @@ export abstract class OCPPRequestService { messageId, ocppError, MessageType.CALL_ERROR_MESSAGE, - commandName + commandName, ); } catch (error) { - this.handleSendMessageError(chargingStation, commandName, error as Error); + handleSendMessageError(chargingStation, commandName, error as Error); + return null; } } @@ -158,12 +172,12 @@ export abstract class OCPPRequestService { messageId: string, messagePayload: JsonType, commandName: RequestCommand, - params: RequestParams = { - skipBufferingOnError: false, - triggerMessage: false, - throwError: false, - } + params?: RequestParams, ): Promise { + params = { + ...defaultRequestParams, + ...params, + }; try { return await this.internalSendMessage( chargingStation, @@ -171,253 +185,298 @@ export abstract class OCPPRequestService { messagePayload, MessageType.CALL_MESSAGE, commandName, - params + params, ); } catch (error) { - this.handleSendMessageError(chargingStation, commandName, error as Error, { + handleSendMessageError(chargingStation, commandName, error as Error, { throwError: params.throwError, }); + return null; } } - private validateRequestPayload( + private validateRequestPayload( chargingStation: ChargingStation, commandName: RequestCommand | IncomingRequestCommand, - payload: T + payload: T, ): boolean { - if (chargingStation.getPayloadSchemaValidation() === false) { + 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` + `${chargingStation.logPrefix()} ${moduleName}.validateRequestPayload: No JSON schema found for command '${commandName}' PDU validation`, ); return true; } - const validate = this.ajv.compile(this.jsonSchemas.get(commandName as RequestCommand)); - payload = Utils.cloneObject(payload); + 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 + 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 validateIncomingRequestResponsePayload( + 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 + payload: T, ): boolean { - if (chargingStation.getPayloadSchemaValidation() === false) { + if (chargingStation.stationInfo?.ocppStrictCompliance === false) { return true; } if ( this.ocppResponseService.jsonIncomingRequestResponseSchemas.has( - commandName as IncomingRequestCommand + commandName as IncomingRequestCommand, ) === false ) { logger.warn( - `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: No JSON schema found for command '${commandName}' PDU validation` + `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: No JSON schema found for command '${commandName}' PDU validation`, ); return true; } - const validate = this.ajv.compile( - this.ocppResponseService.jsonIncomingRequestResponseSchemas.get( - commandName as IncomingRequestCommand - ) + const validate = this.getJsonRequestResponseValidateFunction( + commandName as IncomingRequestCommand, ); - payload = Utils.cloneObject(payload); + 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 + 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, null, 2) + 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, - } + params?: RequestParams, ): Promise { + params = { + ...defaultRequestParams, + ...params, + }; if ( - (chargingStation.isInUnknownState() === true && + (chargingStation.inUnknownState() === true && commandName === RequestCommand.BOOT_NOTIFICATION) || - (chargingStation.getOcppStrictCompliance() === false && - chargingStation.isInUnknownState() === true) || - chargingStation.isInAcceptedState() === true || - (chargingStation.isInPendingState() === true && + (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) => { - /** - * Function that will receive the request's response - * - * @param payload - - * @param requestPayload - - */ - const 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 - - */ - const 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 at ${OCPPServiceUtils.getMessageTypeString( - messageType - )} command ${commandName} with PDU %j:`, - messagePayload, - error + 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.CALL_RESULT_MESSAGE, ); - chargingStation.requests.delete(messageId); - reject(error); - }; + } + // Handle the request's response + self.ocppResponseService + .responseHandler( + chargingStation, + commandName as RequestCommand, + payload, + requestPayload, + ) + .then(() => { + resolve(payload); + }) + .catch(reject) + .finally(() => { + chargingStation.requests.delete(messageId); + }); + }; - if (chargingStation.getEnableStatistics() === true) { - chargingStation.performanceStatistics?.addRequestStatistic(commandName, messageType); + /** + * 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, + ); } - const messageToSend = this.buildMessageToSend( - chargingStation, - messageId, + logger.error( + `${chargingStation.logPrefix()} Error occurred at ${OCPPServiceUtils.getMessageTypeString( + messageType, + )} command ${commandName} with PDU %j:`, messagePayload, - messageType, - commandName, - responseCallback, - errorCallback + ocppError, ); - let sendError = false; - // Check if wsConnection opened - const wsOpened = chargingStation.isWebSocketConnectionOpened() === true; - if (wsOpened) { - const beginId = PerformanceStatistics.beginMeasure(commandName); - try { - chargingStation.wsConnection?.send(messageToSend); - logger.debug( - `${chargingStation.logPrefix()} >> Command '${commandName}' sent ${OCPPServiceUtils.getMessageTypeString( - messageType - )} payload: ${messageToSend}` - ); - } catch (error) { - logger.error( - `${chargingStation.logPrefix()} >> Command '${commandName}' failed to send ${OCPPServiceUtils.getMessageTypeString( - messageType - )} payload: ${messageToSend}:`, - error + chargingStation.requests.delete(messageId); + reject(ocppError); + }; + + 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, + responseCallback, + errorCallback, ); - sendError = true; } - PerformanceStatistics.endMeasure(commandName, beginId); + } else if ( + params?.skipBufferingOnError === true && + messageType === MessageType.CALL_MESSAGE + ) { + // Remove request from the cache + chargingStation.requests.delete(messageId); } - const wsClosedOrErrored = !wsOpened || sendError === true; - if (wsClosedOrErrored && params.skipBufferingOnError === false) { - // Buffer - chargingStation.bufferMessage(messageToSend); - // Reject and keep request in the cache - return reject( + 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 handleSendError( new OCPPError( ErrorType.GENERIC_ERROR, - `WebSocket closed or errored for buffered message id '${messageId}' with content '${messageToSend}'`, + `Timeout ${formatDurationMilliSeconds( + OCPPConstants.OCPP_WEBSOCKET_TIMEOUT, + )} reached for ${ + params?.skipBufferingOnError === false ? '' : 'non ' + }buffered message id '${messageId}' with content '${messageToSend}`, commandName, - (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FREEZED_OBJECT - ) + (messagePayload as OCPPError).details, + ), ); - } else if (wsClosedOrErrored) { - const ocppError = new OCPPError( + }, 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 or errored for non buffered message id '${messageId}' with content '${messageToSend}'`, + `WebSocket closed for ${ + params?.skipBufferingOnError === false ? '' : 'non ' + }buffered message id '${messageId}' with content '${messageToSend}'`, commandName, - (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FREEZED_OBJECT - ); - // Reject response - if (messageType !== MessageType.CALL_MESSAGE) { - return reject(ocppError); - } - // Reject and remove request from the cache - return errorCallback(ocppError, false); - } - // Resolve response - if (messageType !== MessageType.CALL_MESSAGE) { - return resolve(messagePayload); - } - }), - OCPPConstants.OCPP_WEBSOCKET_TIMEOUT, - new OCPPError( - ErrorType.GENERIC_ERROR, - `Timeout for message id '${messageId}'`, - commandName, - (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FREEZED_OBJECT - ), - () => { - messageType === MessageType.CALL_MESSAGE && chargingStation.requests.delete(messageId); + (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, ); } @@ -427,8 +486,6 @@ export abstract class OCPPRequestService { messagePayload: JsonType | OCPPError, messageType: MessageType, commandName: RequestCommand | IncomingRequestCommand, - responseCallback: ResponseCallback, - errorCallback: ErrorCallback ): string { let messageToSend: string; // Type of message @@ -436,13 +493,7 @@ export abstract class OCPPRequestService { // Request case MessageType.CALL_MESSAGE: // Build request - this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonObject); - chargingStation.requests.set(messageId, [ - responseCallback, - errorCallback, - commandName, - messagePayload as JsonType, - ]); + this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonType); messageToSend = JSON.stringify([ messageType, messageId, @@ -456,7 +507,7 @@ export abstract class OCPPRequestService { this.validateIncomingRequestResponsePayload( chargingStation, commandName, - messagePayload as JsonObject + messagePayload as JsonType, ); messageToSend = JSON.stringify([messageType, messageId, messagePayload] as Response); break; @@ -466,32 +517,39 @@ export 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 handleSendMessageError( + private cacheRequestPromise( chargingStation: ChargingStation, + messageId: string, + messagePayload: JsonType, commandName: RequestCommand | IncomingRequestCommand, - error: Error, - params: HandleErrorParams = { throwError: false } + responseCallback: ResponseCallback, + errorCallback: ErrorCallback, ): void { - logger.error(`${chargingStation.logPrefix()} Request command '${commandName}' error:`, error); - if (params?.throwError === true) { - throw error; - } + chargingStation.requests.set(messageId, [ + responseCallback, + errorCallback, + commandName, + messagePayload, + ]); } // eslint-disable-next-line @typescript-eslint/no-unused-vars public abstract requestHandler( chargingStation: ChargingStation, commandName: RequestCommand, + // FIXME: should be ReqType commandParams?: JsonType, - params?: RequestParams + params?: RequestParams, ): Promise; }