Apply dependencies update
[e-mobility-charging-stations-simulator.git] / src / charging-station / ChargingStation.ts
index 82aaa25cacd759c62caa45393ae4cabb16a3560e..4ed4e600a9cd412e5f4335b648481d71a605b8a9 100644 (file)
@@ -1,6 +1,42 @@
 // 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 { 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,71 +57,38 @@ 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 Configuration from '../utils/Configuration';
+import Constants from '../utils/Constants';
+import { ACElectricUtils, DCElectricUtils } from '../utils/ElectricUtils';
+import FileUtils from '../utils/FileUtils';
+import logger from '../utils/Logger';
+import Utils from '../utils/Utils';
 import AuthorizedTagsCache from './AuthorizedTagsCache';
 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 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 FileUtils from '../utils/FileUtils';
-import { JsonType } from '../types/JsonType';
-import { MessageType } from '../types/ocpp/MessageType';
+import ChargingStationWorkerBroadcastChannel from './ChargingStationWorkerBroadcastChannel';
+import { MessageChannelUtils } from './MessageChannelUtils';
 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 SharedLRUCache from './SharedLRUCache';
-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';
 
 export default class ChargingStation {
   public hashId!: string;
   public readonly templateFile: string;
   public authorizedTagsCache: AuthorizedTagsCache;
   public stationInfo!: ChargingStationInfo;
+  public stopped: boolean;
   public readonly connectors: Map<number, ConnectorStatus>;
   public ocppConfiguration!: ChargingStationOcppConfiguration;
   public wsConnection!: WebSocket;
@@ -105,11 +108,11 @@ export default class ChargingStation {
   private configuredSupervisionUrl!: URL;
   private wsConnectionRestarted: boolean;
   private autoReconnectRetryCount: number;
-  private stopped: boolean;
   private templateFileWatcher!: fs.FSWatcher;
   private readonly sharedLRUCache: SharedLRUCache;
   private automaticTransactionGenerator!: AutomaticTransactionGenerator;
   private webSocketPingSetInterval!: NodeJS.Timeout;
+  private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel;
 
   constructor(index: number, templateFile: string) {
     this.index = index;
@@ -122,6 +125,8 @@ export default class ChargingStation {
     this.connectors = new Map<number, ConnectorStatus>();
     this.requests = new Map<string, CachedRequest>();
     this.messageBuffer = new Set<string>();
+    this.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this);
+
     this.initialize();
   }
 
@@ -177,6 +182,10 @@ export default class ChargingStation {
     return this.stationInfo.mayAuthorizeAtRemoteStart ?? true;
   }
 
+  public getPayloadSchemaValidation(): boolean | undefined {
+    return this.stationInfo.payloadSchemaValidation ?? true;
+  }
+
   public getNumberOfPhases(stationInfo?: ChargingStationInfo): number | undefined {
     const localStationInfo: ChargingStationInfo = stationInfo ?? this.stationInfo;
     switch (this.getCurrentOutType(stationInfo)) {
@@ -327,22 +336,22 @@ export default class ChargingStation {
     }
   }
 
-  public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined {
+  public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number {
     const transactionConnectorStatus = this.getConnectorStatus(
       this.getConnectorIdByTransactionId(transactionId)
     );
     if (this.getMeteringPerTransaction()) {
-      return transactionConnectorStatus?.transactionEnergyActiveImportRegisterValue;
+      return transactionConnectorStatus?.transactionEnergyActiveImportRegisterValue ?? 0;
     }
-    return transactionConnectorStatus?.energyActiveImportRegisterValue;
+    return transactionConnectorStatus?.energyActiveImportRegisterValue ?? 0;
   }
 
-  public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined {
+  public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number {
     const connectorStatus = this.getConnectorStatus(connectorId);
     if (this.getMeteringPerTransaction()) {
-      return connectorStatus?.transactionEnergyActiveImportRegisterValue;
+      return connectorStatus?.transactionEnergyActiveImportRegisterValue ?? 0;
     }
-    return connectorStatus?.energyActiveImportRegisterValue;
+    return connectorStatus?.energyActiveImportRegisterValue ?? 0;
   }
 
   public getAuthorizeRemoteTxRequests(): boolean {
@@ -507,17 +516,14 @@ export default class ChargingStation {
             // FIXME?: restart heartbeat and WebSocket ping when their interval values have changed
           } catch (error) {
             logger.error(
-              `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error: %j`,
+              `${this.logPrefix()} ${FileType.ChargingStationTemplate} file monitoring error:`,
               error
             );
           }
         }
       }
     );
-    parentPort.postMessage({
-      id: ChargingStationWorkerMessageEvents.STARTED,
-      data: { id: this.stationInfo.chargingStationId },
-    });
+    parentPort.postMessage(MessageChannelUtils.buildStartedMessage(this));
   }
 
   public async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise<void> {
@@ -544,10 +550,7 @@ export default class ChargingStation {
     this.templateFileWatcher.close();
     this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash);
     this.bootNotificationResponse = null;
-    parentPort.postMessage({
-      id: ChargingStationWorkerMessageEvents.STOPPED,
-      data: { id: this.stationInfo.chargingStationId },
-    });
+    parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this));
     this.stopped = true;
   }
 
@@ -860,9 +863,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();
@@ -1399,7 +1400,7 @@ export default class ChargingStation {
             }
             logger.debug(
               `${this.logPrefix()} << Command '${
-                requestCommandName ?? ''
+                requestCommandName ?? 'unknown'
               }' received response payload: ${JSON.stringify(request)}`
             );
             responseCallback(commandPayload, requestPayload);
@@ -1429,7 +1430,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));
@@ -1441,6 +1442,7 @@ export default class ChargingStation {
             logger.error(errMsg);
             throw new OCPPError(ErrorType.PROTOCOL_ERROR, errMsg);
         }
+        parentPort.postMessage(MessageChannelUtils.buildUpdatedMessage(this));
       } else {
         throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not iterable', null, {
           payload: request,
@@ -1449,12 +1451,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:",
         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:",
+          this.logPrefix(),
+          commandName ?? requestCommandName ?? null,
+          data.toString(),
+          error
+        );
+      }
       // Send error
       messageType === MessageType.CALL_MESSAGE &&
         (await this.ocppRequestService.sendError(
@@ -1475,8 +1487,8 @@ export default class ChargingStation {
   }
 
   private onError(error: WSError): void {
-    this.wsConnection.close();
-    logger.error(this.logPrefix() + ' WebSocket error: %j', error);
+    this.closeWSConnection();
+    logger.error(this.logPrefix() + ' WebSocket error:', error);
   }
 
   private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean | undefined {
@@ -1722,7 +1734,7 @@ export default class ChargingStation {
               {
                 connectorId,
                 transactionId,
-                meterValue: transactionEndMeterValue,
+                meterValue: [transactionEndMeterValue],
               }
             );
           }