src/charging-station/ocpp/OCPPIncomingRequestService.ts

   1 import { EventEmitter } from 'node:events'
   2
   3 import _Ajv, { type ValidateFunction } from 'ajv'
   4 import _ajvFormats from 'ajv-formats'
   5
   6 import { type ChargingStation, getIdTagsFile } from '../../charging-station/index.js'
   7 import { OCPPError } from '../../exception/index.js'
   8 import type {
   9   ClearCacheResponse,
  10   HandleErrorParams,
  11   IncomingRequestCommand,
  12   JsonType,
  13   OCPPVersion
  14 } from '../../types/index.js'
  15 import { logger, setDefaultErrorParams } from '../../utils/index.js'
  16 import { OCPPConstants } from './OCPPConstants.js'
  17 import { OCPPServiceUtils } from './OCPPServiceUtils.js'
  18 type Ajv = _Ajv.default
  19 // eslint-disable-next-line @typescript-eslint/no-redeclare
  20 const Ajv = _Ajv.default
  21 const ajvFormats = _ajvFormats.default
  22
  23 const moduleName = 'OCPPIncomingRequestService'
  24
  25 export abstract class OCPPIncomingRequestService extends EventEmitter {
  26   private static instance: OCPPIncomingRequestService | null = null
  27   private readonly version: OCPPVersion
  28   protected readonly ajv: Ajv
  29   protected abstract payloadValidateFunctions: Map<
  30   IncomingRequestCommand,
  31   ValidateFunction<JsonType>
  32   >
  33
  34   protected constructor (version: OCPPVersion) {
  35     super()
  36     this.version = version
  37     this.ajv = new Ajv({
  38       keywords: ['javaType'],
  39       multipleOfPrecision: 2
  40     })
  41     ajvFormats(this.ajv)
  42     this.incomingRequestHandler = this.incomingRequestHandler.bind(this)
  43     this.validateIncomingRequestPayload = this.validateIncomingRequestPayload.bind(this)
  44   }
  45
  46   public static getInstance<T extends OCPPIncomingRequestService>(this: new () => T): T {
  47     if (OCPPIncomingRequestService.instance === null) {
  48       OCPPIncomingRequestService.instance = new this()
  49     }
  50     return OCPPIncomingRequestService.instance as T
  51   }
  52
  53   protected handleIncomingRequestError<T extends JsonType>(
  54     chargingStation: ChargingStation,
  55     commandName: IncomingRequestCommand,
  56     error: Error,
  57     params: HandleErrorParams<T> = { throwError: true, consoleOut: false }
  58   ): T | undefined {
  59     setDefaultErrorParams(params)
  60     logger.error(
  61       `${chargingStation.logPrefix()} ${moduleName}.handleIncomingRequestError: Incoming request command '${commandName}' error:`,
  62       error
  63     )
  64     if (params.throwError === false && params.errorResponse != null) {
  65       return params.errorResponse
  66     }
  67     if (params.throwError === true && params.errorResponse == null) {
  68       throw error
  69     }
  70     if (params.throwError === true && params.errorResponse != null) {
  71       return params.errorResponse
  72     }
  73   }
  74
  75   protected validateIncomingRequestPayload<T extends JsonType>(
  76     chargingStation: ChargingStation,
  77     commandName: IncomingRequestCommand,
  78     payload: T
  79   ): boolean {
  80     if (chargingStation.stationInfo?.ocppStrictCompliance === false) {
  81       return true
  82     }
  83     const validate = this.payloadValidateFunctions.get(commandName)
  84     if (validate?.(payload) === true) {
  85       return true
  86     }
  87     logger.error(
  88       `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestPayload: Command '${commandName}' incoming request PDU is invalid: %j`,
  89       validate?.errors
  90     )
  91     throw new OCPPError(
  92       OCPPServiceUtils.ajvErrorsToErrorType(validate?.errors),
  93       'Incoming request PDU is invalid',
  94       commandName,
  95       JSON.stringify(validate?.errors, undefined, 2)
  96     )
  97   }
  98
  99   protected handleRequestClearCache (chargingStation: ChargingStation): ClearCacheResponse {
 100     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 101     if (chargingStation.idTagsCache.deleteIdTags(getIdTagsFile(chargingStation.stationInfo!)!)) {
 102       return OCPPConstants.OCPP_RESPONSE_ACCEPTED
 103     }
 104     return OCPPConstants.OCPP_RESPONSE_REJECTED
 105   }
 106
 107   // eslint-disable-next-line @typescript-eslint/no-unused-vars
 108   public abstract incomingRequestHandler<ReqType extends JsonType, ResType extends JsonType>(
 109     chargingStation: ChargingStation,
 110     messageId: string,
 111     commandName: IncomingRequestCommand,
 112     commandPayload: ReqType
 113   ): Promise<void>
 114 }