src/charging-station/ocpp/2.0/OCPP20ResponseService.ts

   1 // Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
   2
   3 import type { JSONSchemaType } from 'ajv'
   4
   5 import { OCPP20ServiceUtils } from './OCPP20ServiceUtils.js'
   6 import { type ChargingStation, addConfigurationKey } from '../../../charging-station/index.js'
   7 import { OCPPError } from '../../../exception/index.js'
   8 import {
   9   ErrorType,
  10   type JsonType,
  11   type OCPP20BootNotificationResponse,
  12   type OCPP20ClearCacheResponse,
  13   type OCPP20HeartbeatResponse,
  14   OCPP20IncomingRequestCommand,
  15   OCPP20OptionalVariableName,
  16   OCPP20RequestCommand,
  17   type OCPP20StatusNotificationResponse,
  18   OCPPVersion,
  19   RegistrationStatusEnumType,
  20   type ResponseHandler
  21 } from '../../../types/index.js'
  22 import { logger } from '../../../utils/index.js'
  23 import { OCPPResponseService } from '../OCPPResponseService.js'
  24
  25 const moduleName = 'OCPP20ResponseService'
  26
  27 export class OCPP20ResponseService extends OCPPResponseService {
  28   public jsonIncomingRequestResponseSchemas: Map<
  29   OCPP20IncomingRequestCommand,
  30   JSONSchemaType<JsonType>
  31   >
  32
  33   private readonly responseHandlers: Map<OCPP20RequestCommand, ResponseHandler>
  34   private readonly jsonSchemas: Map<OCPP20RequestCommand, JSONSchemaType<JsonType>>
  35
  36   public constructor () {
  37     // if (new.target.name === moduleName) {
  38     //   throw new TypeError(`Cannot construct ${new.target.name} instances directly`)
  39     // }
  40     super(OCPPVersion.VERSION_20)
  41     this.responseHandlers = new Map<OCPP20RequestCommand, ResponseHandler>([
  42       [
  43         OCPP20RequestCommand.BOOT_NOTIFICATION,
  44         this.handleResponseBootNotification.bind(this) as ResponseHandler
  45       ],
  46       [OCPP20RequestCommand.HEARTBEAT, this.emptyResponseHandler],
  47       [OCPP20RequestCommand.STATUS_NOTIFICATION, this.emptyResponseHandler]
  48     ])
  49     this.jsonSchemas = new Map<OCPP20RequestCommand, JSONSchemaType<JsonType>>([
  50       [
  51         OCPP20RequestCommand.BOOT_NOTIFICATION,
  52         OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20BootNotificationResponse>(
  53           'assets/json-schemas/ocpp/2.0/BootNotificationResponse.json',
  54           moduleName,
  55           'constructor'
  56         )
  57       ],
  58       [
  59         OCPP20RequestCommand.HEARTBEAT,
  60         OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20HeartbeatResponse>(
  61           'assets/json-schemas/ocpp/2.0/HeartbeatResponse.json',
  62           moduleName,
  63           'constructor'
  64         )
  65       ],
  66       [
  67         OCPP20RequestCommand.STATUS_NOTIFICATION,
  68         OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20StatusNotificationResponse>(
  69           'assets/json-schemas/ocpp/2.0/StatusNotificationResponse.json',
  70           moduleName,
  71           'constructor'
  72         )
  73       ]
  74     ])
  75     this.jsonIncomingRequestResponseSchemas = new Map([
  76       [
  77         OCPP20IncomingRequestCommand.CLEAR_CACHE,
  78         OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20ClearCacheResponse>(
  79           'assets/json-schemas/ocpp/2.0/ClearCacheResponse.json',
  80           moduleName,
  81           'constructor'
  82         )
  83       ]
  84     ])
  85     this.validatePayload = this.validatePayload.bind(this) as (
  86       chargingStation: ChargingStation,
  87       commandName: OCPP20RequestCommand,
  88       payload: JsonType
  89     ) => boolean
  90   }
  91
  92   public async responseHandler<ReqType extends JsonType, ResType extends JsonType>(
  93     chargingStation: ChargingStation,
  94     commandName: OCPP20RequestCommand,
  95     payload: ResType,
  96     requestPayload: ReqType
  97   ): Promise<void> {
  98     if (chargingStation.isRegistered() || commandName === OCPP20RequestCommand.BOOT_NOTIFICATION) {
  99       if (
 100         this.responseHandlers.has(commandName) &&
 101         OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName)
 102       ) {
 103         try {
 104           this.validatePayload(chargingStation, commandName, payload)
 105           // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 106           await this.responseHandlers.get(commandName)!(chargingStation, payload, requestPayload)
 107         } catch (error) {
 108           logger.error(
 109             `${chargingStation.logPrefix()} ${moduleName}.responseHandler: Handle response error:`,
 110             error
 111           )
 112           throw error
 113         }
 114       } else {
 115         // Throw exception
 116         throw new OCPPError(
 117           ErrorType.NOT_IMPLEMENTED,
 118           `${commandName} is not implemented to handle response PDU ${JSON.stringify(
 119             payload,
 120             undefined,
 121             2
 122           )}`,
 123           commandName,
 124           payload
 125         )
 126       }
 127     } else {
 128       throw new OCPPError(
 129         ErrorType.SECURITY_ERROR,
 130         `${commandName} cannot be issued to handle response PDU ${JSON.stringify(
 131           payload,
 132           undefined,
 133           2
 134         )} while the charging station is not registered on the central server.`,
 135         commandName,
 136         payload
 137       )
 138     }
 139   }
 140
 141   private validatePayload (
 142     chargingStation: ChargingStation,
 143     commandName: OCPP20RequestCommand,
 144     payload: JsonType
 145   ): boolean {
 146     if (this.jsonSchemas.has(commandName)) {
 147       return this.validateResponsePayload(
 148         chargingStation,
 149         commandName,
 150         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 151         this.jsonSchemas.get(commandName)!,
 152         payload
 153       )
 154     }
 155     logger.warn(
 156       `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command '${commandName}' PDU validation`
 157     )
 158     return false
 159   }
 160
 161   private handleResponseBootNotification (
 162     chargingStation: ChargingStation,
 163     payload: OCPP20BootNotificationResponse
 164   ): void {
 165     if (payload.status === RegistrationStatusEnumType.ACCEPTED) {
 166       addConfigurationKey(
 167         chargingStation,
 168         OCPP20OptionalVariableName.HeartbeatInterval,
 169         payload.interval.toString(),
 170         {},
 171         { overwrite: true, save: true }
 172       )
 173       OCPP20ServiceUtils.startHeartbeatInterval(chargingStation, payload.interval)
 174     }
 175     if (Object.values(RegistrationStatusEnumType).includes(payload.status)) {
 176       const logMsg = `${chargingStation.logPrefix()} Charging station in '${
 177         payload.status
 178       }' state on the central server`
 179       payload.status === RegistrationStatusEnumType.REJECTED
 180         ? logger.warn(logMsg)
 181         : logger.info(logMsg)
 182     } else {
 183       logger.error(
 184         `${chargingStation.logPrefix()} Charging station boot notification response received: %j with undefined registration status`,
 185         payload
 186       )
 187     }
 188   }
 189 }