src/charging-station/ocpp/OCPPIncomingRequestService.ts

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