src/charging-station/ocpp/OCPPIncomingRequestService.ts

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