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