-import Ajv, { type JSONSchemaType } from 'ajv';
+import Ajv, { type JSONSchemaType, type ValidateFunction } from 'ajv';
import ajvFormats from 'ajv-formats';
-import { 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,
type ResponseCallback,
type ResponseType,
} from '../../types';
-import { Constants, Utils, logger } from '../../utils';
+import {
+ Constants,
+ cloneObject,
+ handleSendMessageError,
+ logger,
+ promiseWithTimeout,
+} 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<RequestCommand, JSONSchemaType<JsonObject>>;
+ private readonly jsonValidateFunctions: Map<RequestCommand, ValidateFunction<JsonType>>;
+ protected abstract jsonSchemas: Map<RequestCommand, JSONSchemaType<JsonType>>;
protected constructor(version: OCPPVersion, ocppResponseService: OCPPResponseService) {
this.version = version;
multipleOfPrecision: 2,
});
ajvFormats(this.ajv);
+ this.jsonValidateFunctions = new Map<RequestCommand, ValidateFunction<JsonType>>();
this.ocppResponseService = ocppResponseService;
- this.requestHandler.bind(this);
- this.sendMessage.bind(this);
- this.sendResponse.bind(this);
- this.sendError.bind(this);
- this.internalSendMessage.bind(this);
- this.buildMessageToSend.bind(this);
- this.validateRequestPayload.bind(this);
- this.validateIncomingRequestResponsePayload.bind(this);
+ 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<ResType>;
+ this.sendMessage = this.sendMessage.bind(this) as (
+ chargingStation: ChargingStation,
+ messageId: string,
+ messagePayload: JsonType,
+ commandName: RequestCommand,
+ params?: RequestParams,
+ ) => Promise<ResponseType>;
+ this.sendResponse = this.sendResponse.bind(this) as (
+ chargingStation: ChargingStation,
+ messageId: string,
+ messagePayload: JsonType,
+ commandName: IncomingRequestCommand,
+ ) => Promise<ResponseType>;
+ this.sendError = this.sendError.bind(this) as (
+ chargingStation: ChargingStation,
+ messageId: string,
+ ocppError: OCPPError,
+ commandName: RequestCommand | IncomingRequestCommand,
+ ) => Promise<ResponseType>;
+ this.internalSendMessage = this.internalSendMessage.bind(this) as (
+ chargingStation: ChargingStation,
+ messageId: string,
+ messagePayload: JsonType | OCPPError,
+ messageType: MessageType,
+ commandName: RequestCommand | IncomingRequestCommand,
+ params?: RequestParams,
+ ) => Promise<ResponseType>;
+ this.buildMessageToSend = this.buildMessageToSend.bind(this) as (
+ chargingStation: ChargingStation,
+ messageId: string,
+ messagePayload: JsonType | OCPPError,
+ messageType: MessageType,
+ commandName: RequestCommand | IncomingRequestCommand,
+ responseCallback: ResponseCallback,
+ errorCallback: ErrorCallback,
+ ) => string;
+ this.validateRequestPayload = this.validateRequestPayload.bind(this) as <T extends JsonType>(
+ chargingStation: ChargingStation,
+ commandName: RequestCommand | IncomingRequestCommand,
+ payload: T,
+ ) => boolean;
+ this.validateIncomingRequestResponsePayload = this.validateIncomingRequestResponsePayload.bind(
+ this,
+ ) as <T extends JsonType>(
+ chargingStation: ChargingStation,
+ commandName: RequestCommand | IncomingRequestCommand,
+ payload: T,
+ ) => boolean;
}
public static getInstance<T extends OCPPRequestService>(
this: new (ocppResponseService: OCPPResponseService) => T,
- ocppResponseService: OCPPResponseService
+ ocppResponseService: OCPPResponseService,
): T {
if (OCPPRequestService.instance === null) {
OCPPRequestService.instance = new this(ocppResponseService);
chargingStation: ChargingStation,
messageId: string,
messagePayload: JsonType,
- commandName: IncomingRequestCommand
+ commandName: IncomingRequestCommand,
): Promise<ResponseType> {
try {
// Send response message
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;
}
}
chargingStation: ChargingStation,
messageId: string,
ocppError: OCPPError,
- commandName: RequestCommand | IncomingRequestCommand
+ commandName: RequestCommand | IncomingRequestCommand,
): Promise<ResponseType> {
try {
// Send error message
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;
}
}
messageId: string,
messagePayload: JsonType,
commandName: RequestCommand,
- params: RequestParams = {
- skipBufferingOnError: false,
- triggerMessage: false,
- throwError: false,
- }
+ params?: RequestParams,
): Promise<ResponseType> {
+ params = {
+ ...defaultRequestParams,
+ ...params,
+ };
try {
return await this.internalSendMessage(
chargingStation,
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<T extends JsonObject>(
+ private validateRequestPayload<T extends JsonType>(
chargingStation: ChargingStation,
commandName: RequestCommand | IncomingRequestCommand,
- payload: T
+ payload: T,
): boolean {
- if (chargingStation.getPayloadSchemaValidation() === false) {
+ if (chargingStation.getOcppStrictCompliance() === 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<T>(payload);
+ if (this.jsonValidateFunctions.has(commandName as RequestCommand) === false) {
+ this.jsonValidateFunctions.set(
+ commandName as RequestCommand,
+ this.ajv.compile<T>(this.jsonSchemas.get(commandName as RequestCommand)!).bind(this),
+ );
+ }
+ const validate = this.jsonValidateFunctions.get(commandName as RequestCommand)!;
+ payload = cloneObject<T>(payload);
OCPPServiceUtils.convertDateToISOString<T>(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<T extends JsonObject>(
+ private validateIncomingRequestResponsePayload<T extends JsonType>(
chargingStation: ChargingStation,
commandName: RequestCommand | IncomingRequestCommand,
- payload: T
+ payload: T,
): boolean {
- if (chargingStation.getPayloadSchemaValidation() === false) {
+ if (chargingStation.getOcppStrictCompliance() === 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
- )
- );
- payload = Utils.cloneObject<T>(payload);
+ if (
+ this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.has(
+ commandName as IncomingRequestCommand,
+ ) === false
+ ) {
+ this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.set(
+ commandName as IncomingRequestCommand,
+ this.ajv
+ .compile<T>(
+ this.ocppResponseService.jsonIncomingRequestResponseSchemas.get(
+ commandName as IncomingRequestCommand,
+ )!,
+ )
+ .bind(this),
+ );
+ }
+ const validate = this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.get(
+ commandName as IncomingRequestCommand,
+ )!;
+ payload = 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
+ 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),
);
}
messagePayload: JsonType | OCPPError,
messageType: MessageType,
commandName: RequestCommand | IncomingRequestCommand,
- params: RequestParams = {
- skipBufferingOnError: false,
- triggerMessage: false,
- }
+ params?: RequestParams,
): Promise<ResponseType> {
+ 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.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) => {
+ return promiseWithTimeout(
+ new Promise<ResponseType>((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,
+ );
+ chargingStation.requests.delete(messageId);
+ reject(error);
+ };
+
if (chargingStation.getEnableStatistics() === true) {
chargingStation.performanceStatistics?.addRequestStatistic(commandName, messageType);
}
messageType,
commandName,
responseCallback,
- errorCallback
+ errorCallback,
);
let sendError = false;
// Check if wsConnection opened
chargingStation.wsConnection?.send(messageToSend);
logger.debug(
`${chargingStation.logPrefix()} >> Command '${commandName}' sent ${OCPPServiceUtils.getMessageTypeString(
- messageType
- )} payload: ${messageToSend}`
+ messageType,
+ )} payload: ${messageToSend}`,
);
} catch (error) {
logger.error(
`${chargingStation.logPrefix()} >> Command '${commandName}' failed to send ${OCPPServiceUtils.getMessageTypeString(
- messageType
+ messageType,
)} payload: ${messageToSend}:`,
- error
+ error,
);
sendError = true;
}
PerformanceStatistics.endMeasure(commandName, beginId);
}
const wsClosedOrErrored = !wsOpened || sendError === true;
- if (wsClosedOrErrored && params.skipBufferingOnError === false) {
+ if (wsClosedOrErrored && params?.skipBufferingOnError === false) {
// Buffer
chargingStation.bufferMessage(messageToSend);
// Reject and keep request in the cache
ErrorType.GENERIC_ERROR,
`WebSocket closed or errored for buffered message id '${messageId}' with content '${messageToSend}'`,
commandName,
- (messagePayload as JsonObject)?.details ?? {}
- )
+ (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FROZEN_OBJECT,
+ ),
);
} else if (wsClosedOrErrored) {
const ocppError = new OCPPError(
ErrorType.GENERIC_ERROR,
`WebSocket closed or errored for non buffered message id '${messageId}' with content '${messageToSend}'`,
commandName,
- (messagePayload as JsonObject)?.details ?? {}
+ (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FROZEN_OBJECT,
);
// Reject response
if (messageType !== MessageType.CALL_MESSAGE) {
if (messageType !== MessageType.CALL_MESSAGE) {
return resolve(messagePayload);
}
-
- /**
- * Function that will receive the request's response
- *
- * @param payload -
- * @param requestPayload -
- */
- function 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 -
- */
- function 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
- );
- chargingStation.requests.delete(messageId);
- reject(error);
- }
}),
- Constants.OCPP_WEBSOCKET_TIMEOUT,
+ OCPPConstants.OCPP_WEBSOCKET_TIMEOUT,
new OCPPError(
ErrorType.GENERIC_ERROR,
`Timeout for message id '${messageId}'`,
commandName,
- (messagePayload as JsonObject)?.details ?? {}
+ (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FROZEN_OBJECT,
),
() => {
messageType === MessageType.CALL_MESSAGE && chargingStation.requests.delete(messageId);
- }
+ },
);
}
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,
);
}
messageType: MessageType,
commandName: RequestCommand | IncomingRequestCommand,
responseCallback: ResponseCallback,
- errorCallback: ErrorCallback
+ errorCallback: ErrorCallback,
): string {
let messageToSend: string;
// Type of message
// Request
case MessageType.CALL_MESSAGE:
// Build request
- this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonObject);
+ this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonType);
chargingStation.requests.set(messageId, [
responseCallback,
errorCallback,
this.validateIncomingRequestResponsePayload(
chargingStation,
commandName,
- messagePayload as JsonObject
+ messagePayload as JsonType,
);
messageToSend = JSON.stringify([messageType, messageId, messagePayload] as Response);
break;
return messageToSend;
}
- private handleSendMessageError(
- chargingStation: ChargingStation,
- commandName: RequestCommand | IncomingRequestCommand,
- error: Error,
- params: HandleErrorParams<EmptyObject> = { throwError: false }
- ): void {
- 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<ReqType extends JsonType, ResType extends JsonType>(
chargingStation: ChargingStation,
commandName: RequestCommand,
+ // FIXME: should be ReqType
commandParams?: JsonType,
- params?: RequestParams
+ params?: RequestParams,
): Promise<ResType>;
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff