src/charging-station/ocpp/OCPPIncomingRequestService.ts

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