refactor(simulator): factor out common helpers

[e-mobility-charging-stations-simulator.git] / src / charging-station / ocpp / OCPPRequestService.ts

import Ajv, { type JSONSchemaType } from 'ajv';
import ajvFormats from 'ajv-formats';

import { OCPPConstants } from './OCPPConstants';
import type { OCPPResponseService } from './OCPPResponseService';
import { OCPPServiceUtils } from './OCPPServiceUtils';
import type { ChargingStation } from '../../charging-station';
import { OCPPError } from '../../exception';
import { PerformanceStatistics } from '../../performance';
import {
  type ErrorCallback,
  type ErrorResponse,
  ErrorType,
  type IncomingRequestCommand,
  type JsonObject,
  type JsonType,
  MessageType,
  type OCPPVersion,
  type OutgoingRequest,
  RequestCommand,
  type RequestParams,
  type Response,
  type ResponseCallback,
  type ResponseType,
} from '../../types';
import { Constants, ErrorUtils, Utils, logger } from '../../utils';

const moduleName = 'OCPPRequestService';

export abstract class OCPPRequestService {
  private static instance: OCPPRequestService | null = null;
  private readonly version: OCPPVersion;
  private readonly ajv: Ajv;
  private readonly ocppResponseService: OCPPResponseService;
  protected abstract jsonSchemas: Map<RequestCommand, JSONSchemaType<JsonObject>>;

  protected constructor(version: OCPPVersion, ocppResponseService: OCPPResponseService) {
    this.version = version;
    this.ajv = new Ajv({
      keywords: ['javaType'],
      multipleOfPrecision: 2,
    });
    ajvFormats(this.ajv);
    this.ocppResponseService = ocppResponseService;
    this.requestHandler = this.requestHandler.bind(this) as <
      ReqType extends JsonType,
      ResType extends JsonType
    >(
      chargingStation: ChargingStation,
      commandName: RequestCommand,
      commandParams?: JsonType,
      params?: RequestParams
    ) => Promise<ResType>;
    this.sendMessage = this.sendMessage.bind(this) as (
      chargingStation: ChargingStation,
      messageId: string,
      messagePayload: JsonType,
      commandName: RequestCommand,
      params?: RequestParams
    ) => Promise<ResponseType>;
    this.sendResponse = this.sendResponse.bind(this) as (
      chargingStation: ChargingStation,
      messageId: string,
      messagePayload: JsonType,
      commandName: IncomingRequestCommand
    ) => Promise<ResponseType>;
    this.sendError = this.sendError.bind(this) as (
      chargingStation: ChargingStation,
      messageId: string,
      ocppError: OCPPError,
      commandName: RequestCommand | IncomingRequestCommand
    ) => Promise<ResponseType>;
    this.internalSendMessage = this.internalSendMessage.bind(this) as (
      chargingStation: ChargingStation,
      messageId: string,
      messagePayload: JsonType | OCPPError,
      messageType: MessageType,
      commandName: RequestCommand | IncomingRequestCommand,
      params?: RequestParams
    ) => Promise<ResponseType>;
    this.buildMessageToSend = this.buildMessageToSend.bind(this) as (
      chargingStation: ChargingStation,
      messageId: string,
      messagePayload: JsonType | OCPPError,
      messageType: MessageType,
      commandName: RequestCommand | IncomingRequestCommand,
      responseCallback: ResponseCallback,
      errorCallback: ErrorCallback
    ) => string;
    this.validateRequestPayload = this.validateRequestPayload.bind(this) as <T extends JsonObject>(
      chargingStation: ChargingStation,
      commandName: RequestCommand | IncomingRequestCommand,
      payload: T
    ) => boolean;
    this.validateIncomingRequestResponsePayload = this.validateIncomingRequestResponsePayload.bind(
      this
    ) as <T extends JsonObject>(
      chargingStation: ChargingStation,
      commandName: RequestCommand | IncomingRequestCommand,
      payload: T
    ) => boolean;
  }

