Bump @types/node from 18.7.5 to 18.7.6 (#134)
[e-mobility-charging-stations-simulator.git] / src / charging-station / ChargingStation.ts
index e9f31682924de1491781211713da9068b8bb873e..d7dcdceec9428543c5957738912b541a61d47ddd 100644 (file)
@@ -1,6 +1,43 @@
 // Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
 
-import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils';
+import crypto from 'crypto';
+import fs from 'fs';
+import path from 'path';
+import { URL } from 'url';
+import { parentPort } from 'worker_threads';
+
+import WebSocket, { Data, RawData } from 'ws';
+
+import BaseError from '../exception/BaseError';
+import OCPPError from '../exception/OCPPError';
+import PerformanceStatistics from '../performance/PerformanceStatistics';
+import { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator';
+import ChargingStationConfiguration from '../types/ChargingStationConfiguration';
+import ChargingStationInfo from '../types/ChargingStationInfo';
+import ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration';
+import ChargingStationTemplate, {
+  CurrentType,
+  PowerUnits,
+  WsOptions,
+} from '../types/ChargingStationTemplate';
+import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker';
+import { SupervisionUrlDistribution } from '../types/ConfigurationData';
+import { ConnectorStatus } from '../types/ConnectorStatus';
+import { FileType } from '../types/FileType';
+import { JsonType } from '../types/JsonType';
+import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode';
+import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
+import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile';
+import {
+  ConnectorPhaseRotation,
+  StandardParametersKey,
+  SupportedFeatureProfiles,
+  VendorDefaultParametersKey,
+} from '../types/ocpp/Configuration';
+import { ErrorType } from '../types/ocpp/ErrorType';
+import { MessageType } from '../types/ocpp/MessageType';
+import { MeterValue, MeterValueMeasurand } from '../types/ocpp/MeterValues';
+import { OCPPVersion } from '../types/ocpp/OCPPVersion';
 import {
   AvailabilityType,
   BootNotificationRequest,
@@ -21,69 +58,34 @@ import {
   Response,
   StatusNotificationResponse,
 } from '../types/ocpp/Responses';
-import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile';
-import ChargingStationTemplate, {
-  CurrentType,
-  PowerUnits,
-  WsOptions,
-} from '../types/ChargingStationTemplate';
-import {
-  ConnectorPhaseRotation,
-  StandardParametersKey,
-  SupportedFeatureProfiles,
-  VendorDefaultParametersKey,
-} from '../types/ocpp/Configuration';
-import { MeterValue, MeterValueMeasurand } from '../types/ocpp/MeterValues';
 import {
   StopTransactionReason,
   StopTransactionRequest,
   StopTransactionResponse,
 } from '../types/ocpp/Transaction';
-import { URL, fileURLToPath } from 'url';
 import { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket';
-import WebSocket, { Data, RawData } from 'ws';
-
-import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
-import { AutomaticTransactionGeneratorConfiguration } from '../types/AutomaticTransactionGenerator';
-import BaseError from '../exception/BaseError';
-import { ChargePointErrorCode } from '../types/ocpp/ChargePointErrorCode';
-import { ChargePointStatus } from '../types/ocpp/ChargePointStatus';
-import { ChargingStationCache } from './ChargingStationCache';
-import ChargingStationConfiguration from '../types/ChargingStationConfiguration';
-import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils';
-import ChargingStationInfo from '../types/ChargingStationInfo';
-import ChargingStationOcppConfiguration from '../types/ChargingStationOcppConfiguration';
-import { ChargingStationUtils } from './ChargingStationUtils';
-import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker';
 import Configuration from '../utils/Configuration';
-import { ConnectorStatus } from '../types/ConnectorStatus';
 import Constants from '../utils/Constants';
-import { ErrorType } from '../types/ocpp/ErrorType';
-import { FileType } from '../types/FileType';
+import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils';
 import FileUtils from '../utils/FileUtils';
-import { JsonType } from '../types/JsonType';
-import { MessageType } from '../types/ocpp/MessageType';
+import logger from '../utils/Logger';
+import Utils from '../utils/Utils';
+import AuthorizedTagsCache from './AuthorizedTagsCache';
+import AutomaticTransactionGenerator from './AutomaticTransactionGenerator';
+import { ChargingStationConfigurationUtils } from './ChargingStationConfigurationUtils';
+import { ChargingStationUtils } from './ChargingStationUtils';
 import OCPP16IncomingRequestService from './ocpp/1.6/OCPP16IncomingRequestService';
 import OCPP16RequestService from './ocpp/1.6/OCPP16RequestService';
 import OCPP16ResponseService from './ocpp/1.6/OCPP16ResponseService';
 import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils';
-import OCPPError from '../exception/OCPPError';
 import OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService';
 import OCPPRequestService from './ocpp/OCPPRequestService';
-import { OCPPVersion } from '../types/ocpp/OCPPVersion';
-import PerformanceStatistics from '../performance/PerformanceStatistics';
-import { SupervisionUrlDistribution } from '../types/ConfigurationData';
-import Utils from '../utils/Utils';
-import crypto from 'crypto';
-import fs from 'fs';
-import logger from '../utils/Logger';
-import { parentPort } from 'worker_threads';
-import path from 'path';
+import SharedLRUCache from './SharedLRUCache';
 
 export default class ChargingStation {
   public hashId!: string;
   public readonly templateFile: string;
-  public authorizedTags!: string[];
+  public authorizedTagsCache: AuthorizedTagsCache;
   public stationInfo!: ChargingStationInfo;
   public readonly connectors: Map<number, ConnectorStatus>;
   public ocppConfiguration!: ChargingStationOcppConfiguration;
@@ -105,7 +107,8 @@ export default class ChargingStation {
   private wsConnectionRestarted: boolean;
   private autoReconnectRetryCount: number;
   private stopped: boolean;
-  private readonly cache: ChargingStationCache;
+  private templateFileWatcher!: fs.FSWatcher;
+  private readonly sharedLRUCache: SharedLRUCache;
   private automaticTransactionGenerator!: AutomaticTransactionGenerator;
   private webSocketPingSetInterval!: NodeJS.Timeout;
 
@@ -115,7 +118,8 @@ export default class ChargingStation {
     this.stopped = false;
     this.wsConnectionRestarted = false;
     this.autoReconnectRetryCount = 0;
-    this.cache = ChargingStationCache.getInstance();
+    this.sharedLRUCache = SharedLRUCache.getInstance();
+    this.authorizedTagsCache = AuthorizedTagsCache.getInstance();
     this.connectors = new Map<number, ConnectorStatus>();
     this.requests = new Map<string, CachedRequest>();
     this.messageBuffer = new Set<string>();
@@ -149,12 +153,19 @@ export default class ChargingStation {
   }
 
   public getRandomIdTag(): string {
-    const index = Math.floor(Utils.secureRandom() * this.authorizedTags.length);
-    return this.authorizedTags[index];
+    const authorizationFile = ChargingStationUtils.getAuthorizationFile(this.stationInfo);
+    const index = Math.floor(
+      Utils.secureRandom() * this.authorizedTagsCache.getAuthorizedTags(authorizationFile).length
+    );
+    return this.authorizedTagsCache.getAuthorizedTags(authorizationFile)[index];
   }
 
   public hasAuthorizedTags(): boolean {
-    return !Utils.isEmptyArray(this.authorizedTags);
+    return !Utils.isEmptyArray(
+      this.authorizedTagsCache.getAuthorizedTags(
+        ChargingStationUtils.getAuthorizationFile(this.stationInfo)
+      )
+    );
   }
 
   public getEnableStatistics(): boolean | undefined {
@@ -469,36 +480,8 @@ export default class ChargingStation {
       this.performanceStatistics.start();
     }
     this.openWSConnection();
-    // Handle WebSocket message
-    this.wsConnection.on(
-      'message',
-      this.onMessage.bind(this) as (this: WebSocket, data: RawData, isBinary: boolean) => void
-    );
-    // Handle WebSocket error
-    this.wsConnection.on(
-      'error',
-      this.onError.bind(this) as (this: WebSocket, error: Error) => void
-    );
-    // Handle WebSocket close
-    this.wsConnection.on(
-      'close',
-      this.onClose.bind(this) as (this: WebSocket, code: number, reason: Buffer) => void
-    );
-    // Handle WebSocket open
-    this.wsConnection.on('open', this.onOpen.bind(this) as (this: WebSocket) => void);
-    // Handle WebSocket ping
-    this.wsConnection.on('ping', this.onPing.bind(this) as (this: WebSocket, data: Buffer) => void);
-    // Handle WebSocket pong
-    this.wsConnection.on('pong', this.onPong.bind(this) as (this: WebSocket, data: Buffer) => void);
-    // Monitor authorization file
-    FileUtils.watchJsonFile<string[]>(
-      this.logPrefix(),
-      FileType.Authorization,
-      ChargingStationUtils.getAuthorizationFile(this.stationInfo),
-      this.authorizedTags
-    );
     // Monitor charging station template file
-    FileUtils.watchJsonFile(
+    this.templateFileWatcher = FileUtils.watchJsonFile(
       this.logPrefix(),
       FileType.ChargingStationTemplate,
       this.templateFile,
@@ -511,7 +494,7 @@ export default class ChargingStation {
                 this.templateFile
               } file have changed, reload`
             );
-            this.cache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
+            this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
             // Initialize
             this.initialize();
             // Restart the ATG
@@ -558,8 +541,9 @@ export default class ChargingStation {
     if (this.getEnableStatistics()) {
       this.performanceStatistics.stop();
     }
-    this.cache.deleteChargingStationConfiguration(this.configurationFileHash);
-    this.cache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
+    this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
+    this.templateFileWatcher.close();
+    this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
     this.bootNotificationResponse = null;
     parentPort.postMessage({
       id: ChargingStationWorkerMessageEvents.STOPPED,
@@ -710,8 +694,8 @@ export default class ChargingStation {
   private getTemplateFromFile(): ChargingStationTemplate | null {
     let template: ChargingStationTemplate = null;
     try {
-      if (this.cache.hasChargingStationTemplate(this.stationInfo?.templateHash)) {
-        template = this.cache.getChargingStationTemplate(this.stationInfo.templateHash);
+      if (this.sharedLRUCache.hasChargingStationTemplate(this.stationInfo?.templateHash)) {
+        template = this.sharedLRUCache.getChargingStationTemplate(this.stationInfo.templateHash);
       } else {
         const measureId = `${FileType.ChargingStationTemplate} read`;
         const beginId = PerformanceStatistics.beginMeasure(measureId);
@@ -723,7 +707,7 @@ export default class ChargingStation {
           .createHash(Constants.DEFAULT_HASH_ALGORITHM)
           .update(JSON.stringify(template))
           .digest('hex');
-        this.cache.setChargingStationTemplate(template);
+        this.sharedLRUCache.setChargingStationTemplate(template);
       }
     } catch (error) {
       FileUtils.handleFileException(
@@ -877,9 +861,7 @@ export default class ChargingStation {
     this.hashId = ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile());
     logger.info(`${this.logPrefix()} Charging station hashId '${this.hashId}'`);
     this.configurationFile = path.join(
-      path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'),
-      'assets',
-      'configurations',
+      path.dirname(this.templateFile.replace('station-templates', 'configurations')),
       this.hashId + '.json'
     );
     this.stationInfo = this.getStationInfo();
@@ -897,11 +879,6 @@ export default class ChargingStation {
     this.bootNotificationRequest = ChargingStationUtils.createBootNotificationRequest(
       this.stationInfo
     );
-    this.authorizedTags = ChargingStationUtils.getAuthorizedTags(
-      this.stationInfo,
-      this.templateFile,
-      this.logPrefix()
-    );
     this.powerDivider = this.getPowerDivider();
     // OCPP configuration
     this.ocppConfiguration = this.getOcppConfiguration();
@@ -1173,8 +1150,10 @@ export default class ChargingStation {
     let configuration: ChargingStationConfiguration = null;
     if (this.configurationFile && fs.existsSync(this.configurationFile)) {
       try {
-        if (this.cache.hasChargingStationConfiguration(this.configurationFileHash)) {
-          configuration = this.cache.getChargingStationConfiguration(this.configurationFileHash);
+        if (this.sharedLRUCache.hasChargingStationConfiguration(this.configurationFileHash)) {
+          configuration = this.sharedLRUCache.getChargingStationConfiguration(
+            this.configurationFileHash
+          );
         } else {
           const measureId = `${FileType.ChargingStationConfiguration} read`;
           const beginId = PerformanceStatistics.beginMeasure(measureId);
@@ -1183,7 +1162,7 @@ export default class ChargingStation {
           ) as ChargingStationConfiguration;
           PerformanceStatistics.endMeasure(measureId, beginId);
           this.configurationFileHash = configuration.configurationHash;
-          this.cache.setChargingStationConfiguration(configuration);
+          this.sharedLRUCache.setChargingStationConfiguration(configuration);
         }
       } catch (error) {
         FileUtils.handleFileException(
@@ -1221,9 +1200,9 @@ export default class ChargingStation {
           fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8');
           fs.closeSync(fileDescriptor);
           PerformanceStatistics.endMeasure(measureId, beginId);
-          this.cache.deleteChargingStationConfiguration(this.configurationFileHash);
+          this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash);
           this.configurationFileHash = configurationHash;
-          this.cache.setChargingStationConfiguration(configurationData);
+          this.sharedLRUCache.setChargingStationConfiguration(configurationData);
         } else {
           logger.debug(
             `${this.logPrefix()} Not saving unchanged charging station configuration file ${
@@ -1419,7 +1398,7 @@ export default class ChargingStation {
             }
             logger.debug(
               `${this.logPrefix()} << Command '${
-                requestCommandName ?? ''
+                requestCommandName ?? 'unknown'
               }' received response payload: ${JSON.stringify(request)}`
             );
             responseCallback(commandPayload, requestPayload);
@@ -1449,7 +1428,7 @@ export default class ChargingStation {
             }
             logger.debug(
               `${this.logPrefix()} << Command '${
-                requestCommandName ?? ''
+                requestCommandName ?? 'unknown'
               }' received error payload: ${JSON.stringify(request)}`
             );
             errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails));
@@ -1469,12 +1448,22 @@ export default class ChargingStation {
     } catch (error) {
       // Log
       logger.error(
-        '%s Incoming OCPP message %j matching cached request %j processing error %j',
+        "%s Incoming OCPP '%s' message '%j' matching cached request '%j' processing error: %j",
         this.logPrefix(),
+        commandName ?? requestCommandName ?? null,
         data.toString(),
         this.requests.get(messageId),
         error
       );
+      if (!(error instanceof OCPPError)) {
+        logger.warn(
+          "%s Error thrown at incoming OCPP '%s' message '%j' handling is not an OCPPError: %j",
+          this.logPrefix(),
+          commandName ?? requestCommandName ?? null,
+          data.toString(),
+          error
+        );
+      }
       // Send error
       messageType === MessageType.CALL_MESSAGE &&
         (await this.ocppRequestService.sendError(
@@ -1495,6 +1484,7 @@ export default class ChargingStation {
   }
 
   private onError(error: WSError): void {
+    this.closeWSConnection();
     logger.error(this.logPrefix() + ' WebSocket error: %j', error);
   }
 
@@ -1741,7 +1731,7 @@ export default class ChargingStation {
               {
                 connectorId,
                 transactionId,
-                meterValue: transactionEndMeterValue,
+                meterValue: [transactionEndMeterValue],
               }
             );
           }
@@ -1906,10 +1896,34 @@ export default class ChargingStation {
         this.handleUnsupportedVersion(this.getOcppVersion());
         break;
     }
-    this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options);
+
     logger.info(
       this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString()
     );
+
+    this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options);
+
+    // Handle WebSocket message
+    this.wsConnection.on(
+      'message',
+      this.onMessage.bind(this) as (this: WebSocket, data: RawData, isBinary: boolean) => void
+    );
+    // Handle WebSocket error
+    this.wsConnection.on(
+      'error',
+      this.onError.bind(this) as (this: WebSocket, error: Error) => void
+    );
+    // Handle WebSocket close
+    this.wsConnection.on(
+      'close',
+      this.onClose.bind(this) as (this: WebSocket, code: number, reason: Buffer) => void
+    );
+    // Handle WebSocket open
+    this.wsConnection.on('open', this.onOpen.bind(this) as (this: WebSocket) => void);
+    // Handle WebSocket ping
+    this.wsConnection.on('ping', this.onPing.bind(this) as (this: WebSocket, data: Buffer) => void);
+    // Handle WebSocket pong
+    this.wsConnection.on('pong', this.onPong.bind(this) as (this: WebSocket, data: Buffer) => void);
   }
 
   private closeWSConnection(): void {