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

   1 // Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
   2
   3 import type { ValidateFunction } from 'ajv'
   4
   5 import { addConfigurationKey, type ChargingStation } from '../../../charging-station/index.js'
   6 import { OCPPError } from '../../../exception/index.js'
   7 import {
   8   ChargingStationEvents,
   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 { isAsyncFunction, logger } from '../../../utils/index.js'
  23 import { OCPPResponseService } from '../OCPPResponseService.js'
  24 import { OCPP20ServiceUtils } from './OCPP20ServiceUtils.js'
  25
  26 const moduleName = 'OCPP20ResponseService'
  27
  28 export class OCPP20ResponseService extends OCPPResponseService {
  29   protected payloadValidateFunctions: Map<OCPP20RequestCommand, ValidateFunction<JsonType>>
  30   private readonly responseHandlers: Map<OCPP20RequestCommand, ResponseHandler>
  31   public incomingRequestResponsePayloadValidateFunctions: Map<
  32     OCPP20IncomingRequestCommand,
  33     ValidateFunction<JsonType>
  34   >
  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_201)
  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.payloadValidateFunctions = new Map<OCPP20RequestCommand, ValidateFunction<JsonType>>([
  50       [
  51         OCPP20RequestCommand.BOOT_NOTIFICATION,
  52         this.ajv.compile(
  53           OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20BootNotificationResponse>(
  54             'assets/json-schemas/ocpp/2.0/BootNotificationResponse.json',
  55             moduleName,
  56             'constructor'
  57           )
  58         ),
  59       ],
  60       [
  61         OCPP20RequestCommand.HEARTBEAT,
  62         this.ajv.compile(
  63           OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20HeartbeatResponse>(
  64             'assets/json-schemas/ocpp/2.0/HeartbeatResponse.json',
  65             moduleName,
  66             'constructor'
  67           )
  68         ),
  69       ],
  70       [
  71         OCPP20RequestCommand.STATUS_NOTIFICATION,
  72         this.ajv.compile(
  73           OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20StatusNotificationResponse>(
  74             'assets/json-schemas/ocpp/2.0/StatusNotificationResponse.json',
  75             moduleName,
  76             'constructor'
  77           )
  78         ),
  79       ],
  80     ])
  81     this.incomingRequestResponsePayloadValidateFunctions = new Map<
  82       OCPP20IncomingRequestCommand,
  83       ValidateFunction<JsonType>
  84     >([
  85       [
  86         OCPP20IncomingRequestCommand.CLEAR_CACHE,
  87         this.ajvIncomingRequest.compile(
  88           OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20ClearCacheResponse>(
  89             'assets/json-schemas/ocpp/2.0/ClearCacheResponse.json',
  90             moduleName,
  91             'constructor'
  92           )
  93         ),
  94       ],
  95     ])
  96     this.validatePayload = this.validatePayload.bind(this)
  97   }
  98
  99   private handleResponseBootNotification (
 100     chargingStation: ChargingStation,
 101     payload: OCPP20BootNotificationResponse
 102   ): void {
 103     if (Object.values(RegistrationStatusEnumType).includes(payload.status)) {
 104       chargingStation.bootNotificationResponse = payload
 105       if (chargingStation.isRegistered()) {
 106         chargingStation.emit(ChargingStationEvents.registered)
 107         if (chargingStation.inAcceptedState()) {
 108           addConfigurationKey(
 109             chargingStation,
 110             OCPP20OptionalVariableName.HeartbeatInterval,
 111             payload.interval.toString(),
 112             {},
 113             { overwrite: true, save: true }
 114           )
 115           chargingStation.emit(ChargingStationEvents.accepted)
 116         }
 117       } else if (chargingStation.inRejectedState()) {
 118         chargingStation.emit(ChargingStationEvents.rejected)
 119       }
 120       const logMsg = `${chargingStation.logPrefix()} Charging station in '${
 121         payload.status
 122       }' state on the central server`
 123       payload.status === RegistrationStatusEnumType.REJECTED
 124         ? logger.warn(logMsg)
 125         : logger.info(logMsg)
 126     } else {
 127       delete chargingStation.bootNotificationResponse
 128       logger.error(
 129         `${chargingStation.logPrefix()} Charging station boot notification response received: %j with undefined registration status`,
 130         payload
 131       )
 132     }
 133   }
 134
 135   private validatePayload (
 136     chargingStation: ChargingStation,
 137     commandName: OCPP20RequestCommand,
 138     payload: JsonType
 139   ): boolean {
 140     if (this.payloadValidateFunctions.has(commandName)) {
 141       return this.validateResponsePayload(chargingStation, commandName, payload)
 142     }
 143     logger.warn(
 144       `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema validation function found for command '${commandName}' PDU validation`
 145     )
 146     return false
 147   }
 148
 149   // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
 150   public async responseHandler<ReqType extends JsonType, ResType extends JsonType>(
 151     chargingStation: ChargingStation,
 152     commandName: OCPP20RequestCommand,
 153     payload: ResType,
 154     requestPayload: ReqType
 155   ): Promise<void> {
 156     if (chargingStation.isRegistered() || commandName === OCPP20RequestCommand.BOOT_NOTIFICATION) {
 157       if (
 158         this.responseHandlers.has(commandName) &&
 159         OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName)
 160       ) {
 161         try {
 162           this.validatePayload(chargingStation, commandName, payload)
 163           // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 164           const responseHandler = this.responseHandlers.get(commandName)!
 165           if (isAsyncFunction(responseHandler)) {
 166             await responseHandler(chargingStation, payload, requestPayload)
 167           } else {
 168             ;(
 169               responseHandler as (
 170                 chargingStation: ChargingStation,
 171                 payload: JsonType,
 172                 requestPayload?: JsonType
 173               ) => void
 174             )(chargingStation, payload, requestPayload)
 175           }
 176         } catch (error) {
 177           logger.error(
 178             `${chargingStation.logPrefix()} ${moduleName}.responseHandler: Handle response error:`,
 179             error
 180           )
 181           throw error
 182         }
 183       } else {
 184         // Throw exception
 185         throw new OCPPError(
 186           ErrorType.NOT_IMPLEMENTED,
 187           `${commandName} is not implemented to handle response PDU ${JSON.stringify(
 188             payload,
 189             undefined,
 190             2
 191           )}`,
 192           commandName,
 193           payload
 194         )
 195       }
 196     } else {
 197       throw new OCPPError(
 198         ErrorType.SECURITY_ERROR,
 199         `${commandName} cannot be issued to handle response PDU ${JSON.stringify(
 200           payload,
 201           undefined,
 202           2
 203         )} while the charging station is not registered on the central server`,
 204         commandName,
 205         payload
 206       )
 207     }
 208   }
 209 }