src/charging-station/ocpp/OCPPIncomingRequestService.ts

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