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