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