  public static getInstance<T extends OCPPRequestService>(
    this: new (ocppResponseService: OCPPResponseService) => T,
    ocppResponseService: OCPPResponseService
  ): T {
    if (OCPPRequestService.instance === null) {
      OCPPRequestService.instance = new this(ocppResponseService);
    }
    return OCPPRequestService.instance as T;
  }

  public async sendResponse(
    chargingStation: ChargingStation,
    messageId: string,
    messagePayload: JsonType,
    commandName: IncomingRequestCommand
  ): Promise<ResponseType> {
    try {
      // Send response message
      return await this.internalSendMessage(
        chargingStation,
        messageId,
        messagePayload,
        MessageType.CALL_RESULT_MESSAGE,
        commandName
      );
    } catch (error) {
      ErrorUtils.handleSendMessageError(chargingStation, commandName, error as Error, {
        throwError: true,
      });
    }
  }

  public async sendError(
    chargingStation: ChargingStation,
    messageId: string,
    ocppError: OCPPError,
    commandName: RequestCommand | IncomingRequestCommand
  ): Promise<ResponseType> {
    try {
      // Send error message
      return await this.internalSendMessage(
        chargingStation,
        messageId,
        ocppError,
        MessageType.CALL_ERROR_MESSAGE,
        commandName
      );
    } catch (error) {
      ErrorUtils.handleSendMessageError(chargingStation, commandName, error as Error);
    }
  }

  protected async sendMessage(
    chargingStation: ChargingStation,
    messageId: string,
    messagePayload: JsonType,
    commandName: RequestCommand,
    params: RequestParams = {
      skipBufferingOnError: false,
      triggerMessage: false,
      throwError: false,
    }
  ): Promise<ResponseType> {
    try {
      return await this.internalSendMessage(
        chargingStation,
        messageId,
        messagePayload,
        MessageType.CALL_MESSAGE,
        commandName,
        params
      );
    } catch (error) {
      ErrorUtils.handleSendMessageError(chargingStation, commandName, error as Error, {
        throwError: params.throwError,
      });
    }
  }

  private validateRequestPayload<T extends JsonObject>(
    chargingStation: ChargingStation,
    commandName: RequestCommand | IncomingRequestCommand,
    payload: T
  ): boolean {
    if (chargingStation.getPayloadSchemaValidation() === false) {
      return true;
    }
    if (this.jsonSchemas.has(commandName as RequestCommand) === false) {
      logger.warn(
        `${chargingStation.logPrefix()} ${moduleName}.validateRequestPayload: No JSON schema found for command '${commandName}' PDU validation`
      );
      return true;
    }
    const validate = this.ajv.compile(this.jsonSchemas.get(commandName as RequestCommand));
    payload = Utils.cloneObject<T>(payload);
    OCPPServiceUtils.convertDateToISOString<T>(payload);
    if (validate(payload)) {
      return true;
    }
    logger.error(
      `${chargingStation.logPrefix()} ${moduleName}.validateRequestPayload: Command '${commandName}' request PDU is invalid: %j`,
      validate.errors
    );
    // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
    throw new OCPPError(
      OCPPServiceUtils.ajvErrorsToErrorType(validate.errors),
      'Request PDU is invalid',
      commandName,
      JSON.stringify(validate.errors, null, 2)
    );
  }

