-import { AuthorizeResponse, StartTransactionResponse, StopTransactionReason, StopTransactionResponse } from '../../types/ocpp/Transaction';
-import { IncomingRequestCommand, Request, RequestCommand } from '../../types/ocpp/Requests';
-
-import { BootNotificationResponse } from '../../types/ocpp/RequestResponses';
-import { ChargePointErrorCode } from '../../types/ocpp/ChargePointErrorCode';
-import { ChargePointStatus } from '../../types/ocpp/ChargePointStatus';
-import ChargingStation from '../ChargingStation';
-import Constants from '../../utils/Constants';
-import { ErrorType } from '../../types/ocpp/ErrorType';
-import { MessageType } from '../../types/ocpp/MessageType';
-import OCPPError from '../OcppError';
-import OCPPResponseService from './OCPPResponseService';
-import logger from '../../utils/Logger';
-
-export default abstract class OCPPRequestService {
- public chargingStation: ChargingStation;
- protected ocppResponseService: OCPPResponseService;
-
- constructor(chargingStation: ChargingStation, ocppResponseService: OCPPResponseService) {
- this.chargingStation = chargingStation;
+import Ajv, { type JSONSchemaType } from 'ajv';
+import ajvFormats from 'ajv-formats';
+
+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 ErrorCallback,
+ type ErrorResponse,
+ ErrorType,
+ type IncomingRequestCommand,
+ type JsonObject,
+ type JsonType,
+ MessageType,
+ type OCPPVersion,
+ type OutgoingRequest,
+ RequestCommand,
+ type RequestParams,
+ type Response,
+ type ResponseCallback,
+ type ResponseType,
+} from '../../types';
+import { Constants, Utils, handleSendMessageError, 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<RequestCommand, JSONSchemaType<JsonObject>>;
+
+ 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 = this.requestHandler.bind(this) as <
+ 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 JsonObject>(
+ chargingStation: ChargingStation,
+ commandName: RequestCommand | IncomingRequestCommand,
+ payload: T
+ ) => boolean;
+ this.validateIncomingRequestResponsePayload = this.validateIncomingRequestResponsePayload.bind(
+ this
+ ) as <T extends JsonObject>(
+ chargingStation: ChargingStation,
+ commandName: RequestCommand | IncomingRequestCommand,
+ payload: T
+ ) => boolean;
}
- public async sendMessage(messageId: string, commandParams: any, messageType: MessageType = MessageType.CALL_RESULT_MESSAGE, commandName: RequestCommand | IncomingRequestCommand): Promise<any> {
- // eslint-disable-next-line @typescript-eslint/no-this-alias
- const self = this;
- const chargingStation = this.chargingStation;
- // Send a message through wsConnection
- return new Promise((resolve: (value?: any | PromiseLike<any>) => void, reject: (reason?: any) => void) => {
- let messageToSend: string;
- // Type of message
- switch (messageType) {
- // Request
- case MessageType.CALL_MESSAGE:
- // Build request
- this.chargingStation.requests[messageId] = [responseCallback, rejectCallback, commandParams] as Request;
- messageToSend = JSON.stringify([messageType, messageId, commandName, commandParams]);
- break;
- // Response
- case MessageType.CALL_RESULT_MESSAGE:
- // Build response
- messageToSend = JSON.stringify([messageType, messageId, commandParams]);
- break;
- // Error Message
- case MessageType.CALL_ERROR_MESSAGE:
- // Build Error Message
- messageToSend = JSON.stringify([messageType, messageId, commandParams.code ? commandParams.code : ErrorType.GENERIC_ERROR, commandParams.message ? commandParams.message : '', commandParams.details ? commandParams.details : {}]);
- break;
- }
- // Check if wsConnection opened and charging station registered
- if (this.chargingStation.isWebSocketOpen() && (this.chargingStation.isRegistered() || commandName === RequestCommand.BOOT_NOTIFICATION)) {
- if (this.chargingStation.getEnableStatistics()) {
- this.chargingStation.statistics.addMessage(commandName, messageType);
- }
- // Yes: Send Message
- this.chargingStation.wsConnection.send(messageToSend);
- } else if (commandName !== RequestCommand.BOOT_NOTIFICATION) {
- let dups = false;
- // Handle dups in buffer
- for (const message of this.chargingStation.messageQueue) {
- // Same message
- if (messageToSend === message) {
- dups = true;
- break;
+ public static getInstance<T extends OCPPRequestService>(
+ this: new (ocppResponseService: OCPPResponseService) => T,
+ ocppResponseService: OCPPResponseService
+ ): T {
+ if (OCPPRequestService.instance === null) {
+ OCPPRequestService.instance = new this(ocppResponseService);
+ }
+ return OCPPRequestService.instance as T;
+ }
+
+ public async sendResponse(
+ chargingStation: ChargingStation,
+ messageId: string,
+ messagePayload: JsonType,
+ commandName: IncomingRequestCommand
+ ): Promise<ResponseType> {
+ try {
+ // Send response message
+ return await this.internalSendMessage(
+ chargingStation,
+ messageId,
+ messagePayload,
+ MessageType.CALL_RESULT_MESSAGE,
+ commandName
+ );
+ } catch (error) {
+ handleSendMessageError(chargingStation, commandName, error as Error, {
+ throwError: true,
+ });
+ }
+ }
+
+ public async sendError(
+ chargingStation: ChargingStation,
+ messageId: string,
+ ocppError: OCPPError,
+ commandName: RequestCommand | IncomingRequestCommand
+ ): Promise<ResponseType> {
+ try {
+ // Send error message
+ return await this.internalSendMessage(
+ chargingStation,
+ messageId,
+ ocppError,
+ MessageType.CALL_ERROR_MESSAGE,
+ commandName
+ );
+ } catch (error) {
+ handleSendMessageError(chargingStation, commandName, error as Error);
+ }
+ }
+
+ protected async sendMessage(
+ chargingStation: ChargingStation,
+ messageId: string,
+ messagePayload: JsonType,
+ commandName: RequestCommand,
+ params: RequestParams = defaultRequestParams
+ ): Promise<ResponseType> {
+ params = {
+ ...defaultRequestParams,
+ ...params,
+ };
+ try {
+ return await this.internalSendMessage(
+ chargingStation,
+ messageId,
+ messagePayload,
+ MessageType.CALL_MESSAGE,
+ commandName,
+ params
+ );
+ } catch (error) {
+ handleSendMessageError(chargingStation, commandName, error as Error, {
+ throwError: params.throwError,
+ });
+ }
+ }
+
+ private validateRequestPayload<T extends JsonObject>(
+ chargingStation: ChargingStation,
+ commandName: RequestCommand | IncomingRequestCommand,
+ payload: T
+ ): boolean {
+ if (chargingStation.getPayloadSchemaValidation() === 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`
+ );
+ 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: 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',
+ commandName,
+ JSON.stringify(validate.errors, null, 2)
+ );
+ }
+
+ 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,
+ messagePayload: JsonType | OCPPError,
+ messageType: MessageType,
+ commandName: RequestCommand | IncomingRequestCommand,
+ params: RequestParams = defaultRequestParams
+ ): Promise<ResponseType> {
+ params = {
+ ...defaultRequestParams,
+ ...params,
+ };
+ if (
+ (chargingStation.inUnknownState() === true &&
+ commandName === RequestCommand.BOOT_NOTIFICATION) ||
+ (chargingStation.getOcppStrictCompliance() === 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
+ );
+ chargingStation.requests.delete(messageId);
+ reject(error);
+ };
+
+ if (chargingStation.getEnableStatistics() === true) {
+ chargingStation.performanceStatistics?.addRequestStatistic(commandName, messageType);
}
+ const messageToSend = this.buildMessageToSend(
+ chargingStation,
+ messageId,
+ messagePayload,
+ messageType,
+ commandName,
+ responseCallback,
+ errorCallback
+ );
+ 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
+ );
+ sendError = true;
+ }
+ PerformanceStatistics.endMeasure(commandName, beginId);
+ }
+ const wsClosedOrErrored = !wsOpened || 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 ?? Constants.EMPTY_FREEZED_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 ?? 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);
}
- if (!dups) {
- // Buffer message
- this.chargingStation.messageQueue.push(messageToSend);
- }
- // Reject it
- return rejectCallback(new OCPPError(commandParams.code ? commandParams.code : ErrorType.GENERIC_ERROR, commandParams.message ? commandParams.message : `WebSocket closed for message id '${messageId}' with content '${messageToSend}', message buffered`, commandParams.details ? commandParams.details : {}));
- }
- // Response?
- if (messageType === MessageType.CALL_RESULT_MESSAGE) {
- // Yes: send Ok
- resolve();
- } else if (messageType === MessageType.CALL_ERROR_MESSAGE) {
- // Send timeout
- setTimeout(() => rejectCallback(new OCPPError(commandParams.code ? commandParams.code : ErrorType.GENERIC_ERROR, commandParams.message ? commandParams.message : `Timeout for message id '${messageId}' with content '${messageToSend}'`, commandParams.details ? commandParams.details : {})), Constants.OCPP_ERROR_TIMEOUT);
- }
-
- // Function that will receive the request's response
- async function responseCallback(payload: Record<string, unknown> | string, requestPayload: Record<string, unknown>): Promise<void> {
- if (chargingStation.getEnableStatistics()) {
- chargingStation.statistics.addMessage(commandName, messageType);
- }
- // Send the response
- await self.ocppResponseService.handleResponse(commandName as RequestCommand, payload, requestPayload);
- resolve(payload);
- }
-
- // Function that will receive the request's rejection
- function rejectCallback(error: OCPPError): void {
- if (chargingStation.getEnableStatistics()) {
- chargingStation.statistics.addMessage(commandName, messageType);
- }
- logger.debug(`${chargingStation.logPrefix()} Error: %j occurred when calling command %s with parameters: %j`, error, commandName, commandParams);
- // Build Exception
- // eslint-disable-next-line no-empty-function
- chargingStation.requests[messageId] = [() => { }, () => { }, {}]; // Properly format the request
- // Send error
- reject(error);
- }
- });
+ );
+ }
+ 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
+ );
}
- public handleRequestError(commandName: RequestCommand, error: Error): void {
- logger.error(this.chargingStation.logPrefix() + ' Send ' + commandName + ' error: %j', error);
- throw error;
+ private buildMessageToSend(
+ chargingStation: ChargingStation,
+ messageId: string,
+ messagePayload: JsonType | OCPPError,
+ messageType: MessageType,
+ commandName: RequestCommand | IncomingRequestCommand,
+ responseCallback: ResponseCallback,
+ errorCallback: ErrorCallback
+ ): string {
+ let messageToSend: string;
+ // Type of message
+ switch (messageType) {
+ // Request
+ case MessageType.CALL_MESSAGE:
+ // Build request
+ this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonObject);
+ chargingStation.requests.set(messageId, [
+ responseCallback,
+ errorCallback,
+ commandName,
+ messagePayload as JsonType,
+ ]);
+ messageToSend = JSON.stringify([
+ messageType,
+ messageId,
+ commandName,
+ messagePayload,
+ ] as OutgoingRequest);
+ break;
+ // 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
+ case MessageType.CALL_ERROR_MESSAGE:
+ // Build Error Message
+ messageToSend = JSON.stringify([
+ messageType,
+ messageId,
+ (messagePayload as OCPPError)?.code ?? ErrorType.GENERIC_ERROR,
+ (messagePayload as OCPPError)?.message ?? '',
+ (messagePayload as OCPPError)?.details ?? { commandName },
+ ] as ErrorResponse);
+ break;
+ }
+ return messageToSend;
}
- public abstract sendHeartbeat(): Promise<void>;
- public abstract sendBootNotification(chargePointModel: string, chargePointVendor: string, chargeBoxSerialNumber?: string, firmwareVersion?: string, chargePointSerialNumber?: string, iccid?: string, imsi?: string, meterSerialNumber?: string, meterType?: string): Promise<BootNotificationResponse>;
- public abstract sendStatusNotification(connectorId: number, status: ChargePointStatus, errorCode?: ChargePointErrorCode): Promise<void>;
- public abstract sendAuthorize(idTag?: string): Promise<AuthorizeResponse>;
- public abstract sendStartTransaction(connectorId: number, idTag?: string): Promise<StartTransactionResponse>;
- public abstract sendStopTransaction(transactionId: number, meterStop: number, idTag?: string, reason?: StopTransactionReason): Promise<StopTransactionResponse>;
- public abstract sendMeterValues(connectorId: number, transactionId: number, interval: number, self: OCPPRequestService): Promise<void>;
- public abstract sendError(messageId: string, error: OCPPError, commandName: RequestCommand | IncomingRequestCommand): Promise<unknown>;
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
+ public abstract requestHandler<ReqType extends JsonType, ResType extends JsonType>(
+ chargingStation: ChargingStation,
+ commandName: RequestCommand,
+ commandParams?: JsonType,
+ params?: RequestParams
+ ): Promise<ResType>;
}