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