-import { ErrorResponse, Response } from '../../types/ocpp/Responses';
+import { JSONSchemaType } from 'ajv';
+import Ajv from 'ajv-draft-04';
+import ajvFormats from 'ajv-formats';
+
+import OCPPError from '../../exception/OCPPError';
+import PerformanceStatistics from '../../performance/PerformanceStatistics';
+import { EmptyObject } from '../../types/EmptyObject';
+import { HandleErrorParams } from '../../types/Error';
+import { JsonObject, JsonType } from '../../types/JsonType';
+import { ErrorType } from '../../types/ocpp/ErrorType';
+import { MessageType } from '../../types/ocpp/MessageType';
import {
IncomingRequestCommand,
OutgoingRequest,
RequestParams,
ResponseType,
} from '../../types/ocpp/Requests';
-
-import type ChargingStation from '../ChargingStation';
+import { ErrorResponse, Response } from '../../types/ocpp/Responses';
import Constants from '../../utils/Constants';
-import { EmptyObject } from '../../types/EmptyObject';
-import { ErrorType } from '../../types/ocpp/ErrorType';
-import { HandleErrorParams } from '../../types/Error';
-import { JsonType } from '../../types/JsonType';
-import { MessageType } from '../../types/ocpp/MessageType';
-import OCPPError from '../../exception/OCPPError';
-import type OCPPResponseService from './OCPPResponseService';
-import PerformanceStatistics from '../../performance/PerformanceStatistics';
-import Utils from '../../utils/Utils';
import logger from '../../utils/Logger';
+import Utils from '../../utils/Utils';
+import type ChargingStation from '../ChargingStation';
+import type OCPPResponseService from './OCPPResponseService';
+
+const moduleName = 'OCPPRequestService';
export default abstract class OCPPRequestService {
- private static readonly instances: Map<string, OCPPRequestService> = new Map<
- string,
- OCPPRequestService
- >();
+ private static instance: OCPPRequestService | null = null;
+ private ajv: Ajv;
- protected readonly chargingStation: ChargingStation;
private readonly ocppResponseService: OCPPResponseService;
- protected constructor(
- chargingStation: ChargingStation,
- ocppResponseService: OCPPResponseService
- ) {
- this.chargingStation = chargingStation;
+ protected constructor(ocppResponseService: OCPPResponseService) {
this.ocppResponseService = ocppResponseService;
this.requestHandler.bind(this);
- this.sendResult.bind(this);
+ this.sendResponse.bind(this);
this.sendError.bind(this);
+ this.ajv = new Ajv();
+ ajvFormats(this.ajv);
}
public static getInstance<T extends OCPPRequestService>(
- this: new (chargingStation: ChargingStation, ocppResponseService: OCPPResponseService) => T,
- chargingStation: ChargingStation,
+ this: new (ocppResponseService: OCPPResponseService) => T,
ocppResponseService: OCPPResponseService
): T {
- if (!OCPPRequestService.instances.has(chargingStation.hashId)) {
- OCPPRequestService.instances.set(
- chargingStation.hashId,
- new this(chargingStation, ocppResponseService)
- );
+ if (!OCPPRequestService.instance) {
+ OCPPRequestService.instance = new this(ocppResponseService);
}
- return OCPPRequestService.instances.get(chargingStation.hashId) as T;
+ return OCPPRequestService.instance as T;
}
- public async sendResult(
+ public async sendResponse(
+ chargingStation: ChargingStation,
messageId: string,
messagePayload: JsonType,
commandName: IncomingRequestCommand
): Promise<ResponseType> {
try {
- // Send result message
+ // Send response message
return await this.internalSendMessage(
+ chargingStation,
messageId,
messagePayload,
MessageType.CALL_RESULT_MESSAGE,
commandName
);
} catch (error) {
- this.handleRequestError(commandName, error as Error);
+ this.handleRequestError(chargingStation, commandName, error as Error);
}
}
public async sendError(
+ chargingStation: ChargingStation,
messageId: string,
ocppError: OCPPError,
commandName: RequestCommand | IncomingRequestCommand
try {
// Send error message
return await this.internalSendMessage(
+ chargingStation,
messageId,
ocppError,
MessageType.CALL_ERROR_MESSAGE,
commandName
);
} catch (error) {
- this.handleRequestError(commandName, error as Error);
+ this.handleRequestError(chargingStation, commandName, error as Error);
}
}
protected async sendMessage(
+ chargingStation: ChargingStation,
messageId: string,
messagePayload: JsonType,
commandName: RequestCommand,
): Promise<ResponseType> {
try {
return await this.internalSendMessage(
+ chargingStation,
messageId,
messagePayload,
MessageType.CALL_MESSAGE,
params
);
} catch (error) {
- this.handleRequestError(commandName, error as Error, { throwError: false });
+ this.handleRequestError(chargingStation, commandName, error as Error, { throwError: false });
}
}
+ protected validateRequestPayload<T extends JsonType>(
+ chargingStation: ChargingStation,
+ commandName: RequestCommand,
+ schema: JSONSchemaType<T>,
+ payload: T
+ ): boolean {
+ if (!chargingStation.getPayloadSchemaValidation()) {
+ return true;
+ }
+ const validate = this.ajv.compile(schema);
+ if (validate(payload)) {
+ return true;
+ }
+ logger.error(
+ `${chargingStation.logPrefix()} ${moduleName}.validateRequestPayload: Request PDU is invalid: %j`,
+ validate.errors
+ );
+ throw new OCPPError(
+ ErrorType.FORMATION_VIOLATION,
+ 'Request PDU is invalid',
+ commandName,
+ JSON.stringify(validate.errors, null, 2)
+ );
+ }
+
private async internalSendMessage(
+ chargingStation: ChargingStation,
messageId: string,
messagePayload: JsonType | OCPPError,
messageType: MessageType,
}
): Promise<ResponseType> {
if (
- (this.chargingStation.isInUnknownState() &&
- commandName === RequestCommand.BOOT_NOTIFICATION) ||
- (!this.chargingStation.getOcppStrictCompliance() &&
- this.chargingStation.isInUnknownState()) ||
- this.chargingStation.isInAcceptedState() ||
- (this.chargingStation.isInPendingState() &&
+ (chargingStation.isInUnknownState() && commandName === RequestCommand.BOOT_NOTIFICATION) ||
+ (!chargingStation.getOcppStrictCompliance() && chargingStation.isInUnknownState()) ||
+ chargingStation.isInAcceptedState() ||
+ (chargingStation.isInPendingState() &&
(params.triggerMessage || messageType === MessageType.CALL_RESULT_MESSAGE))
) {
// eslint-disable-next-line @typescript-eslint/no-this-alias
return Utils.promiseWithTimeout(
new Promise((resolve, reject) => {
const messageToSend = this.buildMessageToSend(
+ chargingStation,
messageId,
messagePayload,
messageType,
commandName,
responseCallback,
- rejectCallback
+ errorCallback
);
- if (this.chargingStation.getEnableStatistics()) {
- this.chargingStation.performanceStatistics.addRequestStatistic(
- commandName,
- messageType
- );
+ if (chargingStation.getEnableStatistics()) {
+ chargingStation.performanceStatistics.addRequestStatistic(commandName, messageType);
}
// Check if wsConnection opened
- if (this.chargingStation.isWebSocketConnectionOpened()) {
+ if (chargingStation.isWebSocketConnectionOpened()) {
// Yes: Send Message
const beginId = PerformanceStatistics.beginMeasure(commandName);
// FIXME: Handle sending error
- this.chargingStation.wsConnection.send(messageToSend);
+ chargingStation.wsConnection.send(messageToSend);
PerformanceStatistics.endMeasure(commandName, beginId);
logger.debug(
- `${this.chargingStation.logPrefix()} >> Command '${commandName}' sent ${this.getMessageTypeString(
+ `${chargingStation.logPrefix()} >> Command '${commandName}' sent ${this.getMessageTypeString(
messageType
)} payload: ${messageToSend}`
);
} else if (!params.skipBufferingOnError) {
// Buffer it
- this.chargingStation.bufferMessage(messageToSend);
+ chargingStation.bufferMessage(messageToSend);
const ocppError = new OCPPError(
ErrorType.GENERIC_ERROR,
`WebSocket closed for buffered message id '${messageId}' with content '${messageToSend}'`,
commandName,
- (messagePayload?.details as JsonType) ?? {}
+ (messagePayload as JsonObject)?.details ?? {}
);
if (messageType === MessageType.CALL_MESSAGE) {
// Reject it but keep the request in the cache
return reject(ocppError);
}
- return rejectCallback(ocppError, false);
+ return errorCallback(ocppError, false);
} else {
// Reject it
- return rejectCallback(
+ return errorCallback(
new OCPPError(
ErrorType.GENERIC_ERROR,
`WebSocket closed for non buffered message id '${messageId}' with content '${messageToSend}'`,
commandName,
- (messagePayload?.details as JsonType) ?? {}
+ (messagePayload as JsonObject)?.details ?? {}
),
false
);
payload: JsonType,
requestPayload: JsonType
): Promise<void> {
- if (self.chargingStation.getEnableStatistics()) {
- self.chargingStation.performanceStatistics.addRequestStatistic(
+ if (chargingStation.getEnableStatistics()) {
+ chargingStation.performanceStatistics.addRequestStatistic(
commandName,
MessageType.CALL_RESULT_MESSAGE
);
// Handle the request's response
try {
await self.ocppResponseService.responseHandler(
+ chargingStation,
commandName as RequestCommand,
payload,
requestPayload
} catch (error) {
reject(error);
} finally {
- self.chargingStation.requests.delete(messageId);
+ chargingStation.requests.delete(messageId);
}
}
* @param error
* @param requestStatistic
*/
- function rejectCallback(error: OCPPError, requestStatistic = true): void {
- if (requestStatistic && self.chargingStation.getEnableStatistics()) {
- self.chargingStation.performanceStatistics.addRequestStatistic(
+ function errorCallback(error: OCPPError, requestStatistic = true): void {
+ if (requestStatistic && chargingStation.getEnableStatistics()) {
+ chargingStation.performanceStatistics.addRequestStatistic(
commandName,
MessageType.CALL_ERROR_MESSAGE
);
}
logger.error(
- `${self.chargingStation.logPrefix()} Error %j occurred when calling command %s with message data %j`,
+ `${chargingStation.logPrefix()} Error %j occurred when calling command %s with message data %j`,
error,
commandName,
messagePayload
);
- self.chargingStation.requests.delete(messageId);
+ chargingStation.requests.delete(messageId);
reject(error);
}
}),
ErrorType.GENERIC_ERROR,
`Timeout for message id '${messageId}'`,
commandName,
- (messagePayload?.details as JsonType) ?? {}
+ (messagePayload as JsonObject)?.details ?? {}
),
() => {
- messageType === MessageType.CALL_MESSAGE &&
- this.chargingStation.requests.delete(messageId);
+ messageType === MessageType.CALL_MESSAGE && chargingStation.requests.delete(messageId);
}
);
}
throw new OCPPError(
ErrorType.SECURITY_ERROR,
- `Cannot send command ${commandName} payload when the charging station is in ${this.chargingStation.getRegistrationStatus()} state on the central server`,
+ `Cannot send command ${commandName} PDU when the charging station is in ${chargingStation.getRegistrationStatus()} state on the central server`,
commandName
);
}
private buildMessageToSend(
+ chargingStation: ChargingStation,
messageId: string,
messagePayload: JsonType | OCPPError,
messageType: MessageType,
commandName?: RequestCommand | IncomingRequestCommand,
responseCallback?: (payload: JsonType, requestPayload: JsonType) => Promise<void>,
- rejectCallback?: (error: OCPPError, requestStatistic?: boolean) => void
+ errorCallback?: (error: OCPPError, requestStatistic?: boolean) => void
): string {
let messageToSend: string;
// Type of message
// Request
case MessageType.CALL_MESSAGE:
// Build request
- this.chargingStation.requests.set(messageId, [
+ chargingStation.requests.set(messageId, [
responseCallback,
- rejectCallback,
+ errorCallback,
commandName,
messagePayload as JsonType,
]);
}
private handleRequestError(
+ chargingStation: ChargingStation,
commandName: RequestCommand | IncomingRequestCommand,
error: Error,
params: HandleErrorParams<EmptyObject> = { throwError: true }
): void {
- logger.error(
- this.chargingStation.logPrefix() + ' Request command %s error: %j',
- commandName,
- error
- );
+ logger.error(chargingStation.logPrefix() + ' Request command %s error: %j', commandName, error);
if (params?.throwError) {
throw error;
}
// eslint-disable-next-line @typescript-eslint/no-unused-vars
public abstract requestHandler<Request extends JsonType, Response extends JsonType>(
+ chargingStation: ChargingStation,
commandName: RequestCommand,
commandParams?: JsonType,
params?: RequestParams
repositories / e-mobility-charging-stations-simulator.git / blobdiff