-import Ajv, { type JSONSchemaType, type ValidateFunction } from 'ajv';
-import ajvFormats from 'ajv-formats';
+import _Ajv, { type ValidateFunction } 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 { ChargingStation } from '../../charging-station/index.js'
+import { OCPPError } from '../../exception/index.js'
+import { PerformanceStatistics } from '../../performance/index.js'
import {
ChargingStationEvents,
type ErrorCallback,
type RequestParams,
type Response,
type ResponseCallback,
- type ResponseType,
-} from '../../types';
+ type ResponseType
+} from '../../types/index.js'
import {
- cloneObject,
+ clone,
formatDurationMilliSeconds,
handleSendMessageError,
- isNullOrUndefined,
- logger,
-} from '../../utils';
+ logger
+} from '../../utils/index.js'
+import { OCPPConstants } from './OCPPConstants.js'
+import type { OCPPResponseService } from './OCPPResponseService.js'
+import { OCPPServiceUtils } from './OCPPServiceUtils.js'
+type Ajv = _Ajv.default
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+const Ajv = _Ajv.default
+const ajvFormats = _ajvFormats.default
-const moduleName = 'OCPPRequestService';
+const moduleName = 'OCPPRequestService'
const defaultRequestParams: RequestParams = {
skipBufferingOnError: false,
triggerMessage: false,
- throwError: 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;
- private readonly jsonValidateFunctions: Map<RequestCommand, ValidateFunction<JsonType>>;
- protected abstract jsonSchemas: Map<RequestCommand, JSONSchemaType<JsonType>>;
+ private static instance: OCPPRequestService | null = null
+ private readonly version: OCPPVersion
+ private readonly ocppResponseService: OCPPResponseService
+ protected readonly ajv: Ajv
+ protected abstract payloadValidateFunctions: Map<RequestCommand, ValidateFunction<JsonType>>
- protected constructor(version: OCPPVersion, ocppResponseService: OCPPResponseService) {
- this.version = version;
+ protected constructor (version: OCPPVersion, ocppResponseService: OCPPResponseService) {
+ this.version = version
this.ajv = new Ajv({
keywords: ['javaType'],
- multipleOfPrecision: 2,
- });
- ajvFormats(this.ajv);
- this.jsonValidateFunctions = new Map<RequestCommand, ValidateFunction<JsonType>>();
- 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<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,
- ) => 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;
+ multipleOfPrecision: 2
+ })
+ ajvFormats(this.ajv)
+ this.ocppResponseService = ocppResponseService
+ 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<T extends OCPPRequestService>(
this: new (ocppResponseService: OCPPResponseService) => T,
- ocppResponseService: OCPPResponseService,
+ ocppResponseService: OCPPResponseService
): T {
if (OCPPRequestService.instance === null) {
- OCPPRequestService.instance = new this(ocppResponseService);
+ OCPPRequestService.instance = new this(ocppResponseService)
}
- return OCPPRequestService.instance as T;
+ return OCPPRequestService.instance as T
}
- public async sendResponse(
+ public async sendResponse (
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) {
handleSendMessageError(chargingStation, commandName, error as Error, {
- throwError: true,
- });
- return null;
+ throwError: true
+ })
+ return null
}
}
- public async sendError(
+ public async sendError (
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) {
- handleSendMessageError(chargingStation, commandName, error as Error);
- return null;
+ handleSendMessageError(chargingStation, commandName, error as Error)
+ return null
}
}
- protected async sendMessage(
+ protected async sendMessage (
chargingStation: ChargingStation,
messageId: string,
messagePayload: JsonType,
commandName: RequestCommand,
- params?: RequestParams,
+ params?: RequestParams
): Promise<ResponseType> {
params = {
...defaultRequestParams,
- ...params,
- };
+ ...params
+ }
try {
return await this.internalSendMessage(
chargingStation,
messagePayload,
MessageType.CALL_MESSAGE,
commandName,
- params,
- );
+ params
+ )
} catch (error) {
handleSendMessageError(chargingStation, commandName, error as Error, {
- throwError: params.throwError,
- });
- return null;
+ throwError: params.throwError
+ })
+ return null
}
}
private validateRequestPayload<T extends JsonType>(
chargingStation: ChargingStation,
commandName: RequestCommand | IncomingRequestCommand,
- payload: T,
+ payload: T
): boolean {
if (chargingStation.stationInfo?.ocppStrictCompliance === false) {
- return true;
+ return true
}
- if (this.jsonSchemas.has(commandName as RequestCommand) === false) {
+ if (!this.payloadValidateFunctions.has(commandName as RequestCommand)) {
logger.warn(
- `${chargingStation.logPrefix()} ${moduleName}.validateRequestPayload: No JSON schema found for command '${commandName}' PDU validation`,
- );
- return true;
+ `${chargingStation.logPrefix()} ${moduleName}.validateRequestPayload: No JSON schema found for command '${commandName}' PDU validation`
+ )
+ return true
}
- const validate = this.getJsonRequestValidateFunction<T>(commandName as RequestCommand);
- payload = cloneObject<T>(payload);
- OCPPServiceUtils.convertDateToISOString<T>(payload);
- if (validate(payload)) {
- return true;
+ const validate = this.payloadValidateFunctions.get(commandName as RequestCommand)
+ payload = clone<T>(payload)
+ OCPPServiceUtils.convertDateToISOString<T>(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),
- );
- }
-
- private getJsonRequestValidateFunction<T extends JsonType>(commandName: RequestCommand) {
- if (this.jsonValidateFunctions.has(commandName) === false) {
- this.jsonValidateFunctions.set(
- commandName,
- this.ajv.compile<T>(this.jsonSchemas.get(commandName)!).bind(this),
- );
- }
- return this.jsonValidateFunctions.get(commandName)!;
+ JSON.stringify(validate?.errors, undefined, 2)
+ )
}
private validateIncomingRequestResponsePayload<T extends JsonType>(
chargingStation: ChargingStation,
commandName: RequestCommand | IncomingRequestCommand,
- payload: T,
+ payload: T
): boolean {
if (chargingStation.stationInfo?.ocppStrictCompliance === false) {
- return true;
+ return true
}
if (
- this.ocppResponseService.jsonIncomingRequestResponseSchemas.has(
- commandName as IncomingRequestCommand,
- ) === false
+ !this.ocppResponseService.incomingRequestResponsePayloadValidateFunctions.has(
+ commandName as IncomingRequestCommand
+ )
) {
logger.warn(
- `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: No JSON schema found for command '${commandName}' PDU validation`,
- );
- return true;
+ `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: No JSON schema validation function found for command '${commandName}' PDU validation`
+ )
+ return true
}
- const validate = this.getJsonRequestResponseValidateFunction<T>(
- commandName as IncomingRequestCommand,
- );
- payload = cloneObject<T>(payload);
- OCPPServiceUtils.convertDateToISOString<T>(payload);
- if (validate(payload)) {
- return true;
+ const validate = this.ocppResponseService.incomingRequestResponsePayloadValidateFunctions.get(
+ commandName as IncomingRequestCommand
+ )
+ payload = clone<T>(payload)
+ OCPPServiceUtils.convertDateToISOString<T>(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<T extends JsonType>(
- commandName: IncomingRequestCommand,
- ) {
- if (
- this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.has(commandName) ===
- false
- ) {
- this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.set(
- commandName,
- this.ajv
- .compile<T>(this.ocppResponseService.jsonIncomingRequestResponseSchemas.get(commandName)!)
- .bind(this),
- );
- }
- return this.ocppResponseService.jsonIncomingRequestResponseValidateFunctions.get(commandName)!;
- }
-
- private async internalSendMessage(
+ private async internalSendMessage (
chargingStation: ChargingStation,
messageId: string,
messagePayload: JsonType | OCPPError,
messageType: MessageType,
commandName: RequestCommand | IncomingRequestCommand,
- params?: RequestParams,
+ params?: RequestParams
): Promise<ResponseType> {
params = {
...defaultRequestParams,
- ...params,
- };
+ ...params
+ }
if (
- (chargingStation.inUnknownState() === true &&
- commandName === RequestCommand.BOOT_NOTIFICATION) ||
+ (chargingStation.inUnknownState() && commandName === RequestCommand.BOOT_NOTIFICATION) ||
(chargingStation.stationInfo?.ocppStrictCompliance === false &&
- chargingStation.inUnknownState() === true) ||
- chargingStation.inAcceptedState() === true ||
- (chargingStation.inPendingState() === true &&
+ chargingStation.inUnknownState()) ||
+ chargingStation.inAcceptedState() ||
+ (chargingStation.inPendingState() &&
(params.triggerMessage === true || messageType === MessageType.CALL_RESULT_MESSAGE))
) {
// eslint-disable-next-line @typescript-eslint/no-this-alias
- const self = this;
+ const self = this
// Send a message through wsConnection
- return new Promise<ResponseType>((resolve, reject) => {
+ return await new Promise<ResponseType>((resolve, reject: (reason?: unknown) => void) => {
/**
* Function that will receive the request's response
*
if (chargingStation.stationInfo?.enableStatistics === true) {
chargingStation.performanceStatistics?.addRequestStatistic(
commandName,
- MessageType.CALL_RESULT_MESSAGE,
- );
+ MessageType.CALL_RESULT_MESSAGE
+ )
}
// Handle the request's response
self.ocppResponseService
chargingStation,
commandName as RequestCommand,
payload,
- requestPayload,
+ requestPayload
)
.then(() => {
- resolve(payload);
+ resolve(payload)
})
.catch(reject)
.finally(() => {
- chargingStation.requests.delete(messageId);
- chargingStation.emit(ChargingStationEvents.updated);
- });
- };
+ chargingStation.requests.delete(messageId)
+ chargingStation.emit(ChargingStationEvents.updated)
+ })
+ }
/**
* Function that will receive the request's error response
* @param requestStatistic -
*/
const errorCallback = (ocppError: OCPPError, requestStatistic = true): void => {
- if (requestStatistic === true && chargingStation.stationInfo?.enableStatistics === true) {
+ if (requestStatistic && chargingStation.stationInfo?.enableStatistics === true) {
chargingStation.performanceStatistics?.addRequestStatistic(
commandName,
- MessageType.CALL_ERROR_MESSAGE,
- );
+ MessageType.CALL_ERROR_MESSAGE
+ )
}
logger.error(
`${chargingStation.logPrefix()} Error occurred at ${OCPPServiceUtils.getMessageTypeString(
- messageType,
+ messageType
)} command ${commandName} with PDU %j:`,
messagePayload,
- ocppError,
- );
- chargingStation.requests.delete(messageId);
- chargingStation.emit(ChargingStationEvents.updated);
- reject(ocppError);
- };
+ ocppError
+ )
+ chargingStation.requests.delete(messageId)
+ chargingStation.emit(ChargingStationEvents.updated)
+ reject(ocppError)
+ }
const handleSendError = (ocppError: OCPPError): void => {
- if (params?.skipBufferingOnError === false) {
+ if (params.skipBufferingOnError === false) {
// Buffer
- chargingStation.bufferMessage(messageToSend);
+ chargingStation.bufferMessage(messageToSend)
if (messageType === MessageType.CALL_MESSAGE) {
- this.cacheRequestPromise(
+ this.setCachedRequest(
chargingStation,
messageId,
messagePayload as JsonType,
commandName,
responseCallback,
- errorCallback,
- );
+ errorCallback
+ )
}
} else if (
- params?.skipBufferingOnError === true &&
+ params.skipBufferingOnError === true &&
messageType === MessageType.CALL_MESSAGE
) {
// Remove request from the cache
- chargingStation.requests.delete(messageId);
+ chargingStation.requests.delete(messageId)
}
- return reject(ocppError);
- };
+ reject(ocppError)
+ }
if (chargingStation.stationInfo?.enableStatistics === true) {
- chargingStation.performanceStatistics?.addRequestStatistic(commandName, messageType);
+ chargingStation.performanceStatistics?.addRequestStatistic(commandName, messageType)
}
const messageToSend = this.buildMessageToSend(
chargingStation,
messageId,
messagePayload,
messageType,
- commandName,
- );
+ commandName
+ )
// Check if wsConnection opened
- if (chargingStation.isWebSocketConnectionOpened() === true) {
- const beginId = PerformanceStatistics.beginMeasure(commandName);
+ if (chargingStation.isWebSocketConnectionOpened()) {
+ const beginId = PerformanceStatistics.beginMeasure(commandName)
const sendTimeout = setTimeout(() => {
- return handleSendError(
+ handleSendError(
new OCPPError(
ErrorType.GENERIC_ERROR,
`Timeout ${formatDurationMilliSeconds(
- OCPPConstants.OCPP_WEBSOCKET_TIMEOUT,
+ OCPPConstants.OCPP_WEBSOCKET_TIMEOUT
)} reached for ${
- params?.skipBufferingOnError === false ? '' : 'non '
+ params.skipBufferingOnError === false ? '' : 'non '
}buffered message id '${messageId}' with content '${messageToSend}'`,
commandName,
- (messagePayload as OCPPError).details,
- ),
- );
- }, OCPPConstants.OCPP_WEBSOCKET_TIMEOUT);
+ (messagePayload as OCPPError).details
+ )
+ )
+ }, OCPPConstants.OCPP_WEBSOCKET_TIMEOUT)
chargingStation.wsConnection?.send(messageToSend, (error?: Error) => {
- PerformanceStatistics.endMeasure(commandName, beginId);
- clearTimeout(sendTimeout);
- if (isNullOrUndefined(error)) {
+ PerformanceStatistics.endMeasure(commandName, beginId)
+ clearTimeout(sendTimeout)
+ if (error == null) {
logger.debug(
`${chargingStation.logPrefix()} >> Command '${commandName}' sent ${OCPPServiceUtils.getMessageTypeString(
- messageType,
- )} payload: ${messageToSend}`,
- );
+ messageType
+ )} payload: ${messageToSend}`
+ )
if (messageType === MessageType.CALL_MESSAGE) {
- this.cacheRequestPromise(
+ this.setCachedRequest(
chargingStation,
messageId,
messagePayload as JsonType,
commandName,
responseCallback,
- errorCallback,
- );
+ errorCallback
+ )
} else {
// Resolve response
- return resolve(messagePayload);
+ resolve(messagePayload)
}
- } else if (error) {
- return handleSendError(
+ } else {
+ handleSendError(
new OCPPError(
ErrorType.GENERIC_ERROR,
`WebSocket errored for ${
- params?.skipBufferingOnError === false ? '' : 'non '
+ params.skipBufferingOnError === false ? '' : 'non '
}buffered message id '${messageId}' with content '${messageToSend}'`,
commandName,
- { name: error.name, message: error.message, stack: error.stack },
- ),
- );
+ { name: error.name, message: error.message, stack: error.stack }
+ )
+ )
}
- });
+ })
} else {
- return handleSendError(
+ handleSendError(
new OCPPError(
ErrorType.GENERIC_ERROR,
`WebSocket closed for ${
- params?.skipBufferingOnError === false ? '' : 'non '
+ params.skipBufferingOnError === false ? '' : 'non '
}buffered message id '${messageId}' with content '${messageToSend}'`,
commandName,
- (messagePayload as OCPPError).details,
- ),
- );
+ (messagePayload as OCPPError).details
+ )
+ )
}
- });
+ })
}
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,
- );
+ `Cannot send command ${commandName} PDU when the charging station is in ${chargingStation.bootNotificationResponse?.status} state on the central server`,
+ commandName
+ )
}
- private buildMessageToSend(
+ private buildMessageToSend (
chargingStation: ChargingStation,
messageId: string,
messagePayload: JsonType | OCPPError,
messageType: MessageType,
- commandName: RequestCommand | IncomingRequestCommand,
+ commandName: RequestCommand | IncomingRequestCommand
): string {
- let messageToSend: string;
+ let messageToSend: string
// Type of message
switch (messageType) {
// Request
case MessageType.CALL_MESSAGE:
// Build request
- this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonType);
+ this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonType)
messageToSend = JSON.stringify([
messageType,
messageId,
- commandName,
- messagePayload,
- ] as OutgoingRequest);
- break;
+ commandName as RequestCommand,
+ messagePayload as JsonType
+ ] satisfies OutgoingRequest)
+ break
// Response
case MessageType.CALL_RESULT_MESSAGE:
// Build response
this.validateIncomingRequestResponsePayload(
chargingStation,
commandName,
- messagePayload as JsonType,
- );
- messageToSend = JSON.stringify([messageType, messageId, messagePayload] as Response);
- break;
+ messagePayload as JsonType
+ )
+ messageToSend = JSON.stringify([
+ messageType,
+ messageId,
+ messagePayload as JsonType
+ ] satisfies Response)
+ break
// Error Message
case MessageType.CALL_ERROR_MESSAGE:
// Build Error Message
(messagePayload as OCPPError).code,
(messagePayload as OCPPError).message,
(messagePayload as OCPPError).details ?? {
- command: (messagePayload as OCPPError).command ?? commandName,
- },
- ] as ErrorResponse);
- break;
+ command: (messagePayload as OCPPError).command
+ }
+ ] satisfies ErrorResponse)
+ break
}
- return messageToSend;
+ return messageToSend
}
- private cacheRequestPromise(
+ private setCachedRequest (
chargingStation: ChargingStation,
messageId: string,
messagePayload: JsonType,
commandName: RequestCommand | IncomingRequestCommand,
responseCallback: ResponseCallback,
- errorCallback: ErrorCallback,
+ errorCallback: ErrorCallback
): void {
chargingStation.requests.set(messageId, [
responseCallback,
errorCallback,
commandName,
- messagePayload,
- ]);
+ messagePayload
+ ])
}
- // 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,
- ): Promise<ResType>;
+ commandParams?: ReqType,
+ params?: RequestParams
+ ): Promise<ResType>
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff