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