-// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
-import type { JSONSchemaType } from 'ajv'
+import type { ValidateFunction } from 'ajv'
-import { OCPP20ServiceUtils } from './OCPP20ServiceUtils.js'
-import { type ChargingStation, addConfigurationKey } from '../../../charging-station/index.js'
+import { addConfigurationKey, type ChargingStation } from '../../../charging-station/index.js'
import { OCPPError } from '../../../exception/index.js'
import {
+ ChargingStationEvents,
ErrorType,
type JsonType,
type OCPP20BootNotificationResponse,
RegistrationStatusEnumType,
type ResponseHandler
} from '../../../types/index.js'
-import { logger } from '../../../utils/index.js'
+import { isAsyncFunction, logger } from '../../../utils/index.js'
import { OCPPResponseService } from '../OCPPResponseService.js'
+import { OCPP20ServiceUtils } from './OCPP20ServiceUtils.js'
const moduleName = 'OCPP20ResponseService'
export class OCPP20ResponseService extends OCPPResponseService {
- public jsonIncomingRequestResponseSchemas: Map<
+ public incomingRequestResponsePayloadValidateFunctions: Map<
OCPP20IncomingRequestCommand,
- JSONSchemaType<JsonType>
+ ValidateFunction<JsonType>
>
+ protected payloadValidateFunctions: Map<OCPP20RequestCommand, ValidateFunction<JsonType>>
private readonly responseHandlers: Map<OCPP20RequestCommand, ResponseHandler>
- private readonly jsonSchemas: Map<OCPP20RequestCommand, JSONSchemaType<JsonType>>
public constructor () {
- // if (new.target?.name === moduleName) {
- // throw new TypeError(`Cannot construct ${new.target?.name} instances directly`)
+ // if (new.target.name === moduleName) {
+ // throw new TypeError(`Cannot construct ${new.target.name} instances directly`)
// }
- super(OCPPVersion.VERSION_20)
+ super(OCPPVersion.VERSION_201)
this.responseHandlers = new Map<OCPP20RequestCommand, ResponseHandler>([
[
OCPP20RequestCommand.BOOT_NOTIFICATION,
this.handleResponseBootNotification.bind(this) as ResponseHandler
],
- [OCPP20RequestCommand.HEARTBEAT, this.emptyResponseHandler.bind(this) as ResponseHandler],
- [
- OCPP20RequestCommand.STATUS_NOTIFICATION,
- this.emptyResponseHandler.bind(this) as ResponseHandler
- ]
+ [OCPP20RequestCommand.HEARTBEAT, this.emptyResponseHandler],
+ [OCPP20RequestCommand.STATUS_NOTIFICATION, this.emptyResponseHandler]
])
- this.jsonSchemas = new Map<OCPP20RequestCommand, JSONSchemaType<JsonType>>([
+ this.payloadValidateFunctions = new Map<OCPP20RequestCommand, ValidateFunction<JsonType>>([
[
OCPP20RequestCommand.BOOT_NOTIFICATION,
- OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20BootNotificationResponse>(
- 'assets/json-schemas/ocpp/2.0/BootNotificationResponse.json',
- moduleName,
- 'constructor'
- )
+ this.ajv
+ .compile(
+ OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20BootNotificationResponse>(
+ 'assets/json-schemas/ocpp/2.0/BootNotificationResponse.json',
+ moduleName,
+ 'constructor'
+ )
+ )
+ .bind(this)
],
[
OCPP20RequestCommand.HEARTBEAT,
- OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20HeartbeatResponse>(
- 'assets/json-schemas/ocpp/2.0/HeartbeatResponse.json',
- moduleName,
- 'constructor'
- )
+ this.ajv
+ .compile(
+ OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20HeartbeatResponse>(
+ 'assets/json-schemas/ocpp/2.0/HeartbeatResponse.json',
+ moduleName,
+ 'constructor'
+ )
+ )
+ .bind(this)
],
[
OCPP20RequestCommand.STATUS_NOTIFICATION,
- OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20StatusNotificationResponse>(
- 'assets/json-schemas/ocpp/2.0/StatusNotificationResponse.json',
- moduleName,
- 'constructor'
- )
+ this.ajv
+ .compile(
+ OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20StatusNotificationResponse>(
+ 'assets/json-schemas/ocpp/2.0/StatusNotificationResponse.json',
+ moduleName,
+ 'constructor'
+ )
+ )
+ .bind(this)
]
])
- this.jsonIncomingRequestResponseSchemas = new Map([
+ this.incomingRequestResponsePayloadValidateFunctions = new Map<
+ OCPP20IncomingRequestCommand,
+ ValidateFunction<JsonType>
+ >([
[
OCPP20IncomingRequestCommand.CLEAR_CACHE,
- OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20ClearCacheResponse>(
- 'assets/json-schemas/ocpp/2.0/ClearCacheResponse.json',
- moduleName,
- 'constructor'
- )
+ this.ajvIncomingRequest
+ .compile(
+ OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20ClearCacheResponse>(
+ 'assets/json-schemas/ocpp/2.0/ClearCacheResponse.json',
+ moduleName,
+ 'constructor'
+ )
+ )
+ .bind(this)
]
])
- this.validatePayload = this.validatePayload.bind(this) as (
- chargingStation: ChargingStation,
- commandName: OCPP20RequestCommand,
- payload: JsonType
- ) => boolean
+ this.validatePayload = this.validatePayload.bind(this)
}
public async responseHandler<ReqType extends JsonType, ResType extends JsonType>(
try {
this.validatePayload(chargingStation, commandName, payload)
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- await this.responseHandlers.get(commandName)!(chargingStation, payload, requestPayload)
+ const responseHandler = this.responseHandlers.get(commandName)!
+ if (isAsyncFunction(responseHandler)) {
+ await responseHandler(chargingStation, payload, requestPayload)
+ } else {
+ (
+ responseHandler as (
+ chargingStation: ChargingStation,
+ payload: JsonType,
+ requestPayload?: JsonType
+ ) => void
+ )(chargingStation, payload, requestPayload)
+ }
} catch (error) {
logger.error(
`${chargingStation.logPrefix()} ${moduleName}.responseHandler: Handle response error:`,
// Throw exception
throw new OCPPError(
ErrorType.NOT_IMPLEMENTED,
- `${commandName} is not implemented to handle response PDU ${JSON.stringify(
+ `'${commandName}' is not implemented to handle response PDU ${JSON.stringify(
payload,
undefined,
2
payload,
undefined,
2
- )} while the charging station is not registered on the central server.`,
+ )} while the charging station is not registered on the central server`,
commandName,
payload
)
commandName: OCPP20RequestCommand,
payload: JsonType
): boolean {
- if (this.jsonSchemas.has(commandName)) {
- return this.validateResponsePayload(
- chargingStation,
- commandName,
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.jsonSchemas.get(commandName)!,
- payload
- )
+ if (this.payloadValidateFunctions.has(commandName)) {
+ return this.validateResponsePayload(chargingStation, commandName, payload)
}
logger.warn(
- `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command '${commandName}' PDU validation`
+ `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema validation function found for command '${commandName}' PDU validation`
)
return false
}
chargingStation: ChargingStation,
payload: OCPP20BootNotificationResponse
): void {
- if (payload.status === RegistrationStatusEnumType.ACCEPTED) {
- addConfigurationKey(
- chargingStation,
- OCPP20OptionalVariableName.HeartbeatInterval,
- payload.interval.toString(),
- {},
- { overwrite: true, save: true }
- )
- OCPP20ServiceUtils.startHeartbeatInterval(chargingStation, payload.interval)
- }
if (Object.values(RegistrationStatusEnumType).includes(payload.status)) {
+ chargingStation.bootNotificationResponse = payload
+ if (chargingStation.isRegistered()) {
+ chargingStation.emit(ChargingStationEvents.registered)
+ if (chargingStation.inAcceptedState()) {
+ addConfigurationKey(
+ chargingStation,
+ OCPP20OptionalVariableName.HeartbeatInterval,
+ payload.interval.toString(),
+ {},
+ { overwrite: true, save: true }
+ )
+ chargingStation.emit(ChargingStationEvents.accepted)
+ }
+ } else if (chargingStation.inRejectedState()) {
+ chargingStation.emit(ChargingStationEvents.rejected)
+ }
const logMsg = `${chargingStation.logPrefix()} Charging station in '${
payload.status
}' state on the central server`