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, ChargingStationUtils } 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 } 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       chargingStation: ChargingStation,
  38       messageId: string,
  39       commandName: IncomingRequestCommand,
  40       commandPayload: JsonType
  41     ) => Promise<void>;
  42     this.validateIncomingRequestPayload = this.validateIncomingRequestPayload.bind(this) as <
  43       T extends JsonType
  44     >(
  45       chargingStation: ChargingStation,
  46       commandName: IncomingRequestCommand,
  47       schema: JSONSchemaType<T>,
  48       payload: T
  49     ) => boolean;
  50   }
  51
  52   public static getInstance<T extends OCPPIncomingRequestService>(this: new () => T): T {
  53     if (OCPPIncomingRequestService.instance === null) {
  54       OCPPIncomingRequestService.instance = new this();
  55     }
  56     return OCPPIncomingRequestService.instance as T;
  57   }
  58
  59   protected handleIncomingRequestError<T>(
  60     chargingStation: ChargingStation,
  61     commandName: IncomingRequestCommand,
  62     error: Error,
  63     params: HandleErrorParams<T> = { throwError: true }
  64   ): T | undefined {
  65     logger.error(
  66       `${chargingStation.logPrefix()} ${moduleName}.handleIncomingRequestError: Incoming request command '${commandName}' error:`,
  67       error
  68     );
  69     if (!params?.throwError && params?.errorResponse) {
  70       return params?.errorResponse;
  71     }
  72     if (params?.throwError && !params?.errorResponse) {
  73       throw error;
  74     }
  75     if (params?.throwError && params?.errorResponse) {
  76       return params?.errorResponse;
  77     }
  78   }
  79
  80   protected validateIncomingRequestPayload<T extends JsonType>(
  81     chargingStation: ChargingStation,
  82     commandName: IncomingRequestCommand,
  83     schema: JSONSchemaType<T>,
  84     payload: T
  85   ): boolean {
  86     if (chargingStation.getPayloadSchemaValidation() === false) {
  87       return true;
  88     }
  89     const validate = this.ajv.compile(schema);
  90     if (validate(payload)) {
  91       return true;
  92     }
  93     logger.error(
  94       `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestPayload: Command '${commandName}' incoming request PDU is invalid: %j`,
  95       validate.errors
  96     );
  97     throw new OCPPError(
  98       OCPPServiceUtils.ajvErrorsToErrorType(validate.errors),
  99       'Incoming request PDU is invalid',
 100       commandName,
 101       JSON.stringify(validate.errors, null, 2)
 102     );
 103   }
 104
 105   protected handleRequestClearCache(chargingStation: ChargingStation): ClearCacheResponse {
 106     chargingStation.idTagsCache.deleteIdTags(
 107       ChargingStationUtils.getIdTagsFile(chargingStation.stationInfo)
 108     );
 109     return OCPPConstants.OCPP_RESPONSE_ACCEPTED;
 110   }
 111
 112   public abstract incomingRequestHandler(
 113     chargingStation: ChargingStation,
 114     messageId: string,
 115     commandName: IncomingRequestCommand,
 116     commandPayload: JsonType
 117   ): Promise<void>;
 118 }