X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FAutomaticTransactionGenerator.ts;h=dca2e06047699f69190fd7fc2c4ba00f43c55887;hb=32619191f2554bd1839729805dc845aa8737227c;hp=671b0d1b120533bbfb53460c00b867b12cd3d54c;hpb=7807ccf27925add3d65969c31405ece437dc8f03;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/AutomaticTransactionGenerator.ts b/src/charging-station/AutomaticTransactionGenerator.ts index 671b0d1b..dca2e060 100644 --- a/src/charging-station/AutomaticTransactionGenerator.ts +++ b/src/charging-station/AutomaticTransactionGenerator.ts @@ -1,10 +1,15 @@ -// Partial Copyright Jerome Benoit. 2021. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. +import { AsyncResource } from 'async_hooks'; + +import type ChargingStation from './ChargingStation'; +import { ChargingStationUtils } from './ChargingStationUtils'; import BaseError from '../exception/BaseError'; import PerformanceStatistics from '../performance/PerformanceStatistics'; -import type { - AutomaticTransactionGeneratorConfiguration, - Status, +import { + type AutomaticTransactionGeneratorConfiguration, + IdTagDistribution, + type Status, } from '../types/AutomaticTransactionGenerator'; import { RequestCommand } from '../types/ocpp/Requests'; import { @@ -19,9 +24,10 @@ import { import Constants from '../utils/Constants'; import logger from '../utils/Logger'; import Utils from '../utils/Utils'; -import type ChargingStation from './ChargingStation'; -export default class AutomaticTransactionGenerator { +const moduleName = 'AutomaticTransactionGenerator'; + +export default class AutomaticTransactionGenerator extends AsyncResource { private static readonly instances: Map = new Map< string, AutomaticTransactionGenerator @@ -31,14 +37,17 @@ export default class AutomaticTransactionGenerator { public readonly configuration: AutomaticTransactionGeneratorConfiguration; public started: boolean; private readonly chargingStation: ChargingStation; + private idTagIndex: number; private constructor( automaticTransactionGeneratorConfiguration: AutomaticTransactionGeneratorConfiguration, chargingStation: ChargingStation ) { + super(moduleName); this.started = false; this.configuration = automaticTransactionGeneratorConfiguration; this.chargingStation = chargingStation; + this.idTagIndex = 0; this.connectorsStatus = new Map(); this.initializeConnectorsStatus(); } @@ -46,7 +55,7 @@ export default class AutomaticTransactionGenerator { public static getInstance( automaticTransactionGeneratorConfiguration: AutomaticTransactionGeneratorConfiguration, chargingStation: ChargingStation - ): AutomaticTransactionGenerator { + ): AutomaticTransactionGenerator | undefined { if (AutomaticTransactionGenerator.instances.has(chargingStation.stationInfo.hashId) === false) { AutomaticTransactionGenerator.instances.set( chargingStation.stationInfo.hashId, @@ -60,6 +69,9 @@ export default class AutomaticTransactionGenerator { } public start(): void { + if (this.checkChargingStation() === false) { + return; + } if (this.started === true) { logger.warn(`${this.logPrefix()} is already started`); return; @@ -78,16 +90,23 @@ export default class AutomaticTransactionGenerator { } public startConnector(connectorId: number): void { + if (this.checkChargingStation(connectorId) === false) { + return; + } if (this.connectorsStatus.has(connectorId) === false) { - logger.warn(`${this.logPrefix(connectorId)} starting on non existing connector`); + logger.error(`${this.logPrefix(connectorId)} starting on non existing connector`); throw new BaseError(`Connector ${connectorId} does not exist`); } if (this.connectorsStatus.get(connectorId)?.start === false) { - // Avoid hogging the event loop with a busy loop - setImmediate(() => { - this.internalStartConnector(connectorId).catch(() => { - /* This is intentional */ - }); + this.runInAsyncScope( + this.internalStartConnector.bind(this) as ( + this: AutomaticTransactionGenerator, + ...args: any[] + ) => Promise, + this, + connectorId + ).catch(() => { + /* This is intentional */ }); } else if (this.connectorsStatus.get(connectorId)?.start === true) { logger.warn(`${this.logPrefix(connectorId)} is already started on connector`); @@ -96,7 +115,7 @@ export default class AutomaticTransactionGenerator { public stopConnector(connectorId: number): void { if (this.connectorsStatus.has(connectorId) === false) { - logger.warn(`${this.logPrefix(connectorId)} stopping on non existing connector`); + logger.error(`${this.logPrefix(connectorId)} stopping on non existing connector`); throw new BaseError(`Connector ${connectorId} does not exist`); } if (this.connectorsStatus.get(connectorId)?.start === true) { @@ -130,38 +149,39 @@ export default class AutomaticTransactionGenerator { } private async internalStartConnector(connectorId: number): Promise { - this.initializeConnectorStatus(connectorId); - this.connectorsStatus.get(connectorId).start = true; + this.setStartConnectorStatus(connectorId); logger.info( - this.logPrefix(connectorId) + - ' started on connector and will run for ' + - Utils.formatDurationMilliSeconds( - this.connectorsStatus.get(connectorId).stopDate.getTime() - - this.connectorsStatus.get(connectorId).startDate.getTime() - ) + `${this.logPrefix( + connectorId + )} started on connector and will run for ${Utils.formatDurationMilliSeconds( + this.connectorsStatus.get(connectorId).stopDate.getTime() - + this.connectorsStatus.get(connectorId).startDate.getTime() + )}` ); - while (this.connectorsStatus.get(connectorId).start === true) { + while (this.connectorsStatus.get(connectorId)?.start === true) { if (new Date() > this.connectorsStatus.get(connectorId).stopDate) { this.stopConnector(connectorId); break; } - if (!this.chargingStation.isInAcceptedState()) { + if (this.chargingStation.isInAcceptedState() === false) { logger.error( - this.logPrefix(connectorId) + - ' entered in transaction loop while the charging station is not in accepted state' + `${this.logPrefix( + connectorId + )} entered in transaction loop while the charging station is not in accepted state` ); this.stopConnector(connectorId); break; } - if (!this.chargingStation.isChargingStationAvailable()) { + if (this.chargingStation.isChargingStationAvailable() === false) { logger.info( - this.logPrefix(connectorId) + - ' entered in transaction loop while the charging station is unavailable' + `${this.logPrefix( + connectorId + )} entered in transaction loop while the charging station is unavailable` ); this.stopConnector(connectorId); break; } - if (!this.chargingStation.isConnectorAvailable(connectorId)) { + if (this.chargingStation.isConnectorAvailable(connectorId) === false) { logger.info( `${this.logPrefix( connectorId @@ -186,7 +206,7 @@ export default class AutomaticTransactionGenerator { this.configuration.minDelayBetweenTwoTransactions ) * 1000; logger.info( - this.logPrefix(connectorId) + ' waiting for ' + Utils.formatDurationMilliSeconds(wait) + `${this.logPrefix(connectorId)} waiting for ${Utils.formatDurationMilliSeconds(wait)}` ); await Utils.sleep(wait); const start = Utils.secureRandom(); @@ -200,18 +220,18 @@ export default class AutomaticTransactionGenerator { Utils.getRandomInteger(this.configuration.maxDuration, this.configuration.minDuration) * 1000; logger.info( - this.logPrefix(connectorId) + - ' transaction ' + - this.chargingStation.getConnectorStatus(connectorId).transactionId.toString() + - ' started and will stop in ' + - Utils.formatDurationMilliSeconds(waitTrxEnd) + `${this.logPrefix(connectorId)} transaction ${this.chargingStation + .getConnectorStatus(connectorId) + ?.transactionId?.toString()} started and will stop in ${Utils.formatDurationMilliSeconds( + waitTrxEnd + )}` ); await Utils.sleep(waitTrxEnd); // Stop transaction logger.info( - this.logPrefix(connectorId) + - ' stop transaction ' + - this.chargingStation.getConnectorStatus(connectorId).transactionId.toString() + `${this.logPrefix(connectorId)} stop transaction ${this.chargingStation + .getConnectorStatus(connectorId) + ?.transactionId?.toString()}` ); await this.stopTransaction(connectorId); } @@ -219,24 +239,23 @@ export default class AutomaticTransactionGenerator { this.connectorsStatus.get(connectorId).skippedConsecutiveTransactions++; this.connectorsStatus.get(connectorId).skippedTransactions++; logger.info( - this.logPrefix(connectorId) + - ' skipped consecutively ' + - this.connectorsStatus.get(connectorId).skippedConsecutiveTransactions.toString() + - '/' + - this.connectorsStatus.get(connectorId).skippedTransactions.toString() + - ' transaction(s)' + `${this.logPrefix(connectorId)} skipped consecutively ${this.connectorsStatus + .get(connectorId) + ?.skippedConsecutiveTransactions?.toString()}/${this.connectorsStatus + .get(connectorId) + ?.skippedTransactions?.toString()} transaction(s)` ); } this.connectorsStatus.get(connectorId).lastRunDate = new Date(); } this.connectorsStatus.get(connectorId).stoppedDate = new Date(); logger.info( - this.logPrefix(connectorId) + - ' stopped on connector and lasted for ' + - Utils.formatDurationMilliSeconds( - this.connectorsStatus.get(connectorId).stoppedDate.getTime() - - this.connectorsStatus.get(connectorId).startDate.getTime() - ) + `${this.logPrefix( + connectorId + )} stopped on connector and lasted for ${Utils.formatDurationMilliSeconds( + this.connectorsStatus.get(connectorId).stoppedDate.getTime() - + this.connectorsStatus.get(connectorId).startDate.getTime() + )}` ); logger.debug( `${this.logPrefix(connectorId)} connector status: %j`, @@ -244,31 +263,11 @@ export default class AutomaticTransactionGenerator { ); } - private initializeConnectorStatus(connectorId: number): void { - this.connectorsStatus.get(connectorId).authorizeRequests = - this?.connectorsStatus.get(connectorId)?.authorizeRequests ?? 0; - this.connectorsStatus.get(connectorId).acceptedAuthorizeRequests = - this?.connectorsStatus.get(connectorId)?.acceptedAuthorizeRequests ?? 0; - this.connectorsStatus.get(connectorId).rejectedAuthorizeRequests = - this?.connectorsStatus.get(connectorId)?.rejectedAuthorizeRequests ?? 0; - this.connectorsStatus.get(connectorId).startTransactionRequests = - this?.connectorsStatus.get(connectorId)?.startTransactionRequests ?? 0; - this.connectorsStatus.get(connectorId).acceptedStartTransactionRequests = - this?.connectorsStatus.get(connectorId)?.acceptedStartTransactionRequests ?? 0; - this.connectorsStatus.get(connectorId).rejectedStartTransactionRequests = - this?.connectorsStatus.get(connectorId)?.rejectedStartTransactionRequests ?? 0; - this.connectorsStatus.get(connectorId).stopTransactionRequests = - this?.connectorsStatus.get(connectorId)?.stopTransactionRequests ?? 0; - this.connectorsStatus.get(connectorId).acceptedStopTransactionRequests = - this?.connectorsStatus.get(connectorId)?.acceptedStopTransactionRequests ?? 0; - this.connectorsStatus.get(connectorId).rejectedStopTransactionRequests = - this?.connectorsStatus.get(connectorId)?.rejectedStopTransactionRequests ?? 0; + private setStartConnectorStatus(connectorId: number): void { this.connectorsStatus.get(connectorId).skippedConsecutiveTransactions = 0; - this.connectorsStatus.get(connectorId).skippedTransactions = - this?.connectorsStatus.get(connectorId)?.skippedTransactions ?? 0; const previousRunDuration = - this?.connectorsStatus.get(connectorId)?.startDate && - this?.connectorsStatus.get(connectorId)?.lastRunDate + this.connectorsStatus.get(connectorId)?.startDate && + this.connectorsStatus.get(connectorId)?.lastRunDate ? this.connectorsStatus.get(connectorId).lastRunDate.getTime() - this.connectorsStatus.get(connectorId).startDate.getTime() : 0; @@ -281,8 +280,7 @@ export default class AutomaticTransactionGenerator { 1000 - previousRunDuration ); - this.connectorsStatus.get(connectorId).start = - this?.connectorsStatus.get(connectorId)?.start ?? false; + this.connectorsStatus.get(connectorId).start = true; } private initializeConnectorsStatus(): void { @@ -313,7 +311,7 @@ export default class AutomaticTransactionGenerator { const beginId = PerformanceStatistics.beginMeasure(measureId); let startResponse: StartTransactionResponse; if (this.chargingStation.hasAuthorizedTags()) { - const idTag = this.chargingStation.getRandomIdTag(); + const idTag = this.getIdTag(connectorId); const startTransactionLogMsg = `${this.logPrefix( connectorId )} start transaction with an idTag '${idTag}'`; @@ -386,10 +384,10 @@ export default class AutomaticTransactionGenerator { this.connectorsStatus.get(connectorId).rejectedStopTransactionRequests++; } } else { - const transactionId = this.chargingStation.getConnectorStatus(connectorId).transactionId; + const transactionId = this.chargingStation.getConnectorStatus(connectorId)?.transactionId; logger.warn( `${this.logPrefix(connectorId)} stopping a not started transaction${ - transactionId ? ' ' + transactionId.toString() : '' + !Utils.isNullOrUndefined(transactionId) ? ` ${transactionId?.toString()}` : '' }` ); } @@ -401,13 +399,48 @@ export default class AutomaticTransactionGenerator { return this.configuration?.requireAuthorize ?? true; } - private logPrefix(connectorId?: number): string { + private getRandomIdTag(authorizationFile: string): string { + const tags = this.chargingStation.authorizedTagsCache.getAuthorizedTags(authorizationFile); + this.idTagIndex = Math.floor(Utils.secureRandom() * tags.length); + return tags[this.idTagIndex]; + } + + private getRoundRobinIdTag(authorizationFile: string): string { + const tags = this.chargingStation.authorizedTagsCache.getAuthorizedTags(authorizationFile); + const idTag = tags[this.idTagIndex]; + this.idTagIndex = this.idTagIndex === tags.length - 1 ? 0 : this.idTagIndex + 1; + return idTag; + } + + private getConnectorAffinityIdTag(authorizationFile: string, connectorId: number): string { + const tags = this.chargingStation.authorizedTagsCache.getAuthorizedTags(authorizationFile); + this.idTagIndex = (this.chargingStation.index - 1 + (connectorId - 1)) % tags.length; + return tags[this.idTagIndex]; + } + + private getIdTag(connectorId: number): string { + const authorizationFile = ChargingStationUtils.getAuthorizationFile( + this.chargingStation.stationInfo + ); + switch (this.configuration?.idTagDistribution) { + case IdTagDistribution.RANDOM: + return this.getRandomIdTag(authorizationFile); + case IdTagDistribution.ROUND_ROBIN: + return this.getRoundRobinIdTag(authorizationFile); + case IdTagDistribution.CONNECTOR_AFFINITY: + return this.getConnectorAffinityIdTag(authorizationFile, connectorId); + default: + return this.getRoundRobinIdTag(authorizationFile); + } + } + + private logPrefix = (connectorId?: number): string => { return Utils.logPrefix( ` ${this.chargingStation.stationInfo.chargingStationId} | ATG${ connectorId !== undefined ? ` on connector #${connectorId.toString()}` : '' }:` ); - } + }; private handleStartTransactionResponse( connectorId: number, @@ -417,8 +450,16 @@ export default class AutomaticTransactionGenerator { if (startResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) { this.connectorsStatus.get(connectorId).acceptedStartTransactionRequests++; } else { - logger.warn(this.logPrefix(connectorId) + ' start transaction rejected'); + logger.warn(`${this.logPrefix(connectorId)} start transaction rejected`); this.connectorsStatus.get(connectorId).rejectedStartTransactionRequests++; } } + + private checkChargingStation(connectorId?: number): boolean { + if (this.chargingStation.started === false && this.chargingStation.starting === false) { + logger.warn(`${this.logPrefix(connectorId)} charging station is stopped, cannot proceed`); + return false; + } + return true; + } }