src/charging-station/ocpp/OCPPIncomingRequestService.ts

   1 import { AsyncResource } from 'async_hooks';
   2
   3 import Ajv, { type JSONSchemaType } from 'ajv';
   4 import AjvDraft04 from 'ajv-draft-04';
   5 import ajvFormats from 'ajv-formats';
   6
   7 import OCPPError from '../../exception/OCPPError';
   8 import type { HandleErrorParams } from '../../types/Error';
   9 import type { JsonType } from '../../types/JsonType';
  10 import { OCPPVersion } from '../../types/ocpp/OCPPVersion';
  11 import type { IncomingRequestCommand } from '../../types/ocpp/Requests';
  12 import logger from '../../utils/Logger';
  13 import type ChargingStation from '../ChargingStation';
  14 import { OCPPServiceUtils } from './OCPPServiceUtils';
  15
  16 const moduleName = 'OCPPIncomingRequestService';
  17
  18 export default abstract class OCPPIncomingRequestService {
  19   private static instance: OCPPIncomingRequestService | null = null;
  20   protected asyncResource: AsyncResource;
  21   private readonly version: OCPPVersion;
  22   private readonly ajv: Ajv;
  23
  24   protected constructor(version: OCPPVersion) {
  25     this.version = version;
  26     switch (this.version) {
  27       case OCPPVersion.VERSION_16:
  28         this.ajv = new AjvDraft04();
  29         break;
  30       case OCPPVersion.VERSION_20:
  31       case OCPPVersion.VERSION_201:
  32         this.ajv = new Ajv();
  33         break;
  34     }
  35     ajvFormats(this.ajv);
  36     this.asyncResource = new AsyncResource(moduleName);
  37     this.incomingRequestHandler.bind(this);
  38     this.validateIncomingRequestPayload.bind(this);
  39   }
  40
  41   public static getInstance<T extends OCPPIncomingRequestService>(this: new () => T): T {
  42     if (OCPPIncomingRequestService.instance === null) {
  43       OCPPIncomingRequestService.instance = new this();
  44     }
  45     return OCPPIncomingRequestService.instance as T;
  46   }
  47
  48   protected handleIncomingRequestError<T>(
  49     chargingStation: ChargingStation,
  50     commandName: IncomingRequestCommand,
  51     error: Error,
  52     params: HandleErrorParams<T> = { throwError: true }
  53   ): T | undefined {
  54     logger.error(
  55       `${chargingStation.logPrefix()} ${moduleName}.handleIncomingRequestError: Incoming request command '${commandName}' error:`,
  56       error
  57     );
  58     if (!params?.throwError && params?.errorResponse) {
  59       return params?.errorResponse;
  60     }
  61     if (params?.throwError && !params?.errorResponse) {
  62       throw error;
  63     }
  64     if (params?.throwError && params?.errorResponse) {
  65       return params?.errorResponse;
  66     }
  67   }
  68
  69   protected validateIncomingRequestPayload<T extends JsonType>(
  70     chargingStation: ChargingStation,
  71     commandName: IncomingRequestCommand,
  72     schema: JSONSchemaType<T>,
  73     payload: T
  74   ): boolean {
  75     if (chargingStation.getPayloadSchemaValidation() === false) {
  76       return true;
  77     }
  78     const validate = this.ajv.compile(schema);
  79     if (validate(payload)) {
  80       return true;
  81     }
  82     logger.error(
  83       `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestPayload: Incoming request PDU is invalid: %j`,
  84       validate.errors
  85     );
  86     throw new OCPPError(
  87       OCPPServiceUtils.ajvErrorsToErrorType(validate.errors),
  88       'Incoming request PDU is invalid',
  89       commandName,
  90       JSON.stringify(validate.errors, null, 2)
  91     );
  92   }
  93
  94   public abstract incomingRequestHandler(
  95     chargingStation: ChargingStation,
  96     messageId: string,
  97     commandName: IncomingRequestCommand,
  98     commandPayload: JsonType
  99   ): Promise<void>;
 100 }