  private validateIncomingRequestResponsePayload<T extends JsonObject>(
    chargingStation: ChargingStation,
    commandName: RequestCommand | IncomingRequestCommand,
    payload: T
  ): boolean {
    if (chargingStation.getPayloadSchemaValidation() === false) {
      return true;
    }
    if (
      this.ocppResponseService.jsonIncomingRequestResponseSchemas.has(
        commandName as IncomingRequestCommand
      ) === false
    ) {
      logger.warn(
        `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: No JSON schema found for command '${commandName}' PDU validation`
      );
      return true;
    }
    const validate = this.ajv.compile(
      this.ocppResponseService.jsonIncomingRequestResponseSchemas.get(
        commandName as IncomingRequestCommand
      )
    );
    payload = Utils.cloneObject<T>(payload);
    OCPPServiceUtils.convertDateToISOString<T>(payload);
    if (validate(payload)) {
      return true;
    }
    logger.error(
      `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: Command '${commandName}' reponse PDU is invalid: %j`,
      validate.errors
    );
    // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
    throw new OCPPError(
      OCPPServiceUtils.ajvErrorsToErrorType(validate.errors),
      'Response PDU is invalid',
      commandName,
      JSON.stringify(validate.errors, null, 2)
    );
  }

  private async internalSendMessage(
    chargingStation: ChargingStation,
    messageId: string,
    messagePayload: JsonType | OCPPError,
    messageType: MessageType,
    commandName: RequestCommand | IncomingRequestCommand,
    params: RequestParams = {
      skipBufferingOnError: false,
      triggerMessage: false,
    }
  ): Promise<ResponseType> {
    if (
      (chargingStation.inUnknownState() === true &&
        commandName === RequestCommand.BOOT_NOTIFICATION) ||
      (chargingStation.getOcppStrictCompliance() === false &&
        chargingStation.inUnknownState() === true) ||
      chargingStation.inAcceptedState() === true ||
      (chargingStation.inPendingState() === true &&
        (params.triggerMessage === true || messageType === MessageType.CALL_RESULT_MESSAGE))
    ) {
      // eslint-disable-next-line @typescript-eslint/no-this-alias
      const self = this;
      // Send a message through wsConnection
      return Utils.promiseWithTimeout(
        new Promise((resolve, reject) => {
          /**
           * Function that will receive the request's response
           *
           * @param payload -
           * @param requestPayload -
           */
          const responseCallback = (payload: JsonType, requestPayload: JsonType): void => {
            if (chargingStation.getEnableStatistics() === true) {
              chargingStation.performanceStatistics?.addRequestStatistic(
                commandName,
                MessageType.CALL_RESULT_MESSAGE
              );
            }
            // Handle the request's response
            self.ocppResponseService
              .responseHandler(
                chargingStation,
                commandName as RequestCommand,
                payload,
                requestPayload
              )
              .then(() => {
                resolve(payload);
              })
              .catch((error) => {
                reject(error);
              })
              .finally(() => {
                chargingStation.requests.delete(messageId);
              });
          };

          /**
           * Function that will receive the request's error response
           *
           * @param error -
           * @param requestStatistic -
           */
          const errorCallback = (error: OCPPError, requestStatistic = true): void => {
            if (requestStatistic === true && chargingStation.getEnableStatistics() === true) {
              chargingStation.performanceStatistics?.addRequestStatistic(
                commandName,
                MessageType.CALL_ERROR_MESSAGE
              );
            }
            logger.error(
              `${chargingStation.logPrefix()} Error occurred at ${OCPPServiceUtils.getMessageTypeString(
                messageType
              )} command ${commandName} with PDU %j:`,
              messagePayload,
              error
            );
            chargingStation.requests.delete(messageId);
            reject(error);
          };

          if (chargingStation.getEnableStatistics() === true) {
            chargingStation.performanceStatistics?.addRequestStatistic(commandName, messageType);
          }
          const messageToSend = this.buildMessageToSend(
            chargingStation,
            messageId,
            messagePayload,
            messageType,
            commandName,
            responseCallback,
            errorCallback
          );
          let sendError = false;
          // Check if wsConnection opened
          const wsOpened = chargingStation.isWebSocketConnectionOpened() === true;
          if (wsOpened) {
            const beginId = PerformanceStatistics.beginMeasure(commandName);
            try {
              chargingStation.wsConnection?.send(messageToSend);
              logger.debug(
                `${chargingStation.logPrefix()} >> Command '${commandName}' sent ${OCPPServiceUtils.getMessageTypeString(
                  messageType
                )} payload: ${messageToSend}`
              );
            } catch (error) {
              logger.error(
                `${chargingStation.logPrefix()} >> Command '${commandName}' failed to send ${OCPPServiceUtils.getMessageTypeString(
                  messageType
                )} payload: ${messageToSend}:`,
                error
              );
              sendError = true;
            }
            PerformanceStatistics.endMeasure(commandName, beginId);
          }
          const wsClosedOrErrored = !wsOpened || sendError === true;
          if (wsClosedOrErrored && params.skipBufferingOnError === false) {
            // Buffer
            chargingStation.bufferMessage(messageToSend);
            // Reject and keep request in the cache
            return reject(
              new OCPPError(
                ErrorType.GENERIC_ERROR,
                `WebSocket closed or errored for buffered message id '${messageId}' with content '${messageToSend}'`,
                commandName,
                (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FREEZED_OBJECT
              )
            );
          } else if (wsClosedOrErrored) {
            const ocppError = new OCPPError(
              ErrorType.GENERIC_ERROR,
              `WebSocket closed or errored for non buffered message id '${messageId}' with content '${messageToSend}'`,
              commandName,
              (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FREEZED_OBJECT
            );
            // Reject response
            if (messageType !== MessageType.CALL_MESSAGE) {
              return reject(ocppError);
            }
            // Reject and remove request from the cache
            return errorCallback(ocppError, false);
          }
          // Resolve response
          if (messageType !== MessageType.CALL_MESSAGE) {
            return resolve(messagePayload);
          }
        }),
        OCPPConstants.OCPP_WEBSOCKET_TIMEOUT,
        new OCPPError(
          ErrorType.GENERIC_ERROR,
          `Timeout for message id '${messageId}'`,
          commandName,
          (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FREEZED_OBJECT
        ),
        () => {
          messageType === MessageType.CALL_MESSAGE && chargingStation.requests.delete(messageId);
        }
      );
    }
    throw new OCPPError(
      ErrorType.SECURITY_ERROR,
      `Cannot send command ${commandName} PDU when the charging station is in ${chargingStation.getRegistrationStatus()} state on the central server`,
      commandName
    );
  }

  private buildMessageToSend(
    chargingStation: ChargingStation,
    messageId: string,
    messagePayload: JsonType | OCPPError,
    messageType: MessageType,
    commandName: RequestCommand | IncomingRequestCommand,
    responseCallback: ResponseCallback,
    errorCallback: ErrorCallback
  ): string {
    let messageToSend: string;
    // Type of message
    switch (messageType) {
      // Request
      case MessageType.CALL_MESSAGE:
        // Build request
        this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonObject);
        chargingStation.requests.set(messageId, [
          responseCallback,
          errorCallback,
          commandName,
          messagePayload as JsonType,
        ]);
        messageToSend = JSON.stringify([
          messageType,
          messageId,
          commandName,
          messagePayload,
        ] as OutgoingRequest);
        break;
      // Response
      case MessageType.CALL_RESULT_MESSAGE:
        // Build response
        this.validateIncomingRequestResponsePayload(
          chargingStation,
          commandName,
          messagePayload as JsonObject
        );
        messageToSend = JSON.stringify([messageType, messageId, messagePayload] as Response);
        break;
      // Error Message
      case MessageType.CALL_ERROR_MESSAGE:
        // Build Error Message
        messageToSend = JSON.stringify([
          messageType,
          messageId,
          (messagePayload as OCPPError)?.code ?? ErrorType.GENERIC_ERROR,
          (messagePayload as OCPPError)?.message ?? '',
          (messagePayload as OCPPError)?.details ?? { commandName },
        ] as ErrorResponse);
        break;
    }
    return messageToSend;
  }

  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  public abstract requestHandler<ReqType extends JsonType, ResType extends JsonType>(
    chargingStation: ChargingStation,
    commandName: RequestCommand,
    commandParams?: JsonType,
    params?: RequestParams
  ): Promise<ResType>;
}