src/charging-station/ocpp/OCPPIncomingRequestService.ts

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