src/charging-station/ocpp/OCPPRequestService.ts

   1 import { AuthorizeResponse, StartTransactionResponse, StopTransactionReason, StopTransactionResponse } from '../../types/ocpp/Transaction';
   2 import { DiagnosticsStatus, IncomingRequestCommand, RequestCommand } from '../../types/ocpp/Requests';
   3
   4 import { BootNotificationResponse } from '../../types/ocpp/Responses';
   5 import { ChargePointErrorCode } from '../../types/ocpp/ChargePointErrorCode';
   6 import { ChargePointStatus } from '../../types/ocpp/ChargePointStatus';
   7 import ChargingStation from '../ChargingStation';
   8 import Constants from '../../utils/Constants';
   9 import { ErrorType } from '../../types/ocpp/ErrorType';
  10 import { MessageType } from '../../types/ocpp/MessageType';
  11 import { MeterValue } from '../../types/ocpp/MeterValues';
  12 import OCPPError from './OCPPError';
  13 import OCPPResponseService from './OCPPResponseService';
  14 import PerformanceStatistics from '../../performance/PerformanceStatistics';
  15 import logger from '../../utils/Logger';
  16
  17 export default abstract class OCPPRequestService {
  18   public chargingStation: ChargingStation;
  19   protected ocppResponseService: OCPPResponseService;
  20
  21   constructor(chargingStation: ChargingStation, ocppResponseService: OCPPResponseService) {
  22     this.chargingStation = chargingStation;
  23     this.ocppResponseService = ocppResponseService;
  24   }
  25
  26   public async sendMessage(messageId: string, commandParams: any, messageType: MessageType, commandName: RequestCommand | IncomingRequestCommand,
  27       skipBufferingOnError = false): Promise<unknown> {
  28     // eslint-disable-next-line @typescript-eslint/no-this-alias
  29     const self = this;
  30     // Send a message through wsConnection
  31     return new Promise((resolve, reject) => {
  32       const messageToSend = this.buildMessageToSend(messageId, commandParams, messageType, commandName, responseCallback, rejectCallback);
  33       if (this.chargingStation.getEnableStatistics()) {
  34         this.chargingStation.performanceStatistics.addRequestStatistic(commandName, messageType);
  35       }
  36       // Check if wsConnection opened
  37       if (this.chargingStation.isWebSocketConnectionOpened()) {
  38         // Yes: Send Message
  39         const beginId = PerformanceStatistics.beginMeasure(commandName);
  40         this.chargingStation.wsConnection.send(messageToSend);
  41         PerformanceStatistics.endMeasure(commandName, beginId);
  42       } else if (!skipBufferingOnError) {
  43         // Buffer it
  44         this.chargingStation.addToMessageQueue(messageToSend);
  45         // Reject it but keep the request in the cache
  46         reject(new OCPPError(commandParams?.code ?? ErrorType.GENERIC_ERROR, commandParams?.message ?? `WebSocket closed for message id '${messageId}' with content '${messageToSend}', message buffered`, commandParams?.details ?? {}));
  47       }
  48       // Response?
  49       if (messageType === MessageType.CALL_RESULT_MESSAGE) {
  50         // Yes: send Ok
  51         resolve(commandName);
  52       } else {
  53         // Send timeout
  54         setTimeout(() => rejectCallback(new OCPPError(commandParams?.code ?? ErrorType.GENERIC_ERROR, commandParams?.message ?? `Timeout for message id '${messageId}' with content '${messageToSend}'`, commandParams?.details ?? {})), Constants.OCPP_SOCKET_TIMEOUT);
  55       }
  56
  57       /**
  58        * Function that will receive the request's response
  59        *
  60        * @param payload
  61        * @param requestPayload
  62        */
  63       async function responseCallback(payload: Record<string, unknown> | string, requestPayload: Record<string, unknown>): Promise<void> {
  64         if (self.chargingStation.getEnableStatistics()) {
  65           self.chargingStation.performanceStatistics.addRequestStatistic(commandName, MessageType.CALL_RESULT_MESSAGE);
  66         }
  67         // Send the response
  68         await self.ocppResponseService.handleResponse(commandName as RequestCommand, payload, requestPayload);
  69         self.chargingStation.requests.delete(messageId);
  70         resolve(payload);
  71       }
  72
  73       /**
  74        * Function that will receive the request's error response
  75        *
  76        * @param error
  77        */
  78       function rejectCallback(error: OCPPError): void {
  79         if (self.chargingStation.getEnableStatistics()) {
  80           self.chargingStation.performanceStatistics.addRequestStatistic(commandName, MessageType.CALL_ERROR_MESSAGE);
  81         }
  82         logger.debug(`${self.chargingStation.logPrefix()} Error %j occurred when calling command %s with parameters %j`, error, commandName, commandParams);
  83         self.chargingStation.requests.delete(messageId);
  84         reject(error);
  85       }
  86     });
  87   }
  88
  89   protected handleRequestError(commandName: RequestCommand, error: Error): void {
  90     logger.error(this.chargingStation.logPrefix() + ' Request command ' + commandName + ' error: %j', error);
  91     throw error;
  92   }
  93
  94   private buildMessageToSend(messageId: string, commandParams: any, messageType: MessageType, commandName: RequestCommand | IncomingRequestCommand,
  95       responseCallback: (payload: Record<string, unknown> | string, requestPayload: Record<string, unknown>) => Promise<void>, rejectCallback: (error: OCPPError) => void): string {
  96     let messageToSend: string;
  97     // Type of message
  98     switch (messageType) {
  99       // Request
 100       case MessageType.CALL_MESSAGE:
 101         // Build request
 102         this.chargingStation.requests.set(messageId, [responseCallback, rejectCallback, commandName, commandParams as Record<string, unknown>]);
 103         messageToSend = JSON.stringify([messageType, messageId, commandName, commandParams]);
 104         break;
 105       // Response
 106       case MessageType.CALL_RESULT_MESSAGE:
 107         // Build response
 108         messageToSend = JSON.stringify([messageType, messageId, commandParams]);
 109         break;
 110       // Error Message
 111       case MessageType.CALL_ERROR_MESSAGE:
 112         // Build Error Message
 113         messageToSend = JSON.stringify([messageType, messageId, commandParams?.code ?? ErrorType.GENERIC_ERROR, commandParams?.message ?? '', commandParams?.details ?? {}]);
 114         break;
 115     }
 116     return messageToSend;
 117   }
 118
 119   public abstract sendHeartbeat(): Promise<void>;
 120   public abstract sendBootNotification(chargePointModel: string, chargePointVendor: string, chargeBoxSerialNumber?: string, firmwareVersion?: string, chargePointSerialNumber?: string, iccid?: string, imsi?: string, meterSerialNumber?: string, meterType?: string): Promise<BootNotificationResponse>;
 121   public abstract sendStatusNotification(connectorId: number, status: ChargePointStatus, errorCode?: ChargePointErrorCode): Promise<void>;
 122   public abstract sendAuthorize(connectorId: number, idTag?: string): Promise<AuthorizeResponse>;
 123   public abstract sendStartTransaction(connectorId: number, idTag?: string): Promise<StartTransactionResponse>;
 124   public abstract sendStopTransaction(transactionId: number, meterStop: number, idTag?: string, reason?: StopTransactionReason): Promise<StopTransactionResponse>;
 125   public abstract sendMeterValues(connectorId: number, transactionId: number, interval: number): Promise<void>;
 126   public abstract sendTransactionBeginMeterValues(connectorId: number, transactionId: number, beginMeterValue: MeterValue): Promise<void>;
 127   public abstract sendTransactionEndMeterValues(connectorId: number, transactionId: number, endMeterValue: MeterValue): Promise<void>;
 128   public abstract sendDiagnosticsStatusNotification(diagnosticsStatus: DiagnosticsStatus): Promise<void>;
 129   public abstract sendError(messageId: string, error: OCPPError, commandName: RequestCommand | IncomingRequestCommand): Promise<unknown>;
 130 }