X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FChargingStation.ts;h=89fffc3bffc03b3399837d211a9d8d31ea5411c3;hb=18057587414006953ed112f315807d64ddb11bfd;hp=064e33ad805a19ac5063d8175e5747c9bda88689;hpb=fec4d204dd05c108fb49312bb7a570d15a4eb4bb;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts index 064e33ad..89fffc3b 100644 --- a/src/charging-station/ChargingStation.ts +++ b/src/charging-station/ChargingStation.ts @@ -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 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, { + CurrentType, + PowerUnits, + WsOptions, +} from '../types/ChargingStationTemplate'; +import { SupervisionUrlDistribution } from '../types/ConfigurationData'; +import type { ConnectorStatus } from '../types/ConnectorStatus'; +import { FileType } from '../types/FileType'; +import type { 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,100 +57,75 @@ import { Response, StatusNotificationResponse, } from '../types/ocpp/Responses'; -import { ChargingProfile, ChargingRateUnitType } from '../types/ocpp/ChargingProfile'; -import ChargingStationConfiguration, { Section } from '../types/ChargingStationConfiguration'; -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 { WSError, WebSocketCloseEventStatusCode } from '../types/WebSocket'; -import WebSocket, { Data, OPEN, 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 { 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 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 { SupervisionUrlDistribution } from '../types/ConfigurationData'; -import { URL } from 'url'; -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 type OCPPIncomingRequestService from './ocpp/OCPPIncomingRequestService'; +import type OCPPRequestService from './ocpp/OCPPRequestService'; +import SharedLRUCache from './SharedLRUCache'; export default class ChargingStation { - public hashId!: string; public readonly templateFile: string; - public authorizedTags: string[]; public stationInfo!: ChargingStationInfo; - public readonly connectors: Map; + public stopped: boolean; + public authorizedTagsCache: AuthorizedTagsCache; + public automaticTransactionGenerator!: AutomaticTransactionGenerator; public ocppConfiguration!: ChargingStationOcppConfiguration; public wsConnection!: WebSocket; + public readonly connectors: Map; public readonly requests: Map; public performanceStatistics!: PerformanceStatistics; public heartbeatSetInterval!: NodeJS.Timeout; public ocppRequestService!: OCPPRequestService; + public bootNotificationRequest!: BootNotificationRequest; public bootNotificationResponse!: BootNotificationResponse | null; public powerDivider!: number; private readonly index: number; private configurationFile!: string; - private bootNotificationRequest!: BootNotificationRequest; + private configurationFileHash!: string; private connectorsConfigurationHash!: string; private ocppIncomingRequestService!: OCPPIncomingRequestService; private readonly messageBuffer: Set; private configuredSupervisionUrl!: URL; private wsConnectionRestarted: boolean; private autoReconnectRetryCount: number; - private stopped: boolean; - private automaticTransactionGenerator!: AutomaticTransactionGenerator; + private templateFileWatcher!: fs.FSWatcher; + private readonly sharedLRUCache: SharedLRUCache; private webSocketPingSetInterval!: NodeJS.Timeout; + private readonly chargingStationWorkerBroadcastChannel: ChargingStationWorkerBroadcastChannel; constructor(index: number, templateFile: string) { this.index = index; this.templateFile = templateFile; - this.stopped = false; - this.wsConnectionRestarted = false; - this.autoReconnectRetryCount = 0; this.connectors = new Map(); this.requests = new Map(); this.messageBuffer = new Set(); + this.sharedLRUCache = SharedLRUCache.getInstance(); + this.authorizedTagsCache = AuthorizedTagsCache.getInstance(); + this.chargingStationWorkerBroadcastChannel = new ChargingStationWorkerBroadcastChannel(this); + this.stopped = false; + this.wsConnectionRestarted = false; + this.autoReconnectRetryCount = 0; + this.initialize(); } @@ -140,17 +151,20 @@ export default class ChargingStation { ); } - public getBootNotificationRequest(): BootNotificationRequest { - return this.bootNotificationRequest; - } - 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 { @@ -159,8 +173,12 @@ export default class ChargingStation { : true; } - public getMayAuthorizeAtRemoteStart(): boolean | undefined { - return this.stationInfo.mayAuthorizeAtRemoteStart ?? true; + public getMustAuthorizeAtRemoteStart(): boolean | undefined { + return this.stationInfo.mustAuthorizeAtRemoteStart ?? true; + } + + public getPayloadSchemaValidation(): boolean | undefined { + return this.stationInfo.payloadSchemaValidation ?? true; } public getNumberOfPhases(stationInfo?: ChargingStationInfo): number | undefined { @@ -176,7 +194,7 @@ export default class ChargingStation { } public isWebSocketConnectionOpened(): boolean { - return this?.wsConnection?.readyState === OPEN; + return this?.wsConnection?.readyState === WebSocket.OPEN; } public getRegistrationStatus(): RegistrationStatus { @@ -313,22 +331,18 @@ export default class ChargingStation { } } - public getEnergyActiveImportRegisterByTransactionId(transactionId: number): number | undefined { - const transactionConnectorStatus = this.getConnectorStatus( - this.getConnectorIdByTransactionId(transactionId) + public getEnergyActiveImportRegisterByTransactionId( + transactionId: number, + meterStop = false + ): number { + return this.getEnergyActiveImportRegister( + this.getConnectorStatus(this.getConnectorIdByTransactionId(transactionId)), + meterStop ); - if (this.getMeteringPerTransaction()) { - return transactionConnectorStatus?.transactionEnergyActiveImportRegisterValue; - } - return transactionConnectorStatus?.energyActiveImportRegisterValue; } - public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number | undefined { - const connectorStatus = this.getConnectorStatus(connectorId); - if (this.getMeteringPerTransaction()) { - return connectorStatus?.transactionEnergyActiveImportRegisterValue; - } - return connectorStatus?.energyActiveImportRegisterValue; + public getEnergyActiveImportRegisterByConnectorId(connectorId: number): number { + return this.getEnergyActiveImportRegister(this.getConnectorStatus(connectorId)); } public getAuthorizeRemoteTxRequests(): boolean { @@ -465,36 +479,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( - 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, @@ -507,11 +493,14 @@ export default class ChargingStation { this.templateFile } file have changed, reload` ); + this.sharedLRUCache.deleteChargingStationTemplate(this.stationInfo?.templateHash); // Initialize this.initialize(); // Restart the ATG this.stopAutomaticTransactionGenerator(); - this.startAutomaticTransactionGenerator(); + if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable) { + this.startAutomaticTransactionGenerator(); + } if (this.getEnableStatistics()) { this.performanceStatistics.restart(); } else { @@ -520,17 +509,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 { @@ -549,18 +535,16 @@ export default class ChargingStation { this.getConnectorStatus(connectorId).status = ChargePointStatus.UNAVAILABLE; } } - if (this.isWebSocketConnectionOpened()) { - this.wsConnection.close(); - } + 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; - parentPort.postMessage({ - id: ChargingStationWorkerMessageEvents.STOPPED, - data: { id: this.stationInfo.chargingStationId }, - }); this.stopped = true; + parentPort.postMessage(MessageChannelUtils.buildStoppedMessage(this)); } public async reset(reason?: StopTransactionReason): Promise { @@ -572,7 +556,7 @@ export default class ChargingStation { public saveOcppConfiguration(): void { if (this.getOcppPersistentConfiguration()) { - this.saveConfiguration(Section.ocppConfiguration); + this.saveConfiguration(); } } @@ -592,7 +576,7 @@ export default class ChargingStation { if (!Utils.isEmptyArray(chargingProfiles)) { const result = ChargingStationUtils.getLimitFromChargingProfiles( chargingProfiles, - Utils.logPrefix() + this.logPrefix() ); if (!Utils.isNullOrUndefined(result)) { limit = result.limit; @@ -635,7 +619,7 @@ export default class ChargingStation { ); this.getConnectorStatus(connectorId).chargingProfiles = []; } - if (!Array.isArray(this.getConnectorStatus(connectorId).chargingProfiles)) { + if (Array.isArray(this.getConnectorStatus(connectorId).chargingProfiles) === false) { logger.error( `${this.logPrefix()} Trying to set a charging profile on connectorId ${connectorId} with an improper attribute type for the charging profiles array, applying proper type initialization` ); @@ -684,7 +668,109 @@ export default class ChargingStation { this.messageBuffer.add(message); } - private flushMessageBuffer() { + public openWSConnection( + options: WsOptions = this.stationInfo?.wsOptions ?? {}, + params: { closeOpened?: boolean; terminateOpened?: boolean } = { + closeOpened: false, + terminateOpened: false, + } + ): void { + options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; + params.closeOpened = params?.closeOpened ?? false; + params.terminateOpened = params?.terminateOpened ?? false; + if ( + !Utils.isNullOrUndefined(this.stationInfo.supervisionUser) && + !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword) + ) { + options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`; + } + if (params?.closeOpened) { + this.closeWSConnection(); + } + if (params?.terminateOpened) { + this.terminateWSConnection(); + } + let protocol: string; + switch (this.getOcppVersion()) { + case OCPPVersion.VERSION_16: + protocol = 'ocpp' + OCPPVersion.VERSION_16; + break; + default: + this.handleUnsupportedVersion(this.getOcppVersion()); + break; + } + + if (this.isWebSocketConnectionOpened()) { + logger.warn( + `${this.logPrefix()} OCPP connection to URL ${this.wsConnectionUrl.toString()} is already opened` + ); + return; + } + + 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); + } + + public closeWSConnection(): void { + if (this.isWebSocketConnectionOpened()) { + this.wsConnection.close(); + this.wsConnection = null; + } + } + + public startAutomaticTransactionGenerator(connectorIds?: number[]): void { + if (!this.automaticTransactionGenerator) { + this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance( + this.getAutomaticTransactionGeneratorConfigurationFromTemplate(), + this + ); + } + if (!Utils.isEmptyArray(connectorIds)) { + for (const connectorId of connectorIds) { + this.automaticTransactionGenerator.startConnector(connectorId); + } + } else { + this.automaticTransactionGenerator.start(); + } + } + + public stopAutomaticTransactionGenerator(connectorIds?: number[]): void { + if (!Utils.isEmptyArray(connectorIds)) { + for (const connectorId of connectorIds) { + this.automaticTransactionGenerator?.stopConnector(connectorId); + } + } else { + this.automaticTransactionGenerator?.stop(); + this.automaticTransactionGenerator = null; + } + } + + private flushMessageBuffer(): void { if (this.messageBuffer.size > 0) { this.messageBuffer.forEach((message) => { // TODO: evaluate the need to track performance @@ -705,14 +791,21 @@ export default class ChargingStation { private getTemplateFromFile(): ChargingStationTemplate | null { let template: ChargingStationTemplate = null; try { - const measureId = `${FileType.ChargingStationTemplate} read`; - const beginId = PerformanceStatistics.beginMeasure(measureId); - template = JSON.parse(fs.readFileSync(this.templateFile, 'utf8')) as ChargingStationTemplate; - PerformanceStatistics.endMeasure(measureId, beginId); - template.templateHash = crypto - .createHash(Constants.DEFAULT_HASH_ALGORITHM) - .update(JSON.stringify(template)) - .digest('hex'); + 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); + template = JSON.parse( + fs.readFileSync(this.templateFile, 'utf8') + ) as ChargingStationTemplate; + PerformanceStatistics.endMeasure(measureId, beginId); + template.templateHash = crypto + .createHash(Constants.DEFAULT_HASH_ALGORITHM) + .update(JSON.stringify(template)) + .digest('hex'); + this.sharedLRUCache.setChargingStationTemplate(template); + } } catch (error) { FileUtils.handleFileException( this.logPrefix(), @@ -751,6 +844,7 @@ export default class ChargingStation { ); const stationInfo: ChargingStationInfo = ChargingStationUtils.stationTemplateToStationInfo(stationTemplate); + stationInfo.hashId = ChargingStationUtils.getHashId(this.index, stationTemplate); stationInfo.chargingStationId = ChargingStationUtils.getChargingStationId( this.index, stationTemplate @@ -780,14 +874,14 @@ export default class ChargingStation { ChargingStationUtils.checkConfiguredMaxConnectors( configuredMaxConnectors, this.templateFile, - Utils.logPrefix() + this.logPrefix() ); const templateMaxConnectors = ChargingStationUtils.getTemplateMaxNumberOfConnectors(stationTemplate); ChargingStationUtils.checkTemplateMaxConnectors( templateMaxConnectors, this.templateFile, - Utils.logPrefix() + this.logPrefix() ); if ( configuredMaxConnectors > @@ -837,7 +931,7 @@ export default class ChargingStation { private saveStationInfo(): void { if (this.getStationInfoPersistentConfiguration()) { - this.saveConfiguration(Section.stationInfo); + this.saveConfiguration(); } } @@ -854,30 +948,25 @@ export default class ChargingStation { } private handleUnsupportedVersion(version: OCPPVersion) { - const errMsg = `${this.logPrefix()} Unsupported protocol version '${version}' configured in template file ${ - this.templateFile - }`; - logger.error(errMsg); - throw new Error(errMsg); + const errMsg = `Unsupported protocol version '${version}' configured in template file ${this.templateFile}`; + logger.error(`${this.logPrefix()} ${errMsg}`); + throw new BaseError(errMsg); } private initialize(): void { - this.hashId = ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile()); - logger.info(`${this.logPrefix()} Charging station hashId '${this.hashId}'`); this.configurationFile = path.join( - path.resolve(__dirname, '../'), - 'assets', - 'configurations', - this.hashId + '.json' + path.dirname(this.templateFile.replace('station-templates', 'configurations')), + ChargingStationUtils.getHashId(this.index, this.getTemplateFromFile()) + '.json' ); this.stationInfo = this.getStationInfo(); this.saveStationInfo(); + logger.info(`${this.logPrefix()} Charging station hashId '${this.stationInfo.hashId}'`); // Avoid duplication of connectors related information in RAM this.stationInfo?.Connectors && delete this.stationInfo.Connectors; this.configuredSupervisionUrl = this.getConfiguredSupervisionUrl(); if (this.getEnableStatistics()) { this.performanceStatistics = PerformanceStatistics.getInstance( - this.hashId, + this.stationInfo.hashId, this.stationInfo.chargingStationId, this.configuredSupervisionUrl ); @@ -885,11 +974,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(); @@ -906,7 +990,7 @@ export default class ChargingStation { this.handleUnsupportedVersion(this.getOcppVersion()); break; } - if (this.stationInfo.autoRegister) { + if (this.stationInfo?.autoRegister) { this.bootNotificationResponse = { currentTime: new Date().toISOString(), interval: this.getHeartbeatInterval() / 1000, @@ -1083,10 +1167,8 @@ export default class ChargingStation { 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); + const logMsg = `No already defined connectors and charging station information from template ${this.templateFile} with no connectors configuration defined`; + logger.error(`${this.logPrefix()} ${logMsg}`); throw new BaseError(logMsg); } if (!stationInfo?.Connectors[0]) { @@ -1161,12 +1243,20 @@ export default class ChargingStation { let configuration: ChargingStationConfiguration = null; if (this.configurationFile && fs.existsSync(this.configurationFile)) { try { - const measureId = `${FileType.ChargingStationConfiguration} read`; - const beginId = PerformanceStatistics.beginMeasure(measureId); - configuration = JSON.parse( - fs.readFileSync(this.configurationFile, 'utf8') - ) as ChargingStationConfiguration; - PerformanceStatistics.endMeasure(measureId, beginId); + if (this.sharedLRUCache.hasChargingStationConfiguration(this.configurationFileHash)) { + configuration = this.sharedLRUCache.getChargingStationConfiguration( + this.configurationFileHash + ); + } else { + const measureId = `${FileType.ChargingStationConfiguration} read`; + const beginId = PerformanceStatistics.beginMeasure(measureId); + configuration = JSON.parse( + fs.readFileSync(this.configurationFile, 'utf8') + ) as ChargingStationConfiguration; + PerformanceStatistics.endMeasure(measureId, beginId); + this.configurationFileHash = configuration.configurationHash; + this.sharedLRUCache.setChargingStationConfiguration(configuration); + } } catch (error) { FileUtils.handleFileException( this.logPrefix(), @@ -1179,7 +1269,7 @@ export default class ChargingStation { return configuration; } - private saveConfiguration(section?: Section): void { + private saveConfiguration(): void { if (this.configurationFile) { try { if (!fs.existsSync(path.dirname(this.configurationFile))) { @@ -1187,34 +1277,32 @@ export default class ChargingStation { } const configurationData: ChargingStationConfiguration = this.getConfigurationFromFile() ?? {}; - switch (section) { - case Section.ocppConfiguration: - configurationData.configurationKey = this.ocppConfiguration.configurationKey; - break; - case Section.stationInfo: - if (configurationData?.stationInfo?.infoHash === this.stationInfo?.infoHash) { - logger.debug( - `${this.logPrefix()} Not saving unchanged charging station information to configuration file ${ - this.configurationFile - }` - ); - return; - } - configurationData.stationInfo = this.stationInfo; - break; - default: - configurationData.configurationKey = this.ocppConfiguration.configurationKey; - if (configurationData?.stationInfo?.infoHash !== this.stationInfo?.infoHash) { - configurationData.stationInfo = this.stationInfo; - } - break; + this.ocppConfiguration?.configurationKey && + (configurationData.configurationKey = this.ocppConfiguration.configurationKey); + this.stationInfo && (configurationData.stationInfo = this.stationInfo); + delete configurationData.configurationHash; + const configurationHash = crypto + .createHash(Constants.DEFAULT_HASH_ALGORITHM) + .update(JSON.stringify(configurationData)) + .digest('hex'); + if (this.configurationFileHash !== configurationHash) { + configurationData.configurationHash = configurationHash; + const measureId = `${FileType.ChargingStationConfiguration} write`; + const beginId = PerformanceStatistics.beginMeasure(measureId); + const fileDescriptor = fs.openSync(this.configurationFile, 'w'); + fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8'); + fs.closeSync(fileDescriptor); + PerformanceStatistics.endMeasure(measureId, beginId); + this.sharedLRUCache.deleteChargingStationConfiguration(this.configurationFileHash); + this.configurationFileHash = configurationHash; + this.sharedLRUCache.setChargingStationConfiguration(configurationData); + } else { + logger.debug( + `${this.logPrefix()} Not saving unchanged charging station configuration file ${ + this.configurationFile + }` + ); } - const measureId = `${FileType.ChargingStationConfiguration} write`; - const beginId = PerformanceStatistics.beginMeasure(measureId); - const fileDescriptor = fs.openSync(this.configurationFile, 'w'); - fs.writeFileSync(fileDescriptor, JSON.stringify(configurationData, null, 2), 'utf8'); - fs.closeSync(fileDescriptor); - PerformanceStatistics.endMeasure(measureId, beginId); } catch (error) { FileUtils.handleFileException( this.logPrefix(), @@ -1354,7 +1442,7 @@ export default class ChargingStation { let errMsg: string; try { const request = JSON.parse(data.toString()) as IncomingRequest | Response | ErrorResponse; - if (Utils.isIterable(request)) { + if (Array.isArray(request) === true) { [messageType, messageId] = request; // Check the type of message switch (messageType) { @@ -1391,19 +1479,19 @@ export default class ChargingStation { } // Respond cachedRequest = this.requests.get(messageId); - if (Utils.isIterable(cachedRequest)) { + if (Array.isArray(cachedRequest) === true) { [responseCallback, , requestCommandName, requestPayload] = cachedRequest; } else { throw new OCPPError( ErrorType.PROTOCOL_ERROR, - `Cached request for message id ${messageId} response is not iterable`, + `Cached request for message id ${messageId} response is not an array`, null, cachedRequest as unknown as JsonType ); } logger.debug( `${this.logPrefix()} << Command '${ - requestCommandName ?? '' + requestCommandName ?? 'unknown' }' received response payload: ${JSON.stringify(request)}` ); responseCallback(commandPayload, requestPayload); @@ -1421,19 +1509,19 @@ export default class ChargingStation { ); } cachedRequest = this.requests.get(messageId); - if (Utils.isIterable(cachedRequest)) { + if (Array.isArray(cachedRequest) === true) { [, errorCallback, requestCommandName] = cachedRequest; } else { throw new OCPPError( ErrorType.PROTOCOL_ERROR, - `Cached request for message id ${messageId} error response is not iterable`, + `Cached request for message id ${messageId} error response is not an array`, null, cachedRequest as unknown as JsonType ); } logger.debug( `${this.logPrefix()} << Command '${ - requestCommandName ?? '' + requestCommandName ?? 'unknown' }' received error payload: ${JSON.stringify(request)}` ); errorCallback(new OCPPError(errorType, errorMessage, requestCommandName, errorDetails)); @@ -1441,24 +1529,34 @@ export default class ChargingStation { // Error default: // eslint-disable-next-line @typescript-eslint/restrict-template-expressions - errMsg = `${this.logPrefix()} Wrong message type ${messageType}`; - logger.error(errMsg); + errMsg = `Wrong message type ${messageType}`; + logger.error(`${this.logPrefix()} ${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, { + throw new OCPPError(ErrorType.PROTOCOL_ERROR, 'Incoming message is not an array', null, { payload: request, }); } } catch (error) { // Log logger.error( - '%s Incoming OCPP message %j matching cached request %j processing error %j', - this.logPrefix(), - data.toString(), - this.requests.get(messageId), + `${this.logPrefix()} Incoming OCPP command '${ + commandName ?? requestCommandName ?? null + }' message '${data.toString()}' matching cached request '${JSON.stringify( + this.requests.get(messageId) + )}' processing error:`, error ); + if (!(error instanceof OCPPError)) { + logger.warn( + `${this.logPrefix()} Error thrown at incoming OCPP command '${ + commandName ?? requestCommandName ?? null + }' message '${data.toString()}' handling is not an OCPPError:`, + error + ); + } // Send error messageType === MessageType.CALL_MESSAGE && (await this.ocppRequestService.sendError( @@ -1479,7 +1577,26 @@ export default class ChargingStation { } private onError(error: WSError): void { - logger.error(this.logPrefix() + ' WebSocket error: %j', error); + this.closeWSConnection(); + logger.error(this.logPrefix() + ' WebSocket error:', error); + } + + private getEnergyActiveImportRegister( + connectorStatus: ConnectorStatus, + meterStop = false + ): number { + if (this.getMeteringPerTransaction()) { + return ( + (meterStop === true + ? Math.round(connectorStatus?.transactionEnergyActiveImportRegisterValue) + : connectorStatus?.transactionEnergyActiveImportRegisterValue) ?? 0 + ); + } + return ( + (meterStop === true + ? Math.round(connectorStatus?.energyActiveImportRegisterValue) + : connectorStatus?.energyActiveImportRegisterValue) ?? 0 + ); } private getUseConnectorId0(stationInfo?: ChargingStationInfo): boolean | undefined { @@ -1585,7 +1702,7 @@ export default class ChargingStation { } private async startMessageSequence(): Promise { - if (this.stationInfo.autoRegister) { + if (this.stationInfo?.autoRegister) { await this.ocppRequestService.requestHandler< BootNotificationRequest, BootNotificationResponse @@ -1670,27 +1787,8 @@ export default class ChargingStation { } } // Start the ATG - this.startAutomaticTransactionGenerator(); - } - - private startAutomaticTransactionGenerator() { if (this.getAutomaticTransactionGeneratorConfigurationFromTemplate()?.enable) { - if (!this.automaticTransactionGenerator) { - this.automaticTransactionGenerator = AutomaticTransactionGenerator.getInstance( - this.getAutomaticTransactionGeneratorConfigurationFromTemplate(), - this - ); - } - if (!this.automaticTransactionGenerator.started) { - this.automaticTransactionGenerator.start(); - } - } - } - - private stopAutomaticTransactionGenerator(): void { - if (this.automaticTransactionGenerator?.started) { - this.automaticTransactionGenerator.stop(); - this.automaticTransactionGenerator = null; + this.startAutomaticTransactionGenerator(); } } @@ -1702,42 +1800,44 @@ export default class ChargingStation { // Stop heartbeat this.stopHeartbeat(); // Stop ongoing transactions - if (this.automaticTransactionGenerator?.configuration?.enable) { - this.stopAutomaticTransactionGenerator(); - } else { - for (const connectorId of this.connectors.keys()) { - if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) { - const transactionId = this.getConnectorStatus(connectorId).transactionId; - if ( - this.getBeginEndMeterValues() && - this.getOcppStrictCompliance() && - !this.getOutOfOrderEndMeterValues() - ) { - // FIXME: Implement OCPP version agnostic helpers - const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue( - this, - connectorId, - this.getEnergyActiveImportRegisterByTransactionId(transactionId) - ); - await this.ocppRequestService.requestHandler( - this, - RequestCommand.METER_VALUES, - { + if (this.getNumberOfRunningTransactions() > 0) { + if (this.automaticTransactionGenerator?.started) { + this.stopAutomaticTransactionGenerator(); + } else { + for (const connectorId of this.connectors.keys()) { + if (connectorId > 0 && this.getConnectorStatus(connectorId)?.transactionStarted) { + const transactionId = this.getConnectorStatus(connectorId).transactionId; + if ( + this.getBeginEndMeterValues() && + this.getOcppStrictCompliance() && + !this.getOutOfOrderEndMeterValues() + ) { + // FIXME: Implement OCPP version agnostic helpers + const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue( + this, connectorId, - transactionId, - meterValue: transactionEndMeterValue, - } - ); + this.getEnergyActiveImportRegisterByTransactionId(transactionId) + ); + await this.ocppRequestService.requestHandler( + this, + RequestCommand.METER_VALUES, + { + connectorId, + transactionId, + meterValue: [transactionEndMeterValue], + } + ); + } + await this.ocppRequestService.requestHandler< + StopTransactionRequest, + StopTransactionResponse + >(this, RequestCommand.STOP_TRANSACTION, { + transactionId, + meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId, true), + idTag: this.getTransactionIdTag(transactionId), + reason, + }); } - await this.ocppRequestService.requestHandler< - StopTransactionRequest, - StopTransactionResponse - >(this, RequestCommand.STOP_TRANSACTION, { - transactionId, - meterStop: this.getEnergyActiveImportRegisterByTransactionId(transactionId), - idTag: this.getTransactionIdTag(transactionId), - reason, - }); } } } @@ -1844,7 +1944,7 @@ export default class ChargingStation { if (HeartBeatInterval) { return Utils.convertToInt(HeartBeatInterval.value) * 1000; } - !this.stationInfo.autoRegister && + !this.stationInfo?.autoRegister && logger.warn( `${this.logPrefix()} Heartbeat interval configuration key not set, using default value: ${ Constants.DEFAULT_HEARTBEAT_INTERVAL @@ -1859,33 +1959,11 @@ export default class ChargingStation { } } - private openWSConnection( - options: WsOptions = this.stationInfo?.wsOptions ?? {}, - forceCloseOpened = false - ): void { - options.handshakeTimeout = options?.handshakeTimeout ?? this.getConnectionTimeout() * 1000; - if ( - !Utils.isNullOrUndefined(this.stationInfo.supervisionUser) && - !Utils.isNullOrUndefined(this.stationInfo.supervisionPassword) - ) { - options.auth = `${this.stationInfo.supervisionUser}:${this.stationInfo.supervisionPassword}`; - } - if (this.isWebSocketConnectionOpened() && forceCloseOpened) { - this.wsConnection.close(); - } - let protocol: string; - switch (this.getOcppVersion()) { - case OCPPVersion.VERSION_16: - protocol = 'ocpp' + OCPPVersion.VERSION_16; - break; - default: - this.handleUnsupportedVersion(this.getOcppVersion()); - break; + private terminateWSConnection(): void { + if (this.isWebSocketConnectionOpened()) { + this.wsConnection.terminate(); + this.wsConnection = null; } - this.wsConnection = new WebSocket(this.wsConnectionUrl, protocol, options); - logger.info( - this.logPrefix() + ' Open OCPP connection to URL ' + this.wsConnectionUrl.toString() - ); } private stopMeterValues(connectorId: number) { @@ -1917,7 +1995,11 @@ export default class ChargingStation { const reconnectDelay = this.getReconnectExponentialDelay() ? Utils.exponentialDelay(this.autoReconnectRetryCount) : this.getConnectionTimeout() * 1000; - const reconnectTimeout = reconnectDelay - 100 > 0 && reconnectDelay; + const reconnectDelayWithdraw = 1000; + const reconnectTimeout = + reconnectDelay && reconnectDelay - reconnectDelayWithdraw > 0 + ? reconnectDelay - reconnectDelayWithdraw + : 0; logger.error( `${this.logPrefix()} WebSocket: connection retry in ${Utils.roundTo( reconnectDelay, @@ -1932,7 +2014,7 @@ export default class ChargingStation { ); this.openWSConnection( { ...(this.stationInfo?.wsOptions ?? {}), handshakeTimeout: reconnectTimeout }, - true + { closeOpened: true } ); this.wsConnectionRestarted = true; } else if (this.getAutoReconnectMaxRetries() !== -1) {