import Ajv, { type JSONSchemaType } from 'ajv';
-import AjvDraft04 from 'ajv-draft-04';
import ajvFormats from 'ajv-formats';
+import type OCPPResponseService from './OCPPResponseService';
+import { OCPPServiceUtils } from './OCPPServiceUtils';
import OCPPError from '../../exception/OCPPError';
import PerformanceStatistics from '../../performance/PerformanceStatistics';
import type { EmptyObject } from '../../types/EmptyObject';
import type { JsonObject, JsonType } from '../../types/JsonType';
import { ErrorType } from '../../types/ocpp/ErrorType';
import { MessageType } from '../../types/ocpp/MessageType';
-import { OCPPVersion } from '../../types/ocpp/OCPPVersion';
+import type { OCPPVersion } from '../../types/ocpp/OCPPVersion';
import {
type ErrorCallback,
type IncomingRequestCommand,
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';
private static instance: OCPPRequestService | null = null;
private readonly version: OCPPVersion;
private readonly ajv: Ajv;
-
private readonly ocppResponseService: OCPPResponseService;
+ protected abstract jsonSchemas: Map<RequestCommand, JSONSchemaType<JsonObject>>;
protected constructor(version: OCPPVersion, ocppResponseService: OCPPResponseService) {
this.version = version;
- switch (this.version) {
- case OCPPVersion.VERSION_16:
- this.ajv = new AjvDraft04();
- break;
- case OCPPVersion.VERSION_20:
- case OCPPVersion.VERSION_201:
- this.ajv = new Ajv();
- break;
- }
+ this.ajv = new Ajv({
+ keywords: ['javaType'],
+ multipleOfPrecision: 2,
+ });
ajvFormats(this.ajv);
this.ocppResponseService = ocppResponseService;
this.requestHandler.bind(this);
this.internalSendMessage.bind(this);
this.buildMessageToSend.bind(this);
this.validateRequestPayload.bind(this);
+ this.validateIncomingRequestResponsePayload.bind(this);
}
public static getInstance<T extends OCPPRequestService>(
params: RequestParams = {
skipBufferingOnError: false,
triggerMessage: false,
+ throwError: false,
}
): Promise<ResponseType> {
try {
params
);
} catch (error) {
- this.handleSendMessageError(chargingStation, commandName, error as Error);
+ this.handleSendMessageError(chargingStation, commandName, error as Error, {
+ throwError: params.throwError,
+ });
}
}
- protected validateRequestPayload<T extends JsonType>(
+ private validateRequestPayload<T extends JsonObject>(
chargingStation: ChargingStation,
- commandName: RequestCommand,
- schema: JSONSchemaType<T>,
+ commandName: RequestCommand | IncomingRequestCommand,
payload: T
): boolean {
if (chargingStation.getPayloadSchemaValidation() === false) {
return true;
}
- const validate = this.ajv.compile(schema);
+ 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(this.jsonSchemas.get(commandName as RequestCommand));
+ payload = Utils.cloneObject<T>(payload);
+ OCPPServiceUtils.convertDateToISOString<T>(payload);
if (validate(payload)) {
return true;
}
logger.error(
- `${chargingStation.logPrefix()} ${moduleName}.validateRequestPayload: Request PDU is invalid: %j`,
+ `${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().
);
}
+ private validateIncomingRequestResponsePayload<T extends JsonObject>(
+ chargingStation: ChargingStation,
+ commandName: RequestCommand | IncomingRequestCommand,
+ payload: T
+ ): boolean {
+ if (chargingStation.getPayloadSchemaValidation() === 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.ajv.compile(
+ this.ocppResponseService.jsonIncomingRequestResponseSchemas.get(
+ commandName as IncomingRequestCommand
+ )
+ );
+ payload = Utils.cloneObject<T>(payload);
+ OCPPServiceUtils.convertDateToISOString<T>(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, null, 2)
+ );
+ }
+
private async internalSendMessage(
chargingStation: ChargingStation,
messageId: string,
if (chargingStation.getEnableStatistics() === true) {
chargingStation.performanceStatistics.addRequestStatistic(commandName, messageType);
}
+ let sendError = false;
// 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);
+ 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
+ );
+ sendError = true;
+ }
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
+ }
+ const wsClosedOrErrored =
+ chargingStation.isWebSocketConnectionOpened() === false || sendError === true;
+ if (wsClosedOrErrored && params.skipBufferingOnError === false) {
+ // Buffer
chargingStation.bufferMessage(messageToSend);
+ // Reject and keep request in the cache
+ return reject(
+ new OCPPError(
+ ErrorType.GENERIC_ERROR,
+ `WebSocket closed or errored for buffered message id '${messageId}' with content '${messageToSend}'`,
+ commandName,
+ (messagePayload as JsonObject)?.details ?? {}
+ )
+ );
+ } else if (wsClosedOrErrored) {
const ocppError = new OCPPError(
ErrorType.GENERIC_ERROR,
- `WebSocket closed for buffered message id '${messageId}' with content '${messageToSend}'`,
+ `WebSocket closed or errored for non 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
+ // Reject response
+ if (messageType !== MessageType.CALL_MESSAGE) {
return reject(ocppError);
}
+ // Reject and remove request from the cache
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?
+ // Resolve response
if (messageType !== MessageType.CALL_MESSAGE) {
- // Yes: send Ok
return resolve(messagePayload);
}
);
}
logger.error(
- `${chargingStation.logPrefix()} Error occurred when calling command ${commandName} with message data ${JSON.stringify(
- messagePayload
- )}:`,
+ `${chargingStation.logPrefix()} Error occurred at ${OCPPServiceUtils.getMessageTypeString(
+ messageType
+ )} command ${commandName} with PDU %j:`,
+ messagePayload,
error
);
chargingStation.requests.delete(messageId);
// Request
case MessageType.CALL_MESSAGE:
// Build request
+ this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonObject);
chargingStation.requests.set(messageId, [
responseCallback,
errorCallback,
// Response
case MessageType.CALL_RESULT_MESSAGE:
// Build response
+ this.validateIncomingRequestResponsePayload(
+ chargingStation,
+ commandName,
+ messagePayload as JsonObject
+ );
messageToSend = JSON.stringify([messageType, messageId, messagePayload] as Response);
break;
// Error Message
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 handleSendMessageError(
chargingStation: ChargingStation,
commandName: RequestCommand | IncomingRequestCommand,
repositories / e-mobility-charging-stations-simulator.git / blobdiff