-import type { JSONSchemaType } from 'ajv';
-import Ajv from 'ajv-draft-04';
+import Ajv, { type JSONSchemaType } from 'ajv';
import ajvFormats from 'ajv-formats';
import OCPPError from '../../exception/OCPPError';
import type { JsonObject, JsonType } from '../../types/JsonType';
import { ErrorType } from '../../types/ocpp/ErrorType';
import { MessageType } from '../../types/ocpp/MessageType';
+import type { OCPPVersion } from '../../types/ocpp/OCPPVersion';
import {
- IncomingRequestCommand,
- OutgoingRequest,
+ type ErrorCallback,
+ type IncomingRequestCommand,
+ type OutgoingRequest,
RequestCommand,
- RequestParams,
- ResponseType,
+ type RequestParams,
+ type ResponseCallback,
+ type ResponseType,
} from '../../types/ocpp/Requests';
import type { ErrorResponse, Response } from '../../types/ocpp/Responses';
import Constants from '../../utils/Constants';
export default abstract class OCPPRequestService {
private static instance: OCPPRequestService | null = null;
- private ajv: Ajv;
-
+ private readonly version: OCPPVersion;
+ private readonly ajv: Ajv;
private readonly ocppResponseService: OCPPResponseService;
+ protected abstract jsonSchemas: Map<RequestCommand, JSONSchemaType<JsonObject>>;
- 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.ocppResponseService = ocppResponseService;
this.requestHandler.bind(this);
+ this.sendMessage.bind(this);
this.sendResponse.bind(this);
this.sendError.bind(this);
this.internalSendMessage.bind(this);
commandName
);
} catch (error) {
- this.handleRequestError(chargingStation, commandName, error as Error);
+ this.handleSendMessageError(chargingStation, commandName, error as Error, {
+ throwError: true,
+ });
}
}
commandName
);
} catch (error) {
- this.handleRequestError(chargingStation, commandName, error as Error);
+ this.handleSendMessageError(chargingStation, commandName, error as Error);
}
}
params
);
} catch (error) {
- this.handleRequestError(chargingStation, commandName, error as Error, { throwError: false });
+ this.handleSendMessageError(chargingStation, commandName, error as Error);
}
}
- protected validateRequestPayload<T extends JsonType>(
+ protected validateRequestPayload<T extends JsonObject>(
chargingStation: ChargingStation,
- commandName: RequestCommand,
- schema: JSONSchemaType<T>,
+ commandName: RequestCommand | IncomingRequestCommand,
payload: T
): boolean {
- if (!chargingStation.getPayloadSchemaValidation()) {
+ 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().
throw new OCPPError(
OCPPServiceUtils.ajvErrorsToErrorType(validate.errors),
'Request PDU is invalid',
);
}
+ protected validateResponsePayload<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}.validateResponsePayload: 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}.validateResponsePayload: 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,
}
): Promise<ResponseType> {
if (
- (chargingStation.isInUnknownState() && commandName === RequestCommand.BOOT_NOTIFICATION) ||
- (!chargingStation.getOcppStrictCompliance() && chargingStation.isInUnknownState()) ||
- chargingStation.isInAcceptedState() ||
- (chargingStation.isInPendingState() &&
- (params.triggerMessage || messageType === MessageType.CALL_RESULT_MESSAGE))
+ (chargingStation.isInUnknownState() === true &&
+ commandName === RequestCommand.BOOT_NOTIFICATION) ||
+ (chargingStation.getOcppStrictCompliance() === false &&
+ chargingStation.isInUnknownState() === true) ||
+ chargingStation.isInAcceptedState() === true ||
+ (chargingStation.isInPendingState() === true &&
+ (params.triggerMessage === true || messageType === MessageType.CALL_RESULT_MESSAGE))
) {
// eslint-disable-next-line @typescript-eslint/no-this-alias
const self = this;
responseCallback,
errorCallback
);
- if (chargingStation.getEnableStatistics()) {
+ if (chargingStation.getEnableStatistics() === true) {
chargingStation.performanceStatistics.addRequestStatistic(commandName, messageType);
}
// Check if wsConnection opened
- if (chargingStation.isWebSocketConnectionOpened()) {
+ if (chargingStation.isWebSocketConnectionOpened() === true) {
// Yes: Send Message
- const beginId = PerformanceStatistics.beginMeasure(commandName);
+ const beginId = PerformanceStatistics.beginMeasure(commandName as string);
// FIXME: Handle sending error
chargingStation.wsConnection.send(messageToSend);
- PerformanceStatistics.endMeasure(commandName, beginId);
+ PerformanceStatistics.endMeasure(commandName as string, beginId);
logger.debug(
`${chargingStation.logPrefix()} >> Command '${commandName}' sent ${this.getMessageTypeString(
messageType
)} payload: ${messageToSend}`
);
- } else if (!params.skipBufferingOnError) {
+ } else if (params.skipBufferingOnError === false) {
// Buffer it
chargingStation.bufferMessage(messageToSend);
const ocppError = new OCPPError(
/**
* Function that will receive the request's response
*
- * @param payload
- * @param requestPayload
+ * @param payload -
+ * @param requestPayload -
*/
- async function responseCallback(
- payload: JsonType,
- requestPayload: JsonType
- ): Promise<void> {
- if (chargingStation.getEnableStatistics()) {
+ function responseCallback(payload: JsonType, requestPayload: JsonType): void {
+ if (chargingStation.getEnableStatistics() === true) {
chargingStation.performanceStatistics.addRequestStatistic(
commandName,
MessageType.CALL_RESULT_MESSAGE
);
}
// Handle the request's response
- try {
- await self.ocppResponseService.responseHandler(
+ self.ocppResponseService
+ .responseHandler(
chargingStation,
commandName as RequestCommand,
payload,
requestPayload
- );
- resolve(payload);
- } catch (error) {
- reject(error);
- } finally {
- chargingStation.requests.delete(messageId);
- }
+ )
+ .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
+ * @param error -
+ * @param requestStatistic -
*/
function errorCallback(error: OCPPError, requestStatistic = true): void {
- if (requestStatistic && chargingStation.getEnableStatistics()) {
+ if (requestStatistic === true && chargingStation.getEnableStatistics() === true) {
chargingStation.performanceStatistics.addRequestStatistic(
commandName,
MessageType.CALL_ERROR_MESSAGE
messagePayload: JsonType | OCPPError,
messageType: MessageType,
commandName?: RequestCommand | IncomingRequestCommand,
- responseCallback?: (payload: JsonType, requestPayload: JsonType) => Promise<void>,
- errorCallback?: (error: OCPPError, requestStatistic?: boolean) => void
+ responseCallback?: ResponseCallback,
+ errorCallback?: ErrorCallback
): string {
let messageToSend: string;
// Type of message
commandName,
messagePayload as JsonType,
]);
+ this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonObject);
messageToSend = JSON.stringify([
messageType,
messageId,
// Response
case MessageType.CALL_RESULT_MESSAGE:
// Build response
+ this.validateResponsePayload(chargingStation, commandName, messagePayload as JsonObject);
messageToSend = JSON.stringify([messageType, messageId, messagePayload] as Response);
break;
// Error Message
}
}
- private handleRequestError(
+ private handleSendMessageError(
chargingStation: ChargingStation,
commandName: RequestCommand | IncomingRequestCommand,
error: Error,
- params: HandleErrorParams<EmptyObject> = { throwError: true }
+ params: HandleErrorParams<EmptyObject> = { throwError: false }
): void {
- logger.error(`${chargingStation.logPrefix()} Request command ${commandName} error:`, error);
- if (params?.throwError) {
+ logger.error(`${chargingStation.logPrefix()} Request command '${commandName}' error:`, error);
+ if (params?.throwError === true) {
throw error;
}
}
// eslint-disable-next-line @typescript-eslint/no-unused-vars
- public abstract requestHandler<RequestType extends JsonType, ResponseType extends JsonType>(
+ public abstract requestHandler<ReqType extends JsonType, ResType extends JsonType>(
chargingStation: ChargingStation,
commandName: RequestCommand,
commandParams?: JsonType,
params?: RequestParams
- ): Promise<ResponseType>;
+ ): Promise<ResType>;
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff