Add OCPP commands payload logging in the logs

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

// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.

import {
  OCPP16AuthorizationStatus,
  OCPP16AuthorizeRequest,
  OCPP16AuthorizeResponse,
  OCPP16StartTransactionRequest,
  OCPP16StartTransactionResponse,
  OCPP16StopTransactionRequest,
  OCPP16StopTransactionResponse,
} from '../../../types/ocpp/1.6/Transaction';
import {
  OCPP16BootNotificationRequest,
  OCPP16HeartbeatRequest,
  OCPP16RequestCommand,
  OCPP16StatusNotificationRequest,
} from '../../../types/ocpp/1.6/Requests';
import {
  OCPP16BootNotificationResponse,
  OCPP16HeartbeatResponse,
  OCPP16RegistrationStatus,
  OCPP16StatusNotificationResponse,
} from '../../../types/ocpp/1.6/Responses';
import {
  OCPP16MeterValuesRequest,
  OCPP16MeterValuesResponse,
} from '../../../types/ocpp/1.6/MeterValues';

import type ChargingStation from '../../ChargingStation';
import { ErrorType } from '../../../types/ocpp/ErrorType';
import { JsonType } from '../../../types/JsonType';
import { OCPP16ChargePointErrorCode } from '../../../types/ocpp/1.6/ChargePointErrorCode';
import { OCPP16ChargePointStatus } from '../../../types/ocpp/1.6/ChargePointStatus';
import { OCPP16ServiceUtils } from './OCPP16ServiceUtils';
import { OCPP16StandardParametersKey } from '../../../types/ocpp/1.6/Configuration';
import OCPPError from '../../../exception/OCPPError';
import OCPPResponseService from '../OCPPResponseService';
import { ResponseHandler } from '../../../types/ocpp/Responses';
import Utils from '../../../utils/Utils';
import logger from '../../../utils/Logger';

const moduleName = 'OCPP16ResponseService';

export default class OCPP16ResponseService extends OCPPResponseService {
  private responseHandlers: Map<OCPP16RequestCommand, ResponseHandler>;

  public constructor(chargingStation: ChargingStation) {
    if (new.target?.name === moduleName) {
      throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
    }
    super(chargingStation);
    this.responseHandlers = new Map<OCPP16RequestCommand, ResponseHandler>([
      [OCPP16RequestCommand.BOOT_NOTIFICATION, this.handleResponseBootNotification.bind(this)],
      [OCPP16RequestCommand.HEARTBEAT, this.handleResponseHeartbeat.bind(this)],
      [OCPP16RequestCommand.AUTHORIZE, this.handleResponseAuthorize.bind(this)],
      [OCPP16RequestCommand.START_TRANSACTION, this.handleResponseStartTransaction.bind(this)],
      [OCPP16RequestCommand.STOP_TRANSACTION, this.handleResponseStopTransaction.bind(this)],
      [OCPP16RequestCommand.STATUS_NOTIFICATION, this.handleResponseStatusNotification.bind(this)],
      [OCPP16RequestCommand.METER_VALUES, this.handleResponseMeterValues.bind(this)],
    ]);
  }

  public async handleResponse(
    commandName: OCPP16RequestCommand,
    payload: JsonType | string,
    requestPayload: JsonType
  ): Promise<void> {
    if (
      this.chargingStation.isRegistered() ||
      commandName === OCPP16RequestCommand.BOOT_NOTIFICATION
    ) {
      if (this.responseHandlers.has(commandName)) {
        try {
          await this.responseHandlers.get(commandName)(payload, requestPayload);
        } catch (error) {
          logger.error(
            this.chargingStation.logPrefix() + ' Handle request response error: %j',
            error
          );
          throw error;
        }
      } else {
        // Throw exception
        throw new OCPPError(
          ErrorType.NOT_IMPLEMENTED,
          `${commandName} is not implemented to handle request response payload ${JSON.stringify(
            payload,
            null,
            2
          )}`,
          commandName
        );
      }
    } else {
      throw new OCPPError(
        ErrorType.SECURITY_ERROR,
        `${commandName} cannot be issued to handle request response payload ${JSON.stringify(
          payload,
          null,
          2
        )} while the charging station is not registered on the central server. `,
        commandName
      );
    }
  }

