Use the fixed JsonType definition where appropriate
[e-mobility-charging-stations-simulator.git] / src / charging-station / ChargingStation.ts
index 8b837bc347964402cb6190fda46914acf7558779..e5759c33be3a2114e0df6c7eb04131cdcafb4ff7 100644 (file)
@@ -53,6 +53,7 @@ import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket';
 import WebSocket, { Data, OPEN, RawData } from 'ws';
 
 import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
+import BaseError from '../exception/BaseError';
 import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode';
 import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
 import ChargingStationInfo from '../types/ChargingStationInfo';
@@ -646,6 +647,14 @@ export default class ChargingStation {
     this.stopped = true;
   }
 
+  public async reset(reason?: StopTransactionReason): Promise<void> {
+    await this.stop(reason);
+    await Utils.sleep(this.stationInfo.resetTime);
+    this.stationInfo = this.getStationInfo();
+    this.stationInfo?.Connectors && delete this.stationInfo.Connectors;
+    this.start();
+  }
+
   public getConfigurationKey(
     key: string | StandardParametersKey,
     caseInsensitive = false
@@ -925,7 +934,7 @@ export default class ChargingStation {
     params = params ?? {};
     params.randomSerialNumberUpperCase = params?.randomSerialNumberUpperCase ?? true;
     params.randomSerialNumber = params?.randomSerialNumber ?? true;
-    if (existingStationInfo) {
+    if (!Utils.isEmptyObject(existingStationInfo)) {
       existingStationInfo?.chargePointSerialNumber &&
         (stationInfo.chargePointSerialNumber = existingStationInfo.chargePointSerialNumber);
       existingStationInfo?.chargeBoxSerialNumber &&
@@ -950,6 +959,18 @@ export default class ChargingStation {
 
   private getStationInfoFromTemplate(): ChargingStationInfo {
     const stationInfo: ChargingStationInfo = this.getTemplateFromFile();
+    if (Utils.isNullOrUndefined(stationInfo)) {
+      const logMsg = 'Failed to read charging station template file';
+      logger.error(`${this.logPrefix()} ${logMsg}`);
+      throw new BaseError(logMsg);
+    }
+    if (Utils.isEmptyObject(stationInfo)) {
+      logger.warn(
+        `${this.logPrefix()} Empty charging station information from template file ${
+          this.templateFile
+        }`
+      );
+    }
     const chargingStationId = this.getChargingStationId(stationInfo);
     // Deprecation template keys section
     this.warnDeprecatedTemplateKey(
@@ -984,19 +1005,21 @@ export default class ChargingStation {
   }
 
   private createStationInfoHash(stationInfo: ChargingStationInfo): ChargingStationInfo {
-    const previousInfoHash = stationInfo.infoHash ?? '';
-    delete stationInfo.infoHash;
-    const currentInfoHash = crypto
-      .createHash(Constants.DEFAULT_HASH_ALGORITHM)
-      .update(JSON.stringify(stationInfo))
-      .digest('hex');
-    if (
-      Utils.isEmptyString(previousInfoHash) ||
-      (!Utils.isEmptyString(previousInfoHash) && currentInfoHash !== previousInfoHash)
-    ) {
-      stationInfo.infoHash = currentInfoHash;
-    } else {
-      stationInfo.infoHash = previousInfoHash;
+    if (!Utils.isEmptyObject(stationInfo)) {
+      const previousInfoHash = stationInfo?.infoHash ?? '';
+      delete stationInfo.infoHash;
+      const currentInfoHash = crypto
+        .createHash(Constants.DEFAULT_HASH_ALGORITHM)
+        .update(JSON.stringify(stationInfo))
+        .digest('hex');
+      if (
+        Utils.isEmptyString(previousInfoHash) ||
+        (!Utils.isEmptyString(previousInfoHash) && currentInfoHash !== previousInfoHash)
+      ) {
+        stationInfo.infoHash = currentInfoHash;
+      } else {
+        stationInfo.infoHash = previousInfoHash;
+      }
     }
     return stationInfo;
   }
@@ -1033,7 +1056,7 @@ export default class ChargingStation {
   }
 
   private getOcppVersion(): OCPPVersion {
-    return this.stationInfo.ocppVersion ? this.stationInfo.ocppVersion : OCPPVersion.VERSION_16;
+    return this.stationInfo.ocppVersion ?? OCPPVersion.VERSION_16;
   }
 
   private getOcppPersistentConfiguration(): boolean {
@@ -1111,32 +1134,12 @@ export default class ChargingStation {
     );
     // Build connectors if needed
     const maxConnectors = this.getMaxNumberOfConnectors();
-    if (maxConnectors <= 0) {
-      logger.warn(
-        `${this.logPrefix()} Charging station template ${
-          this.templateFile
-        } with ${maxConnectors} connectors`
-      );
-    }
+    this.checkMaxConnectors(maxConnectors);
     const templateMaxConnectors = this.getTemplateMaxNumberOfConnectors();
-    if (templateMaxConnectors <= 0) {
-      logger.warn(
-        `${this.logPrefix()} Charging station template ${
-          this.templateFile
-        } with no connector configuration`
-      );
-    }
-    if (!this.stationInfo.Connectors[0]) {
-      logger.warn(
-        `${this.logPrefix()} Charging station template ${
-          this.templateFile
-        } with no connector Id 0 configuration`
-      );
-    }
-    // Sanity check
+    this.checkTemplateMaxConnectors(templateMaxConnectors);
     if (
       maxConnectors >
-        (this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) &&
+        (this.stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) &&
       !this.stationInfo.randomConnectors
     ) {
       logger.warn(
@@ -1146,64 +1149,12 @@ export default class ChargingStation {
       );
       this.stationInfo.randomConnectors = true;
     }
-    const connectorsConfigHash = crypto
-      .createHash(Constants.DEFAULT_HASH_ALGORITHM)
-      .update(JSON.stringify(this.stationInfo.Connectors) + maxConnectors.toString())
-      .digest('hex');
-    const connectorsConfigChanged =
-      this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash;
-    if (this.connectors?.size === 0 || connectorsConfigChanged) {
-      connectorsConfigChanged && this.connectors.clear();
-      this.connectorsConfigurationHash = connectorsConfigHash;
-      // Add connector Id 0
-      let lastConnector = '0';
-      for (lastConnector in this.stationInfo.Connectors) {
-        const lastConnectorId = Utils.convertToInt(lastConnector);
-        if (
-          lastConnectorId === 0 &&
-          this.getUseConnectorId0() &&
-          this.stationInfo.Connectors[lastConnector]
-        ) {
-          this.connectors.set(
-            lastConnectorId,
-            Utils.cloneObject<ConnectorStatus>(this.stationInfo.Connectors[lastConnector])
-          );
-          this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE;
-          if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) {
-            this.getConnectorStatus(lastConnectorId).chargingProfiles = [];
-          }
-        }
-      }
-      // Generate all connectors
-      if (
-        (this.stationInfo.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0
-      ) {
-        for (let index = 1; index <= maxConnectors; index++) {
-          const randConnectorId = this.stationInfo.randomConnectors
-            ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1)
-            : index;
-          this.connectors.set(
-            index,
-            Utils.cloneObject<ConnectorStatus>(this.stationInfo.Connectors[randConnectorId])
-          );
-          this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE;
-          if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) {
-            this.getConnectorStatus(index).chargingProfiles = [];
-          }
-        }
-      }
-    }
+    this.initializeConnectors(this.stationInfo, maxConnectors, templateMaxConnectors);
     this.stationInfo.maximumAmperage = this.getMaximumAmperage();
     this.stationInfo = this.createStationInfoHash(this.stationInfo);
     this.saveStationInfo();
     // Avoid duplication of connectors related information in RAM
-    delete this.stationInfo.Connectors;
-    // Initialize transaction attributes on connectors
-    for (const connectorId of this.connectors.keys()) {
-      if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) {
-        this.initializeConnectorStatus(connectorId);
-      }
-    }
+    this.stationInfo?.Connectors && delete this.stationInfo.Connectors;
     // OCPP configuration
     this.initializeOcppConfiguration();
     if (this.getEnableStatistics()) {
@@ -1237,6 +1188,12 @@ export default class ChargingStation {
   }
 
   private initializeOcppConfiguration(): void {
+    if (!this.getConfigurationKey(StandardParametersKey.HeartbeatInterval)) {
+      this.addConfigurationKey(StandardParametersKey.HeartbeatInterval, '0');
+    }
+    if (!this.getConfigurationKey(StandardParametersKey.HeartBeatInterval)) {
+      this.addConfigurationKey(StandardParametersKey.HeartBeatInterval, '0', { visible: false });
+    }
     if (
       this.getSupervisionUrlOcppConfiguration() &&
       !this.getConfigurationKey(this.getSupervisionUrlOcppKey())
@@ -1319,6 +1276,112 @@ export default class ChargingStation {
     this.saveOcppConfiguration();
   }
 
+  private initializeConnectors(
+    stationInfo: ChargingStationInfo,
+    maxConnectors: number,
+    templateMaxConnectors: number
+  ): void {
+    if (!stationInfo?.Connectors && this.connectors.size === 0) {
+      const logMsg = `${this.logPrefix()} No already defined connectors and charging station information from template ${
+        this.templateFile
+      } with no connectors configuration defined`;
+      logger.error(logMsg);
+      throw new BaseError(logMsg);
+    }
+    if (!stationInfo?.Connectors[0]) {
+      logger.warn(
+        `${this.logPrefix()} Charging station information from template ${
+          this.templateFile
+        } with no connector Id 0 configuration`
+      );
+    }
+    if (stationInfo?.Connectors) {
+      const connectorsConfigHash = crypto
+        .createHash(Constants.DEFAULT_HASH_ALGORITHM)
+        .update(JSON.stringify(stationInfo?.Connectors) + maxConnectors.toString())
+        .digest('hex');
+      const connectorsConfigChanged =
+        this.connectors?.size !== 0 && this.connectorsConfigurationHash !== connectorsConfigHash;
+      if (this.connectors?.size === 0 || connectorsConfigChanged) {
+        connectorsConfigChanged && this.connectors.clear();
+        this.connectorsConfigurationHash = connectorsConfigHash;
+        // Add connector Id 0
+        let lastConnector = '0';
+        for (lastConnector in stationInfo?.Connectors) {
+          const lastConnectorId = Utils.convertToInt(lastConnector);
+          if (
+            lastConnectorId === 0 &&
+            this.getUseConnectorId0() &&
+            stationInfo?.Connectors[lastConnector]
+          ) {
+            this.connectors.set(
+              lastConnectorId,
+              Utils.cloneObject<ConnectorStatus>(stationInfo?.Connectors[lastConnector])
+            );
+            this.getConnectorStatus(lastConnectorId).availability = AvailabilityType.OPERATIVE;
+            if (Utils.isUndefined(this.getConnectorStatus(lastConnectorId)?.chargingProfiles)) {
+              this.getConnectorStatus(lastConnectorId).chargingProfiles = [];
+            }
+          }
+        }
+        // Generate all connectors
+        if ((stationInfo?.Connectors[0] ? templateMaxConnectors - 1 : templateMaxConnectors) > 0) {
+          for (let index = 1; index <= maxConnectors; index++) {
+            const randConnectorId = stationInfo.randomConnectors
+              ? Utils.getRandomInteger(Utils.convertToInt(lastConnector), 1)
+              : index;
+            this.connectors.set(
+              index,
+              Utils.cloneObject<ConnectorStatus>(stationInfo?.Connectors[randConnectorId])
+            );
+            this.getConnectorStatus(index).availability = AvailabilityType.OPERATIVE;
+            if (Utils.isUndefined(this.getConnectorStatus(index)?.chargingProfiles)) {
+              this.getConnectorStatus(index).chargingProfiles = [];
+            }
+          }
+        }
+      }
+    } else {
+      logger.warn(
+        `${this.logPrefix()} Charging station information from template ${
+          this.templateFile
+        } with no connectors configuration defined, using already defined connectors`
+      );
+    }
+    // Initialize transaction attributes on connectors
+    for (const connectorId of this.connectors.keys()) {
+      if (connectorId > 0 && !this.getConnectorStatus(connectorId)?.transactionStarted) {
+        this.initializeConnectorStatus(connectorId);
+      }
+    }
+  }
+
+  private checkMaxConnectors(maxConnectors: number): void {
+    if (maxConnectors <= 0) {
+      logger.warn(
+        `${this.logPrefix()} Charging station information from template ${
+          this.templateFile
+        } with ${maxConnectors} connectors`
+      );
+    }
+  }
+
+  private checkTemplateMaxConnectors(templateMaxConnectors: number): void {
+    if (templateMaxConnectors === 0) {
+      logger.warn(
+        `${this.logPrefix()} Charging station information from template ${
+          this.templateFile
+        } with empty connectors configuration`
+      );
+    } else if (templateMaxConnectors < 0) {
+      logger.error(
+        `${this.logPrefix()} Charging station information from template ${
+          this.templateFile
+        } with no connectors configuration defined`
+      );
+    }
+  }
+
   private getConfigurationFromFile(): ChargingStationConfiguration | null {
     let configuration: ChargingStationConfiguration = null;
     if (this.configurationFile && fs.existsSync(this.configurationFile)) {
@@ -1356,7 +1419,7 @@ export default class ChargingStation {
           case Section.stationInfo:
             if (configurationData?.stationInfo?.infoHash === this.stationInfo?.infoHash) {
               logger.debug(
-                `${this.logPrefix()} Not saving unchanged charging station info to configuration file ${
+                `${this.logPrefix()} Not saving unchanged charging station information to configuration file ${
                   this.configurationFile
                 }`
               );
@@ -1514,7 +1577,7 @@ export default class ChargingStation {
     let errorMessage: string;
     let errorDetails: JsonType;
     let responseCallback: (payload: JsonType, requestPayload: JsonType) => void;
-    let rejectCallback: (error: OCPPError, requestStatistic?: boolean) => void;
+    let errorCallback: (error: OCPPError, requestStatistic?: boolean) => void;
     let requestCommandName: RequestCommand | IncomingRequestCommand;
     let requestPayload: JsonType;
     let cachedRequest: CachedRequest;
@@ -1546,6 +1609,15 @@ export default class ChargingStation {
           // Outcome Message
           case MessageType.CALL_RESULT_MESSAGE:
             [, , commandPayload] = request as Response;
+            if (!this.requests.has(messageId)) {
+              // Error
+              throw new OCPPError(
+                ErrorType.INTERNAL_ERROR,
+                `Response for unknown message id ${messageId}`,
+                null,
+                commandPayload
+              );
+            }
             // Respond
             cachedRequest = this.requests.get(messageId);
             if (Utils.isIterable(cachedRequest)) {
@@ -1563,23 +1635,23 @@ export default class ChargingStation {
                 requestCommandName ?? ''
               }' received response payload: ${JSON.stringify(request)}`
             );
-            if (!responseCallback) {
+            responseCallback(commandPayload, requestPayload);
+            break;
+          // Error Message
+          case MessageType.CALL_ERROR_MESSAGE:
+            [, , errorType, errorMessage, errorDetails] = request as ErrorResponse;
+            if (!this.requests.has(messageId)) {
               // Error
               throw new OCPPError(
                 ErrorType.INTERNAL_ERROR,
-                `Response for unknown message id ${messageId}`,
+                `Error response for unknown message id ${messageId}`,
                 null,
-                commandPayload
+                { errorType, errorMessage, errorDetails }
               );
             }
-            responseCallback(commandPayload, requestPayload);
-            break;
-          // Error Message
-          case MessageType.CALL_ERROR_MESSAGE:
-            [, , errorType, errorMessage, errorDetails] = request as ErrorResponse;
             cachedRequest = this.requests.get(messageId);
             if (Utils.isIterable(cachedRequest)) {
-              [, rejectCallback, requestCommandName] = cachedRequest;
+              [, errorCallback, requestCommandName] = cachedRequest;
             } else {
               throw new OCPPError(
                 ErrorType.PROTOCOL_ERROR,
@@ -1593,18 +1665,7 @@ export default class ChargingStation {
                 requestCommandName ?? ''
               }' received error payload: ${JSON.stringify(request)}`
             );
-            if (!rejectCallback) {
-              // Error
-              throw new OCPPError(
-                ErrorType.INTERNAL_ERROR,
-                `Error response for unknown message id ${messageId}`,
-                null,
-                { errorType, errorMessage, errorDetails }
-              );
-            }
-            rejectCallback(
-              new OCPPError(errorType, errorMessage, requestCommandName, errorDetails)
-            );
+            errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails));
             break;
           // Error
           default:
@@ -1632,7 +1693,7 @@ export default class ChargingStation {
         (await this.ocppRequestService.sendError(
           messageId,
           error as OCPPError,
-          Utils.isString(commandName) ? commandName : requestCommandName ?? null
+          commandName ?? requestCommandName ?? null
         ));
     }
   }
@@ -1738,7 +1799,10 @@ export default class ChargingStation {
   }
 
   private getTemplateMaxNumberOfConnectors(): number {
-    return Object.keys(this.stationInfo.Connectors).length;
+    if (!this.stationInfo?.Connectors) {
+      return -1;
+    }
+    return Object.keys(this.stationInfo?.Connectors).length;
   }
 
   private getMaxNumberOfConnectors(): number {
@@ -1750,7 +1814,7 @@ export default class ChargingStation {
     } else if (!Utils.isUndefined(this.stationInfo.numberOfConnectors)) {
       maxConnectors = this.stationInfo.numberOfConnectors as number;
     } else {
-      maxConnectors = this.stationInfo.Connectors[0]
+      maxConnectors = this.stationInfo?.Connectors[0]
         ? this.getTemplateMaxNumberOfConnectors() - 1
         : this.getTemplateMaxNumberOfConnectors();
     }