X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPRequestService.ts;h=17fc548438ac612c6fe6274d12a9d88c338a70fb;hb=dd21af153ed64c6220b6b14a5165c11443032f4f;hp=67b93afe9ce1febbca3eda1bab3c9d88630d4794;hpb=66a7748ddeda8c94d7562a1ce58d440319654a4c;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/OCPPRequestService.ts b/src/charging-station/ocpp/OCPPRequestService.ts index 67b93afe..17fc5484 100644 --- a/src/charging-station/ocpp/OCPPRequestService.ts +++ b/src/charging-station/ocpp/OCPPRequestService.ts @@ -1,4 +1,4 @@ -import _Ajv, { type JSONSchemaType, type ValidateFunction } from 'ajv' +import _Ajv, { type ValidateFunction } from 'ajv' import _ajvFormats from 'ajv-formats' import { OCPPConstants } from './OCPPConstants.js' @@ -24,10 +24,9 @@ import { type ResponseType } from '../../types/index.js' import { - cloneObject, + clone, formatDurationMilliSeconds, handleSendMessageError, - isNullOrUndefined, logger } from '../../utils/index.js' type Ajv = _Ajv.default @@ -46,10 +45,9 @@ const defaultRequestParams: RequestParams = { 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 readonly ajv: Ajv + protected abstract payloadValidateFunctions: Map> protected constructor (version: OCPPVersion, ocppResponseService: OCPPResponseService) { this.version = version @@ -58,64 +56,16 @@ 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 - >( - 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 + this.requestHandler = this.requestHandler.bind(this) + this.sendMessage = this.sendMessage.bind(this) + this.sendResponse = this.sendResponse.bind(this) + this.sendError = this.sendError.bind(this) + this.internalSendMessage = this.internalSendMessage.bind(this) + this.buildMessageToSend = this.buildMessageToSend.bind(this) + this.validateRequestPayload = this.validateRequestPayload.bind(this) + this.validateIncomingRequestResponsePayload = + this.validateIncomingRequestResponsePayload.bind(this) } public static getInstance( @@ -208,45 +158,31 @@ export abstract class OCPPRequestService { if (chargingStation.stationInfo?.ocppStrictCompliance === false) { return true } - if (!this.jsonSchemas.has(commandName as RequestCommand)) { + if (!this.payloadValidateFunctions.has(commandName as RequestCommand)) { 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) + const validate = this.payloadValidateFunctions.get(commandName as RequestCommand) + payload = clone(payload) OCPPServiceUtils.convertDateToISOString(payload) - if (validate(payload)) { + if (validate?.(payload) === true) { 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), + OCPPServiceUtils.ajvErrorsToErrorType(validate?.errors), 'Request PDU is invalid', commandName, - JSON.stringify(validate.errors, undefined, 2) + JSON.stringify(validate?.errors, undefined, 2) ) } - private getJsonRequestValidateFunction( - commandName: RequestCommand - ): ValidateFunction { - if (!this.jsonValidateFunctions.has(commandName)) { - this.jsonValidateFunctions.set( - commandName, - // eslint-disable-next-line @typescript-eslint/no-non-null-assertion - this.ajv.compile(this.jsonSchemas.get(commandName)!).bind(this) - ) - } - // eslint-disable-next-line @typescript-eslint/no-non-null-assertion - return this.jsonValidateFunctions.get(commandName)! - } - private validateIncomingRequestResponsePayload( chargingStation: ChargingStation, commandName: RequestCommand | IncomingRequestCommand, @@ -256,52 +192,36 @@ export abstract class OCPPRequestService { return true } if ( - !this.ocppResponseService.jsonIncomingRequestResponseSchemas.has( + !this.ocppResponseService.incomingRequestResponsePayloadValidateFunctions.has( commandName as IncomingRequestCommand ) ) { logger.warn( - `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: No JSON schema found for command '${commandName}' PDU validation` + `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: No JSON schema validation function found for command '${commandName}' PDU validation` ) return true } - const validate = this.getJsonRequestResponseValidateFunction( + const validate = this.ocppResponseService.incomingRequestResponsePayloadValidateFunctions.get( commandName as IncomingRequestCommand ) - payload = cloneObject(payload) + payload = clone(payload) OCPPServiceUtils.convertDateToISOString(payload) - if (validate(payload)) { + if (validate?.(payload) === true) { return true } logger.error( - `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: Command '${commandName}' reponse PDU is invalid: %j`, - validate.errors + `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: Command '${commandName}' response 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), + OCPPServiceUtils.ajvErrorsToErrorType(validate?.errors), 'Response PDU is invalid', commandName, - JSON.stringify(validate.errors, undefined, 2) + JSON.stringify(validate?.errors, undefined, 2) ) } - private getJsonRequestResponseValidateFunction( - commandName: IncomingRequestCommand - ): ValidateFunction { - if (!this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.has(commandName)) { - this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.set( - commandName, - this.ajv - // eslint-disable-next-line @typescript-eslint/no-non-null-assertion - .compile(this.ocppResponseService.jsonIncomingRequestResponseSchemas.get(commandName)!) - .bind(this) - ) - } - // eslint-disable-next-line @typescript-eslint/no-non-null-assertion - return this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.get(commandName)! - } - private async internalSendMessage ( chargingStation: ChargingStation, messageId: string, @@ -436,7 +356,7 @@ export abstract class OCPPRequestService { chargingStation.wsConnection?.send(messageToSend, (error?: Error) => { PerformanceStatistics.endMeasure(commandName, beginId) clearTimeout(sendTimeout) - if (isNullOrUndefined(error)) { + if (error == null) { logger.debug( `${chargingStation.logPrefix()} >> Command '${commandName}' sent ${OCPPServiceUtils.getMessageTypeString( messageType @@ -455,7 +375,7 @@ export abstract class OCPPRequestService { // Resolve response resolve(messagePayload) } - } else if (error != null) { + } else { handleSendError( new OCPPError( ErrorType.GENERIC_ERROR, @@ -484,7 +404,7 @@ export abstract class OCPPRequestService { } throw new OCPPError( ErrorType.SECURITY_ERROR, - `Cannot send command ${commandName} PDU when the charging station is in ${chargingStation?.bootNotificationResponse?.status} state on the central server`, + `Cannot send command ${commandName} PDU when the charging station is in ${chargingStation.bootNotificationResponse?.status} state on the central server`, commandName ) } @@ -506,9 +426,9 @@ export abstract class OCPPRequestService { messageToSend = JSON.stringify([ messageType, messageId, - commandName, - messagePayload - ] as OutgoingRequest) + commandName as RequestCommand, + messagePayload as JsonType + ] satisfies OutgoingRequest) break // Response case MessageType.CALL_RESULT_MESSAGE: @@ -518,7 +438,11 @@ export abstract class OCPPRequestService { commandName, messagePayload as JsonType ) - messageToSend = JSON.stringify([messageType, messageId, messagePayload] as Response) + messageToSend = JSON.stringify([ + messageType, + messageId, + messagePayload as JsonType + ] satisfies Response) break // Error Message case MessageType.CALL_ERROR_MESSAGE: @@ -531,7 +455,7 @@ export abstract class OCPPRequestService { (messagePayload as OCPPError).details ?? { command: (messagePayload as OCPPError).command ?? commandName } - ] as ErrorResponse) + ] satisfies ErrorResponse) break } return messageToSend