  private handleResponseBootNotification(payload: OCPP16BootNotificationResponse): void {
    if (payload.status === OCPP16RegistrationStatus.ACCEPTED) {
      this.chargingStation.addConfigurationKey(
        OCPP16StandardParametersKey.HeartBeatInterval,
        payload.interval.toString(),
        {},
        { overwrite: true, save: true }
      );
      this.chargingStation.addConfigurationKey(
        OCPP16StandardParametersKey.HeartbeatInterval,
        payload.interval.toString(),
        { visible: false },
        { overwrite: true, save: true }
      );
      this.chargingStation.heartbeatSetInterval
        ? this.chargingStation.restartHeartbeat()
        : this.chargingStation.startHeartbeat();
    }
    if (Object.values(OCPP16RegistrationStatus).includes(payload.status)) {
      const logMsg = `${this.chargingStation.logPrefix()} Charging station in '${
        payload.status
      }' state on the central server`;
      payload.status === OCPP16RegistrationStatus.REJECTED
        ? logger.warn(logMsg)
        : logger.info(logMsg);
    } else {
      logger.error(
        this.chargingStation.logPrefix() +
          ' Charging station boot notification response received: %j with undefined registration status',
        payload
      );
    }
  }

  // eslint-disable-next-line @typescript-eslint/no-empty-function
  private handleResponseHeartbeat(): void {}

  private handleResponseAuthorize(
    payload: OCPP16AuthorizeResponse,
    requestPayload: OCPP16AuthorizeRequest
  ): void {
    let authorizeConnectorId: number;
    for (const connectorId of this.chargingStation.connectors.keys()) {
      if (
        connectorId > 0 &&
        this.chargingStation.getConnectorStatus(connectorId)?.authorizeIdTag ===
          requestPayload.idTag
      ) {
        authorizeConnectorId = connectorId;
        break;
      }
    }
    if (payload.idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED) {
      this.chargingStation.getConnectorStatus(authorizeConnectorId).idTagAuthorized = true;
      logger.debug(
        `${this.chargingStation.logPrefix()} IdTag ${
          requestPayload.idTag
        } authorized on connector ${authorizeConnectorId}`
      );
    } else {
      this.chargingStation.getConnectorStatus(authorizeConnectorId).idTagAuthorized = false;
      delete this.chargingStation.getConnectorStatus(authorizeConnectorId).authorizeIdTag;
      logger.debug(
        `${this.chargingStation.logPrefix()} IdTag ${requestPayload.idTag} refused with status '${
          payload.idTagInfo.status
        }' on connector ${authorizeConnectorId}`
      );
    }
  }

  private async handleResponseStartTransaction(
    payload: OCPP16StartTransactionResponse,
    requestPayload: OCPP16StartTransactionRequest
  ): Promise<void> {
    const connectorId = requestPayload.connectorId;

    let transactionConnectorId: number;
    for (const id of this.chargingStation.connectors.keys()) {
      if (id > 0 && id === connectorId) {
        transactionConnectorId = id;
        break;
      }
    }
    if (!transactionConnectorId) {
      logger.error(
        this.chargingStation.logPrefix() +
          ' Trying to start a transaction on a non existing connector Id ' +
          connectorId.toString()
      );
      return;
    }
    if (
      this.chargingStation.getConnectorStatus(connectorId).transactionRemoteStarted &&
      this.chargingStation.getAuthorizeRemoteTxRequests() &&
      this.chargingStation.getLocalAuthListEnabled() &&
      this.chargingStation.hasAuthorizedTags() &&
      !this.chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized
    ) {
      logger.error(
        this.chargingStation.logPrefix() +
          ' Trying to start a transaction with a not local authorized idTag ' +
          this.chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag +
          ' on connector Id ' +
          connectorId.toString()
      );
      await this.resetConnectorOnStartTransactionError(connectorId);
      return;
    }
    if (
      this.chargingStation.getConnectorStatus(connectorId).transactionRemoteStarted &&
      this.chargingStation.getAuthorizeRemoteTxRequests() &&
      this.chargingStation.getMayAuthorizeAtRemoteStart() &&
      !this.chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized &&
      !this.chargingStation.getConnectorStatus(connectorId).idTagAuthorized
    ) {
      logger.error(
        this.chargingStation.logPrefix() +
          ' Trying to start a transaction with a not authorized idTag ' +
          this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag +
          ' on connector Id ' +
          connectorId.toString()
      );
      await this.resetConnectorOnStartTransactionError(connectorId);
      return;
    }
    if (
      this.chargingStation.getConnectorStatus(connectorId).idTagAuthorized &&
      this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag !== requestPayload.idTag
    ) {
      logger.error(
        this.chargingStation.logPrefix() +
          ' Trying to start a transaction with an idTag ' +
          requestPayload.idTag +
          ' different from the authorize request one ' +
          this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag +
          ' on connector Id ' +
          connectorId.toString()
      );
      await this.resetConnectorOnStartTransactionError(connectorId);
      return;
    }
    if (
      this.chargingStation.getConnectorStatus(connectorId).idTagLocalAuthorized &&
      this.chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag !==
        requestPayload.idTag
    ) {
      logger.error(
        this.chargingStation.logPrefix() +
          ' Trying to start a transaction with an idTag ' +
          requestPayload.idTag +
          ' different from the local authorized one ' +
          this.chargingStation.getConnectorStatus(connectorId).localAuthorizeIdTag +
          ' on connector Id ' +
          connectorId.toString()
      );
      await this.resetConnectorOnStartTransactionError(connectorId);
      return;
    }
    if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted) {
      logger.debug(
        this.chargingStation.logPrefix() +
          ' Trying to start a transaction on an already used connector ' +
          connectorId.toString() +
          ': %j',
        this.chargingStation.getConnectorStatus(connectorId)
      );
      return;
    }
    if (
      this.chargingStation.getConnectorStatus(connectorId)?.status !==
        OCPP16ChargePointStatus.AVAILABLE &&
      this.chargingStation.getConnectorStatus(connectorId)?.status !==
        OCPP16ChargePointStatus.PREPARING
    ) {
      logger.error(
        `${this.chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with status ${
          this.chargingStation.getConnectorStatus(connectorId)?.status
        }`
      );
      return;
    }
    if (!Number.isInteger(payload.transactionId)) {
      logger.warn(
        `${this.chargingStation.logPrefix()} Trying to start a transaction on connector ${connectorId.toString()} with a non integer transaction Id ${
          payload.transactionId
        }, converting to integer`
      );
      payload.transactionId = Utils.convertToInt(payload.transactionId);
    }

