src/charging-station/ocpp/OCPPIncomingRequestService.ts

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