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       multipleOfPrecision: 2,
  27     });
  28     ajvFormats(this.ajv);
  29     this.asyncResource = new AsyncResource(moduleName);
  30     this.incomingRequestHandler.bind(this);
  31     this.validateIncomingRequestPayload.bind(this);
  32   }
  33
  34   public static getInstance<T extends OCPPIncomingRequestService>(this: new () => T): T {
  35     if (OCPPIncomingRequestService.instance === null) {
  36       OCPPIncomingRequestService.instance = new this();
  37     }
  38     return OCPPIncomingRequestService.instance as T;
  39   }
  40
  41   protected handleIncomingRequestError<T>(
  42     chargingStation: ChargingStation,
  43     commandName: IncomingRequestCommand,
  44     error: Error,
  45     params: HandleErrorParams<T> = { throwError: true }
  46   ): T | undefined {
  47     logger.error(
  48       `${chargingStation.logPrefix()} ${moduleName}.handleIncomingRequestError: Incoming request command '${commandName}' error:`,
  49       error
  50     );
  51     if (!params?.throwError && params?.errorResponse) {
  52       return params?.errorResponse;
  53     }
  54     if (params?.throwError && !params?.errorResponse) {
  55       throw error;
  56     }
  57     if (params?.throwError && params?.errorResponse) {
  58       return params?.errorResponse;
  59     }
  60   }
  61
  62   protected validateIncomingRequestPayload<T extends JsonType>(
  63     chargingStation: ChargingStation,
  64     commandName: IncomingRequestCommand,
  65     schema: JSONSchemaType<T>,
  66     payload: T
  67   ): boolean {
  68     if (chargingStation.getPayloadSchemaValidation() === false) {
  69       return true;
  70     }
  71     const validate = this.ajv.compile(schema);
  72     if (validate(payload)) {
  73       return true;
  74     }
  75     logger.error(
  76       `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestPayload: Command '${commandName}' incoming request PDU is invalid: %j`,
  77       validate.errors
  78     );
  79     throw new OCPPError(
  80       OCPPServiceUtils.ajvErrorsToErrorType(validate.errors),
  81       'Incoming request PDU is invalid',
  82       commandName,
  83       JSON.stringify(validate.errors, null, 2)
  84     );
  85   }
  86
  87   public abstract incomingRequestHandler(
  88     chargingStation: ChargingStation,
  89     messageId: string,
  90     commandName: IncomingRequestCommand,
  91     commandPayload: JsonType
  92   ): Promise<void>;
  93 }