    if (payload.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) {
      this.chargingStation.getConnectorStatus(connectorId).transactionStarted = true;
      this.chargingStation.getConnectorStatus(connectorId).transactionId = payload.transactionId;
      this.chargingStation.getConnectorStatus(connectorId).transactionIdTag = requestPayload.idTag;
      this.chargingStation.getConnectorStatus(
        connectorId
      ).transactionEnergyActiveImportRegisterValue = 0;
      this.chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue =
        OCPP16ServiceUtils.buildTransactionBeginMeterValue(
          this.chargingStation,
          connectorId,
          requestPayload.meterStart
        );
      this.chargingStation.getBeginEndMeterValues() &&
        (await this.chargingStation.ocppRequestService.sendMessageHandler<
          OCPP16MeterValuesRequest,
          OCPP16MeterValuesResponse
        >(OCPP16RequestCommand.METER_VALUES, {
          connectorId,
          transactionId: payload.transactionId,
          meterValue:
            this.chargingStation.getConnectorStatus(connectorId).transactionBeginMeterValue,
        }));
      await this.chargingStation.ocppRequestService.sendMessageHandler<
        OCPP16StatusNotificationRequest,
        OCPP16StatusNotificationResponse
      >(OCPP16RequestCommand.STATUS_NOTIFICATION, {
        connectorId,
        status: OCPP16ChargePointStatus.CHARGING,
        errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
      });
      this.chargingStation.getConnectorStatus(connectorId).status =
        OCPP16ChargePointStatus.CHARGING;
      logger.info(
        this.chargingStation.logPrefix() +
          ' Transaction ' +
          payload.transactionId.toString() +
          ' STARTED on ' +
          this.chargingStation.stationInfo.chargingStationId +
          '#' +
          connectorId.toString() +
          ' for idTag ' +
          requestPayload.idTag
      );
      if (this.chargingStation.stationInfo.powerSharedByConnectors) {
        this.chargingStation.stationInfo.powerDivider++;
      }
      const configuredMeterValueSampleInterval = this.chargingStation.getConfigurationKey(
        OCPP16StandardParametersKey.MeterValueSampleInterval
      );
      this.chargingStation.startMeterValues(
        connectorId,
        configuredMeterValueSampleInterval
          ? Utils.convertToInt(configuredMeterValueSampleInterval.value) * 1000
          : 60000
      );
    } else {
      logger.warn(
        this.chargingStation.logPrefix() +
          ' Starting transaction id ' +
          payload.transactionId.toString() +
          " REJECTED with status '" +
          payload?.idTagInfo?.status +
          "', idTag " +
          requestPayload.idTag
      );
      await this.resetConnectorOnStartTransactionError(connectorId);
    }
  }

  private async resetConnectorOnStartTransactionError(connectorId: number): Promise<void> {
    this.chargingStation.resetConnectorStatus(connectorId);
    if (
      this.chargingStation.getConnectorStatus(connectorId).status !==
      OCPP16ChargePointStatus.AVAILABLE
    ) {
      await this.chargingStation.ocppRequestService.sendMessageHandler<
        OCPP16StatusNotificationRequest,
        OCPP16StatusNotificationResponse
      >(OCPP16RequestCommand.STATUS_NOTIFICATION, {
        connectorId,
        status: OCPP16ChargePointStatus.AVAILABLE,
        errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
      });
      this.chargingStation.getConnectorStatus(connectorId).status =
        OCPP16ChargePointStatus.AVAILABLE;
    }
  }

  private async handleResponseStopTransaction(
    payload: OCPP16StopTransactionResponse,
    requestPayload: OCPP16StopTransactionRequest
  ): Promise<void> {
    const transactionConnectorId = this.chargingStation.getConnectorIdByTransactionId(
      requestPayload.transactionId
    );
    if (!transactionConnectorId) {
      logger.error(
        this.chargingStation.logPrefix() +
          ' Trying to stop a non existing transaction ' +
          requestPayload.transactionId.toString()
      );
      return;
    }
    if (payload.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) {
      this.chargingStation.getBeginEndMeterValues() &&
        !this.chargingStation.getOcppStrictCompliance() &&
        this.chargingStation.getOutOfOrderEndMeterValues() &&
        (await this.chargingStation.ocppRequestService.sendMessageHandler<
          OCPP16MeterValuesRequest,
          OCPP16MeterValuesResponse
        >(OCPP16RequestCommand.METER_VALUES, {
          connectorId: transactionConnectorId,
          transactionId: requestPayload.transactionId,
          meterValue: OCPP16ServiceUtils.buildTransactionEndMeterValue(
            this.chargingStation,
            transactionConnectorId,
            requestPayload.meterStop
          ),
        }));
      if (
        !this.chargingStation.isChargingStationAvailable() ||
        !this.chargingStation.isConnectorAvailable(transactionConnectorId)
      ) {
        await this.chargingStation.ocppRequestService.sendMessageHandler<
          OCPP16StatusNotificationRequest,
          OCPP16StatusNotificationResponse
        >(OCPP16RequestCommand.STATUS_NOTIFICATION, {
          connectorId: transactionConnectorId,
          status: OCPP16ChargePointStatus.UNAVAILABLE,
          errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
        });
        this.chargingStation.getConnectorStatus(transactionConnectorId).status =
          OCPP16ChargePointStatus.UNAVAILABLE;
      } else {
        await this.chargingStation.ocppRequestService.sendMessageHandler<
          OCPP16BootNotificationRequest,
          OCPP16BootNotificationResponse
        >(OCPP16RequestCommand.STATUS_NOTIFICATION, {
          connectorId: transactionConnectorId,
          status: OCPP16ChargePointStatus.AVAILABLE,
          errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
        });
        this.chargingStation.getConnectorStatus(transactionConnectorId).status =
          OCPP16ChargePointStatus.AVAILABLE;
      }
      if (this.chargingStation.stationInfo.powerSharedByConnectors) {
        this.chargingStation.stationInfo.powerDivider--;
      }
      logger.info(
        this.chargingStation.logPrefix() +
          ' Transaction ' +
          requestPayload.transactionId.toString() +
          ' STOPPED on ' +
          this.chargingStation.stationInfo.chargingStationId +
          '#' +
          transactionConnectorId.toString()
      );
      this.chargingStation.resetConnectorStatus(transactionConnectorId);
    } else {
      logger.warn(
        this.chargingStation.logPrefix() +
          ' Stopping transaction id ' +
          requestPayload.transactionId.toString() +
          " REJECTED with status '" +
          payload.idTagInfo?.status +
          "'"
      );
    }
  }

  // eslint-disable-next-line @typescript-eslint/no-empty-function
  private handleResponseStatusNotification(): void {}

  // eslint-disable-next-line @typescript-eslint/no-empty-function
  private handleResponseMeterValues(): void {}
}