X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FAutomaticTransactionGenerator.ts;h=477a8d9c824f2922cb178631d5156ee840a96878;hb=56c298254011750a08c6be90d94c098c31f6bdc3;hp=e29ad4b839ac1286a1bfde585b317313c20d4d43;hpb=cbf9b87853619abe4cd79659b3e56bb8b1d6871b;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/AutomaticTransactionGenerator.ts b/src/charging-station/AutomaticTransactionGenerator.ts index e29ad4b8..477a8d9c 100644 --- a/src/charging-station/AutomaticTransactionGenerator.ts +++ b/src/charging-station/AutomaticTransactionGenerator.ts @@ -1,75 +1,62 @@ -// Partial Copyright Jerome Benoit. 2021. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. -import { AsyncResource } from 'async_hooks'; +import { AsyncResource } from 'node:async_hooks'; -import BaseError from '../exception/BaseError'; -import PerformanceStatistics from '../performance/PerformanceStatistics'; -import { - type AutomaticTransactionGeneratorConfiguration, - IdTagDistribution, - type Status, -} from '../types/AutomaticTransactionGenerator'; -import { RequestCommand } from '../types/ocpp/Requests'; +import type { ChargingStation } from './ChargingStation'; +import { ChargingStationUtils } from './ChargingStationUtils'; +import { IdTagsCache } from './IdTagsCache'; +import { BaseError } from '../exception'; +import { PerformanceStatistics } from '../performance'; import { AuthorizationStatus, type AuthorizeRequest, type AuthorizeResponse, + ConnectorStatusEnum, + RequestCommand, type StartTransactionRequest, type StartTransactionResponse, + type Status, StopTransactionReason, type StopTransactionResponse, -} from '../types/ocpp/Transaction'; -import Constants from '../utils/Constants'; -import logger from '../utils/Logger'; -import Utils from '../utils/Utils'; -import type ChargingStation from './ChargingStation'; -import { ChargingStationUtils } from './ChargingStationUtils'; +} from '../types'; +import { Constants, Utils, logger } from '../utils'; const moduleName = 'AutomaticTransactionGenerator'; -export default class AutomaticTransactionGenerator extends AsyncResource { +export class AutomaticTransactionGenerator extends AsyncResource { private static readonly instances: Map = new Map< string, AutomaticTransactionGenerator >(); public readonly connectorsStatus: Map; - public readonly configuration: AutomaticTransactionGeneratorConfiguration; public started: boolean; private readonly chargingStation: ChargingStation; - private idTagIndex: number; - private constructor( - automaticTransactionGeneratorConfiguration: AutomaticTransactionGeneratorConfiguration, - chargingStation: ChargingStation - ) { + private constructor(chargingStation: ChargingStation) { super(moduleName); this.started = false; - this.configuration = automaticTransactionGeneratorConfiguration; this.chargingStation = chargingStation; - this.idTagIndex = 0; this.connectorsStatus = new Map(); this.initializeConnectorsStatus(); } public static getInstance( - automaticTransactionGeneratorConfiguration: AutomaticTransactionGeneratorConfiguration, chargingStation: ChargingStation - ): AutomaticTransactionGenerator { + ): AutomaticTransactionGenerator | undefined { if (AutomaticTransactionGenerator.instances.has(chargingStation.stationInfo.hashId) === false) { AutomaticTransactionGenerator.instances.set( chargingStation.stationInfo.hashId, - new AutomaticTransactionGenerator( - automaticTransactionGeneratorConfiguration, - chargingStation - ) + new AutomaticTransactionGenerator(chargingStation) ); } return AutomaticTransactionGenerator.instances.get(chargingStation.stationInfo.hashId); } public start(): void { - if (this.checkChargingStation() === false) { + if ( + ChargingStationUtils.checkChargingStation(this.chargingStation, this.logPrefix()) === false + ) { return; } if (this.started === true) { @@ -90,7 +77,12 @@ export default class AutomaticTransactionGenerator extends AsyncResource { } public startConnector(connectorId: number): void { - if (this.checkChargingStation(connectorId) === false) { + if ( + ChargingStationUtils.checkChargingStation( + this.chargingStation, + this.logPrefix(connectorId) + ) === false + ) { return; } if (this.connectorsStatus.has(connectorId) === false) { @@ -105,9 +97,7 @@ export default class AutomaticTransactionGenerator extends AsyncResource { ) => Promise, this, connectorId - ).catch(() => { - /* This is intentional */ - }); + ).catch(Constants.EMPTY_FUNCTION); } else if (this.connectorsStatus.get(connectorId)?.start === true) { logger.warn(`${this.logPrefix(connectorId)} is already started on connector`); } @@ -133,17 +123,37 @@ export default class AutomaticTransactionGenerator extends AsyncResource { this.connectorsStatus.clear(); this.initializeConnectorsStatus(); } - for (const connectorId of this.chargingStation.connectors.keys()) { - if (connectorId > 0) { - this.startConnector(connectorId); + if (this.chargingStation.hasEvses) { + for (const [evseId, evseStatus] of this.chargingStation.evses) { + if (evseId > 0) { + for (const connectorId of evseStatus.connectors.keys()) { + this.startConnector(connectorId); + } + } + } + } else { + for (const connectorId of this.chargingStation.connectors.keys()) { + if (connectorId > 0) { + this.startConnector(connectorId); + } } } } private stopConnectors(): void { - for (const connectorId of this.chargingStation.connectors.keys()) { - if (connectorId > 0) { - this.stopConnector(connectorId); + if (this.chargingStation.hasEvses) { + for (const [evseId, evseStatus] of this.chargingStation.evses) { + if (evseId > 0) { + for (const connectorId of evseStatus.connectors.keys()) { + this.stopConnector(connectorId); + } + } + } + } else { + for (const connectorId of this.chargingStation.connectors.keys()) { + if (connectorId > 0) { + this.stopConnector(connectorId); + } } } } @@ -151,30 +161,32 @@ export default class AutomaticTransactionGenerator extends AsyncResource { private async internalStartConnector(connectorId: number): Promise { 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() === false) { + if (this.chargingStation.inAcceptedState() === 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() === 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; @@ -188,6 +200,18 @@ export default class AutomaticTransactionGenerator extends AsyncResource { this.stopConnector(connectorId); break; } + if ( + this.chargingStation.getConnectorStatus(connectorId)?.status === + ConnectorStatusEnum.Unavailable + ) { + logger.info( + `${this.logPrefix( + connectorId + )} entered in transaction loop while the connector ${connectorId} status is unavailable` + ); + this.stopConnector(connectorId); + break; + } if (!this.chargingStation?.ocppRequestService) { logger.info( `${this.logPrefix( @@ -200,61 +224,67 @@ export default class AutomaticTransactionGenerator extends AsyncResource { } const wait = Utils.getRandomInteger( - this.configuration.maxDelayBetweenTwoTransactions, - this.configuration.minDelayBetweenTwoTransactions + this.chargingStation.getAutomaticTransactionGeneratorConfiguration() + .maxDelayBetweenTwoTransactions, + this.chargingStation.getAutomaticTransactionGeneratorConfiguration() + .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(); - if (start < this.configuration.probabilityOfStart) { + if ( + start < + this.chargingStation.getAutomaticTransactionGeneratorConfiguration().probabilityOfStart + ) { this.connectorsStatus.get(connectorId).skippedConsecutiveTransactions = 0; // Start transaction const startResponse = await this.startTransaction(connectorId); if (startResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) { // Wait until end of transaction const waitTrxEnd = - Utils.getRandomInteger(this.configuration.maxDuration, this.configuration.minDuration) * - 1000; + Utils.getRandomInteger( + this.chargingStation.getAutomaticTransactionGeneratorConfiguration().maxDuration, + this.chargingStation.getAutomaticTransactionGeneratorConfiguration().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 started with id ${this.chargingStation + .getConnectorStatus(connectorId) + ?.transactionId?.toString()} 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 with id ${this.chargingStation + .getConnectorStatus(connectorId) + ?.transactionId?.toString()}` ); await this.stopTransaction(connectorId); } } else { - this.connectorsStatus.get(connectorId).skippedConsecutiveTransactions++; - this.connectorsStatus.get(connectorId).skippedTransactions++; + ++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`, @@ -265,16 +295,15 @@ export default class AutomaticTransactionGenerator extends AsyncResource { private setStartConnectorStatus(connectorId: number): void { this.connectorsStatus.get(connectorId).skippedConsecutiveTransactions = 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; this.connectorsStatus.get(connectorId).startDate = new Date(); this.connectorsStatus.get(connectorId).stopDate = new Date( this.connectorsStatus.get(connectorId).startDate.getTime() + - (this.configuration.stopAfterHours ?? - Constants.CHARGING_STATION_ATG_DEFAULT_STOP_AFTER_HOURS) * + this.chargingStation.getAutomaticTransactionGeneratorConfiguration().stopAfterHours * 3600 * 1000 - previousRunDuration @@ -283,34 +312,61 @@ export default class AutomaticTransactionGenerator extends AsyncResource { } private initializeConnectorsStatus(): void { - for (const connectorId of this.chargingStation.connectors.keys()) { - if (connectorId > 0) { - this.connectorsStatus.set(connectorId, { - start: false, - authorizeRequests: 0, - acceptedAuthorizeRequests: 0, - rejectedAuthorizeRequests: 0, - startTransactionRequests: 0, - acceptedStartTransactionRequests: 0, - rejectedStartTransactionRequests: 0, - stopTransactionRequests: 0, - acceptedStopTransactionRequests: 0, - rejectedStopTransactionRequests: 0, - skippedConsecutiveTransactions: 0, - skippedTransactions: 0, - }); + if (this.chargingStation.hasEvses) { + for (const [evseId, evseStatus] of this.chargingStation.evses) { + if (evseId > 0) { + for (const connectorId of evseStatus.connectors.keys()) { + this.connectorsStatus.set(connectorId, this.getConnectorStatus(connectorId)); + } + } + } + } else { + for (const connectorId of this.chargingStation.connectors.keys()) { + if (connectorId > 0) { + this.connectorsStatus.set(connectorId, this.getConnectorStatus(connectorId)); + } } } } + private getConnectorStatus(connectorId: number): Status { + const connectorStatus = Utils.cloneObject( + this.chargingStation.getAutomaticTransactionGeneratorStatuses() + )[connectorId]; + delete connectorStatus?.startDate; + delete connectorStatus?.lastRunDate; + delete connectorStatus?.stopDate; + delete connectorStatus?.stoppedDate; + return ( + connectorStatus ?? { + start: false, + authorizeRequests: 0, + acceptedAuthorizeRequests: 0, + rejectedAuthorizeRequests: 0, + startTransactionRequests: 0, + acceptedStartTransactionRequests: 0, + rejectedStartTransactionRequests: 0, + stopTransactionRequests: 0, + acceptedStopTransactionRequests: 0, + rejectedStopTransactionRequests: 0, + skippedConsecutiveTransactions: 0, + skippedTransactions: 0, + } + ); + } + private async startTransaction( connectorId: number ): Promise { const measureId = 'StartTransaction with ATG'; const beginId = PerformanceStatistics.beginMeasure(measureId); let startResponse: StartTransactionResponse; - if (this.chargingStation.hasAuthorizedTags()) { - const idTag = this.getIdTag(connectorId); + if (this.chargingStation.hasIdTags()) { + const idTag = IdTagsCache.getInstance().getIdTag( + this.chargingStation.getAutomaticTransactionGeneratorConfiguration()?.idTagDistribution, + this.chargingStation, + connectorId + ); const startTransactionLogMsg = `${this.logPrefix( connectorId )} start transaction with an idTag '${idTag}'`; @@ -324,9 +380,9 @@ export default class AutomaticTransactionGenerator extends AsyncResource { >(this.chargingStation, RequestCommand.AUTHORIZE, { idTag, }); - this.connectorsStatus.get(connectorId).authorizeRequests++; + ++this.connectorsStatus.get(connectorId).authorizeRequests; if (authorizeResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) { - this.connectorsStatus.get(connectorId).acceptedAuthorizeRequests++; + ++this.connectorsStatus.get(connectorId).acceptedAuthorizeRequests; logger.info(startTransactionLogMsg); // Start transaction startResponse = await this.chargingStation.ocppRequestService.requestHandler< @@ -340,7 +396,7 @@ export default class AutomaticTransactionGenerator extends AsyncResource { PerformanceStatistics.endMeasure(measureId, beginId); return startResponse; } - this.connectorsStatus.get(connectorId).rejectedAuthorizeRequests++; + ++this.connectorsStatus.get(connectorId).rejectedAuthorizeRequests; PerformanceStatistics.endMeasure(measureId, beginId); return startResponse; } @@ -376,17 +432,17 @@ export default class AutomaticTransactionGenerator extends AsyncResource { let stopResponse: StopTransactionResponse; if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) { stopResponse = await this.chargingStation.stopTransactionOnConnector(connectorId, reason); - this.connectorsStatus.get(connectorId).stopTransactionRequests++; + ++this.connectorsStatus.get(connectorId).stopTransactionRequests; if (stopResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) { - this.connectorsStatus.get(connectorId).acceptedStopTransactionRequests++; + ++this.connectorsStatus.get(connectorId).acceptedStopTransactionRequests; } else { - this.connectorsStatus.get(connectorId).rejectedStopTransactionRequests++; + ++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) ? ` with id ${transactionId?.toString()}` : '' }` ); } @@ -395,70 +451,29 @@ export default class AutomaticTransactionGenerator extends AsyncResource { } private getRequireAuthorize(): boolean { - return this.configuration?.requireAuthorize ?? true; - } - - 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 + return ( + this.chargingStation.getAutomaticTransactionGeneratorConfiguration()?.requireAuthorize ?? true ); - 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 { + private logPrefix = (connectorId?: number): string => { return Utils.logPrefix( ` ${this.chargingStation.stationInfo.chargingStationId} | ATG${ - connectorId !== undefined ? ` on connector #${connectorId.toString()}` : '' + !Utils.isNullOrUndefined(connectorId) ? ` on connector #${connectorId.toString()}` : '' }:` ); - } + }; private handleStartTransactionResponse( connectorId: number, startResponse: StartTransactionResponse ): void { - this.connectorsStatus.get(connectorId).startTransactionRequests++; + ++this.connectorsStatus.get(connectorId).startTransactionRequests; if (startResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) { - this.connectorsStatus.get(connectorId).acceptedStartTransactionRequests++; + ++this.connectorsStatus.get(connectorId).acceptedStartTransactionRequests; } else { - 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; + logger.warn(`${this.logPrefix(connectorId)} start transaction rejected`); + ++this.connectorsStatus.get(connectorId).rejectedStartTransactionRequests; } - return true; } }