Refine type definitions
[e-mobility-charging-stations-simulator.git] / src / charging-station / ChargingStation.ts
index d7b67e6a04b73aa960abc5767dec9338ea0038ee..0a3d544a01260c2d051b5f649010aaaa88146c05 100644 (file)
@@ -12,13 +12,14 @@ import BaseError from '../exception/BaseError';
 import OCPPError from '../exception/OCPPError';
 import PerformanceStatistics from '../performance/PerformanceStatistics';
 import type { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator';
-import type ChargingStationConfiguration from '../types/ChargingStationConfiguration';
-import type ChargingStationInfo from '../types/ChargingStationInfo';
-import type ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration';
-import ChargingStationTemplate, {
+import type { ChargingStationConfiguration } from '../types/ChargingStationConfiguration';
+import type { ChargingStationInfo } from '../types/ChargingStationInfo';
+import type { ChargingStationOcppConfiguration } from '../types/ChargingStationOcppConfiguration';
+import {
+  type ChargingStationTemplate,
   CurrentType,
   PowerUnits,
-  WsOptions,
+  type WsOptions,
 } from '../types/ChargingStationTemplate';
 import { SupervisionUrlDistribution } from '../types/ConfigurationData';
 import type { ConnectorStatus } from '../types/ConnectorStatus';
@@ -99,6 +100,8 @@ export default class ChargingStation {
   public bootNotificationRequest!: BootNotificationRequest;
   public bootNotificationResponse!: BootNotificationResponse | null;
   public powerDivider!: number;
+  private starting: boolean;
+  private stopping: boolean;
   private readonly index: number;
   private configurationFile!: string;
   private configurationFileHash!: string;
@@ -114,6 +117,11 @@ export default class ChargingStation {
   private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel;
 
   constructor(index: number, templateFile: string) {
+    this.started = false;
+    this.starting = false;
+    this.stopping = false;
+    this.wsConnectionRestarted = false;
+    this.autoReconnectRetryCount = 0;
     this.index = index;
     this.templateFile = templateFile;
     this.connectors = new Map<number, ConnectorStatus>();
@@ -122,9 +130,6 @@ export default class ChargingStation {
     this.sharedLRUCache = SharedLRUCache.getInstance();
     this.authorizedTagsCache = AuthorizedTagsCache.getInstance();
     this.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this);
-    this.started = false;
-    this.wsConnectionRestarted = false;
-    this.autoReconnectRetryCount = 0;
 
     this.initialize();
   }
@@ -475,75 +480,97 @@ export default class ChargingStation {
   }
 
   public start(): void {
-    if (this.getEnableStatistics()) {
-      this.performanceStatistics.start();
-    }
-    this.openWSConnection();
-    // Monitor charging station template file
-    this.templateFileWatcher = FileUtils.watchJsonFile(
-      this.logPrefix(),
-      FileType.ChargingStationTemplate,
-      this.templateFile,
-      null,
-      (event, filename): void => {
-        if (filename && event === 'change') {
-          try {
-            logger.debug(
-              `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${
-                this.templateFile
-              } file have changed, reload`
-            );
-            this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
-            // Initialize
-            this.initialize();
-            // Restart the ATG
-            this.stopAutomaticTransactionGenerator();
-            if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) {
-              this.startAutomaticTransactionGenerator();
-            }
-            if (this.getEnableStatistics()) {
-              this.performanceStatistics.restart();
-            } else {
-              this.performanceStatistics.stop();
+    if (this.started === false) {
+      if (this.starting === false) {
+        this.starting = true;
+        if (this.getEnableStatistics()) {
+          this.performanceStatistics.start();
+        }
+        this.openWSConnection();
+        // Monitor charging station template file
+        this.templateFileWatcher = FileUtils.watchJsonFile(
+          this.logPrefix(),
+          FileType.ChargingStationTemplate,
+          this.templateFile,
+          null,
+          (event, filename): void => {
+            if (filename && event === 'change') {
+              try {
+                logger.debug(
+                  `${this.logPrefix()} ${FileType.ChargingStationTemplate} ${
+                    this.templateFile
+                  } file have changed, reload`
+                );
+                this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
+                // Initialize
+                this.initialize();
+                // Restart the ATG
+                this.stopAutomaticTransactionGenerator();
+                if (
+                  this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true
+                ) {
+                  this.startAutomaticTransactionGenerator();
+                }
+                if (this.getEnableStatistics()) {
+                  this.performanceStatistics.restart();
+                } else {
+                  this.performanceStatistics.stop();
+                }
+                // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
+              } catch (error) {
+                logger.error(
+                  `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`,
+                  error
+                );
+              }
             }
-            // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
-          } catch (error) {
-            logger.error(
-              `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`,
-              error
-            );
           }
-        }
+        );
+        parentPort.postMessage(MessageChannelUtils.buildStartedMessage(this));
+        this.starting = false;
+      } else {
+        logger.warn(`${this.logPrefix()} Charging station is already starting...`);
       }
-    );
-    parentPort.postMessage(MessageChannelUtils.buildStartedMessage(this));
+    } else {
+      logger.warn(`${this.logPrefix()} Charging station is already started...`);
+    }
   }
 
   public async stop(reason?: StopTransactionReason): Promise<void> {
-    await this.stopMessageSequence(reason);
-    for (const connectorId of this.connectors.keys()) {
-      if (connectorId > 0) {
-        await this.ocppRequestService.requestHandler<
-          StatusNotificationRequest,
-          StatusNotificationResponse
-        >(this, RequestCommand.STATUS_NOTIFICATION, {
-          connectorId,
-          status: ChargePointStatus.UNAVAILABLE,
-          errorCode: ChargePointErrorCode.NO_ERROR,
-        });
-        this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE;
+    if (this.started === true) {
+      if (this.stopping === false) {
+        this.stopping = true;
+        await this.stopMessageSequence(reason);
+        for (const connectorId of this.connectors.keys()) {
+          if (connectorId > 0) {
+            await this.ocppRequestService.requestHandler<
+              StatusNotificationRequest,
+              StatusNotificationResponse
+            >(this, RequestCommand.STATUS_NOTIFICATION, {
+              connectorId,
+              status: ChargePointStatus.UNAVAILABLE,
+              errorCode: ChargePointErrorCode.NO_ERROR,
+            });
+            this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE;
+          }
+        }
+        this.closeWSConnection();
+        if (this.getEnableStatistics()) {
+          this.performanceStatistics.stop();
+        }
+        this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
+        this.templateFileWatcher.close();
+        this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
+        this.bootNotificationResponse = null;
+        this.started = false;
+        parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this));
+        this.stopping = false;
+      } else {
+        logger.warn(`${this.logPrefix()} Charging station is already stopping...`);
       }
+    } else {
+      logger.warn(`${this.logPrefix()} Charging station is already stopped...`);
     }
-    this.closeWSConnection();
-    if (this.getEnableStatistics()) {
-      this.performanceStatistics.stop();
-    }
-    this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
-    this.templateFileWatcher.close();
-    this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
-    this.bootNotificationResponse = null;
-    this.started = false;
-    parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this));
   }
 
   public async reset(reason?: StopTransactionReason): Promise<void> {
@@ -705,6 +732,7 @@ export default class ChargingStation {
     } else {
       this.automaticTransactionGenerator.start();
     }
+    parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
   }
 
   public stopAutomaticTransactionGenerator(connectorIds?: number[]): void {
@@ -714,8 +742,8 @@ export default class ChargingStation {
       }
     } else {
       this.automaticTransactionGenerator?.stop();
-      this.automaticTransactionGenerator = null;
     }
+    parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
   }
 
   public async stopTransactionOnConnector(
@@ -1179,7 +1207,7 @@ export default class ChargingStation {
           const lastConnectorId = Utils.convertToInt(lastConnector);
           if (
             lastConnectorId === 0 &&
-            this.getUseConnectorId0(stationInfo) &&
+            this.getUseConnectorId0(stationInfo) === true &&
             stationInfo?.Connectors[lastConnector]
           ) {
             this.connectors.set(
@@ -1341,22 +1369,9 @@ export default class ChargingStation {
           this.bootNotificationResponse = await this.ocppRequestService.requestHandler<
             BootNotificationRequest,
             BootNotificationResponse
-          >(
-            this,
-            RequestCommand.BOOT_NOTIFICATION,
-            {
-              chargePointModel: this.bootNotificationRequest.chargePointModel,
-              chargePointVendor: this.bootNotificationRequest.chargePointVendor,
-              chargeBoxSerialNumber: this.bootNotificationRequest.chargeBoxSerialNumber,
-              firmwareVersion: this.bootNotificationRequest.firmwareVersion,
-              chargePointSerialNumber: this.bootNotificationRequest.chargePointSerialNumber,
-              iccid: this.bootNotificationRequest.iccid,
-              imsi: this.bootNotificationRequest.imsi,
-              meterSerialNumber: this.bootNotificationRequest.meterSerialNumber,
-              meterType: this.bootNotificationRequest.meterType,
-            },
-            { skipBufferingOnError: true }
-          );
+          >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, {
+            skipBufferingOnError: true,
+          });
           if (!this.isRegistered()) {
             this.getRegistrationMaxRetries() !== -1 && registrationRetryCount++;
             await Utils.sleep(
@@ -1374,16 +1389,15 @@ export default class ChargingStation {
       if (this.isRegistered()) {
         if (this.isInAcceptedState()) {
           await this.startMessageSequence();
-          this.wsConnectionRestarted && this.flushMessageBuffer();
         }
       } else {
         logger.error(
           `${this.logPrefix()} Registration failure: max retries reached (${this.getRegistrationMaxRetries()}) or retry disabled (${this.getRegistrationMaxRetries()})`
         );
       }
-      this.started === false && (this.started = true);
-      this.autoReconnectRetryCount = 0;
       this.wsConnectionRestarted = false;
+      this.autoReconnectRetryCount = 0;
+      this.started = true;
       parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
     } else {
       logger.warn(
@@ -1411,7 +1425,7 @@ export default class ChargingStation {
             code
           )}' and reason '${reason}'`
         );
-        await this.reconnect(code);
+        await this.reconnect();
         break;
     }
     parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
@@ -1440,7 +1454,7 @@ export default class ChargingStation {
           // Incoming Message
           case MessageType.CALL_MESSAGE:
             [, , commandName, commandPayload] = request as IncomingRequest;
-            if (this.getEnableStatistics()) {
+            if (this.getEnableStatistics() === true) {
               this.performanceStatistics.addRequestStatistic(commandName, messageType);
             }
             logger.debug(
@@ -1459,7 +1473,7 @@ export default class ChargingStation {
           // Outcome Message
           case MessageType.CALL_RESULT_MESSAGE:
             [, , commandPayload] = request as Response;
-            if (!this.requests.has(messageId)) {
+            if (this.requests.has(messageId) === false) {
               // Error
               throw new OCPPError(
                 ErrorType.INTERNAL_ERROR,
@@ -1471,7 +1485,7 @@ export default class ChargingStation {
             // Respond
             cachedRequest = this.requests.get(messageId);
             if (Array.isArray(cachedRequest) === true) {
-              [responseCallback, , requestCommandName, requestPayload] = cachedRequest;
+              [responseCallback, errorCallback, requestCommandName, requestPayload] = cachedRequest;
             } else {
               throw new OCPPError(
                 ErrorType.PROTOCOL_ERROR,
@@ -1490,7 +1504,7 @@ export default class ChargingStation {
           // Error Message
           case MessageType.CALL_ERROR_MESSAGE:
             [, , errorType, errorMessage, errorDetails] = request as ErrorResponse;
-            if (!this.requests.has(messageId)) {
+            if (this.requests.has(messageId) === false) {
               // Error
               throw new OCPPError(
                 ErrorType.INTERNAL_ERROR,
@@ -1527,7 +1541,7 @@ export default class ChargingStation {
         parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
       } else {
         throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not an array', null, {
-          payload: request,
+          request,
         });
       }
     } catch (error) {
@@ -1535,12 +1549,14 @@ export default class ChargingStation {
       logger.error(
         `${this.logPrefix()} Incoming OCPP command '${
           commandName ?? requestCommandName ?? null
-        }' message '${data.toString()}' matching cached request '${JSON.stringify(
-          this.requests.get(messageId)
-        )}' processing error:`,
+        }' message '${data.toString()}'${
+          messageType !== MessageType.CALL_MESSAGE
+            ? ` matching cached request '${JSON.stringify(this.requests.get(messageId))}'`
+            : ''
+        } processing error:`,
         error
       );
-      if (!(error instanceof OCPPError)) {
+      if (error instanceof OCPPError === false) {
         logger.warn(
           `${this.logPrefix()} Error thrown at incoming OCPP command '${
             commandName ?? requestCommandName ?? null
@@ -1548,14 +1564,27 @@ export default class ChargingStation {
           error
         );
       }
-      // Send error
-      messageType === MessageType.CALL_MESSAGE &&
-        (await this.ocppRequestService.sendError(
-          this,
-          messageId,
-          error as OCPPError,
-          commandName ?? requestCommandName ?? null
-        ));
+      switch (messageType) {
+        case MessageType.CALL_MESSAGE:
+          // Send error
+          await this.ocppRequestService.sendError(
+            this,
+            messageId,
+            error as OCPPError,
+            commandName ?? requestCommandName ?? null
+          );
+          break;
+        case MessageType.CALL_RESULT_MESSAGE:
+        case MessageType.CALL_ERROR_MESSAGE:
+          if (errorCallback) {
+            // Reject the deferred promise in case of error at response handling (rejecting an already fulfilled promise is a no-op)
+            errorCallback(error as OCPPError, false);
+          } else {
+            // Remove the request from the cache in case of error at response handling
+            this.requests.delete(messageId);
+          }
+          break;
+      }
     }
   }
 
@@ -1576,7 +1605,7 @@ export default class ChargingStation {
     connectorStatus: ConnectorStatus,
     meterStop = false
   ): number {
-    if (this.getMeteringPerTransaction()) {
+    if (this.getMeteringPerTransaction() === true) {
       return (
         (meterStop === true
           ? Math.round(connectorStatus?.transactionEnergyActiveImportRegisterValue)
@@ -1590,7 +1619,7 @@ export default class ChargingStation {
     );
   }
 
-  private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean | undefined {
+  private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean {
     const localStationInfo = stationInfo ?? this.stationInfo;
     return !Utils.isUndefined(localStationInfo.useConnectorId0)
       ? localStationInfo.useConnectorId0
@@ -1756,22 +1785,9 @@ export default class ChargingStation {
       await this.ocppRequestService.requestHandler<
         BootNotificationRequest,
         BootNotificationResponse
-      >(
-        this,
-        RequestCommand.BOOT_NOTIFICATION,
-        {
-          chargePointModel: this.bootNotificationRequest.chargePointModel,
-          chargePointVendor: this.bootNotificationRequest.chargePointVendor,
-          chargeBoxSerialNumber: this.bootNotificationRequest.chargeBoxSerialNumber,
-          firmwareVersion: this.bootNotificationRequest.firmwareVersion,
-          chargePointSerialNumber: this.bootNotificationRequest.chargePointSerialNumber,
-          iccid: this.bootNotificationRequest.iccid,
-          imsi: this.bootNotificationRequest.imsi,
-          meterSerialNumber: this.bootNotificationRequest.meterSerialNumber,
-          meterType: this.bootNotificationRequest.meterType,
-        },
-        { skipBufferingOnError: true }
-      );
+      >(this, RequestCommand.BOOT_NOTIFICATION, this.bootNotificationRequest, {
+        skipBufferingOnError: true,
+      });
     }
     // Start WebSocket ping
     this.startWebSocketPing();
@@ -1840,6 +1856,7 @@ export default class ChargingStation {
     if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable === true) {
       this.startAutomaticTransactionGenerator();
     }
+    this.wsConnectionRestarted === true && this.flushMessageBuffer();
   }
 
   private async stopMessageSequence(
@@ -1992,7 +2009,7 @@ export default class ChargingStation {
       : false;
   }
 
-  private async reconnect(code: number): Promise<void> {
+  private async reconnect(): Promise<void> {
     // Stop WebSocket ping
     this.stopWebSocketPing();
     // Stop heartbeat