X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FAutomaticTransactionGenerator.ts;h=578f47e942d89e38c0700c3fec919b80bc750948;hb=05b52716e8aecade28e957d243969639086fd1e4;hp=29f571e961315eb9b1f7ec8fe9eed4618d1d8cad;hpb=17991e8cf5f39801cdba8bd4682576c40e62dc4d;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/AutomaticTransactionGenerator.ts b/src/charging-station/AutomaticTransactionGenerator.ts index 29f571e9..578f47e9 100644 --- a/src/charging-station/AutomaticTransactionGenerator.ts +++ b/src/charging-station/AutomaticTransactionGenerator.ts @@ -1,139 +1,496 @@ -import { AuthorizationStatus, StartTransactionResponse, StopTransactionReason, StopTransactionResponse } from '../types/ocpp/1.6/Transaction'; -import { PerformanceObserver, performance } from 'perf_hooks'; - -import ChargingStation from './ChargingStation'; -import Constants from '../utils/Constants'; -import Utils from '../utils/Utils'; -import logger from '../utils/Logger'; - -export default class AutomaticTransactionGenerator { - private _chargingStation: ChargingStation; - private _timeToStop: boolean; - private _performanceObserver: PerformanceObserver; - - constructor(chargingStation: ChargingStation) { - this._chargingStation = chargingStation; - this._timeToStop = true; - if (this._chargingStation.getEnableStatistics()) { - this._performanceObserver = new PerformanceObserver((list) => { - const entry = list.getEntries()[0]; - this._chargingStation.statistics.logPerformance(entry, Constants.ENTITY_AUTOMATIC_TRANSACTION_GENERATOR); - this._performanceObserver.disconnect(); - }); +// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. + +import { AsyncResource } from 'node:async_hooks'; + +import type { ChargingStation } from './ChargingStation'; +import { checkChargingStation } 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'; +import { + Constants, + cloneObject, + formatDurationMilliSeconds, + getRandomInteger, + isNullOrUndefined, + logPrefix, + logger, + secureRandom, + sleep, +} from '../utils'; + +const moduleName = 'AutomaticTransactionGenerator'; + +export class AutomaticTransactionGenerator extends AsyncResource { + private static readonly instances: Map = new Map< + string, + AutomaticTransactionGenerator + >(); + + public readonly connectorsStatus: Map; + public started: boolean; + private starting: boolean; + private stopping: boolean; + private readonly chargingStation: ChargingStation; + + private constructor(chargingStation: ChargingStation) { + super(moduleName); + this.started = false; + this.starting = false; + this.stopping = false; + this.chargingStation = chargingStation; + this.connectorsStatus = new Map(); + this.initializeConnectorsStatus(); + } + + public static getInstance( + chargingStation: ChargingStation, + ): AutomaticTransactionGenerator | undefined { + if (AutomaticTransactionGenerator.instances.has(chargingStation.stationInfo.hashId) === false) { + AutomaticTransactionGenerator.instances.set( + chargingStation.stationInfo.hashId, + new AutomaticTransactionGenerator(chargingStation), + ); + } + return AutomaticTransactionGenerator.instances.get(chargingStation.stationInfo.hashId); + } + + public start(): void { + if (checkChargingStation(this.chargingStation, this.logPrefix()) === false) { + return; + } + if (this.started === true) { + logger.warn(`${this.logPrefix()} is already started`); + return; + } + if (this.starting === true) { + logger.warn(`${this.logPrefix()} is already starting`); + return; + } + this.starting = true; + this.startConnectors(); + this.started = true; + this.starting = false; + } + + public stop(): void { + if (this.started === false) { + logger.warn(`${this.logPrefix()} is already stopped`); + return; + } + if (this.stopping === true) { + logger.warn(`${this.logPrefix()} is already stopping`); + return; } + this.stopping = true; + this.stopConnectors(); + this.started = false; + this.stopping = false; } - get timeToStop(): boolean { - return this._timeToStop; + public startConnector(connectorId: number): void { + if (checkChargingStation(this.chargingStation, this.logPrefix(connectorId)) === false) { + return; + } + if (this.connectorsStatus.has(connectorId) === false) { + 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) { + this.runInAsyncScope( + this.internalStartConnector.bind(this) as ( + this: AutomaticTransactionGenerator, + ...args: unknown[] + ) => Promise, + this, + connectorId, + ).catch(Constants.EMPTY_FUNCTION); + } else if (this.connectorsStatus.get(connectorId)?.start === true) { + logger.warn(`${this.logPrefix(connectorId)} is already started on connector`); + } } - _logPrefix(connectorId: number = null): string { - if (connectorId) { - return Utils.logPrefix(' ' + this._chargingStation.stationInfo.name + ' ATG on connector #' + connectorId.toString() + ':'); + public stopConnector(connectorId: number): void { + if (this.connectorsStatus.has(connectorId) === false) { + 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) { + this.connectorsStatus.get(connectorId)!.start = false; + } else if (this.connectorsStatus.get(connectorId)?.start === false) { + logger.warn(`${this.logPrefix(connectorId)} is already stopped on connector`); } - return Utils.logPrefix(' ' + this._chargingStation.stationInfo.name + ' ATG:'); } - start(): void { - this._timeToStop = false; - if (this._chargingStation.stationInfo.AutomaticTransactionGenerator.stopAfterHours && - this._chargingStation.stationInfo.AutomaticTransactionGenerator.stopAfterHours > 0) { - setTimeout(() => { - this.stop(); - }, this._chargingStation.stationInfo.AutomaticTransactionGenerator.stopAfterHours * 3600 * 1000); + private startConnectors(): void { + if ( + this.connectorsStatus?.size > 0 && + this.connectorsStatus.size !== this.chargingStation.getNumberOfConnectors() + ) { + this.connectorsStatus.clear(); + this.initializeConnectorsStatus(); } - for (const connector in this._chargingStation.connectors) { - if (Utils.convertToInt(connector) > 0) { - this.startConnector(Utils.convertToInt(connector)); + 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); + } } } - logger.info(this._logPrefix() + ' ATG started and will stop in ' + Utils.secondsToHHMMSS(this._chargingStation.stationInfo.AutomaticTransactionGenerator.stopAfterHours * 3600)); } - async stop(reason: StopTransactionReason = StopTransactionReason.NONE): Promise { - logger.info(this._logPrefix() + ' ATG OVER => STOPPING ALL TRANSACTIONS'); - for (const connector in this._chargingStation.connectors) { - if (this._chargingStation.getConnector(Utils.convertToInt(connector)).transactionStarted) { - logger.info(this._logPrefix(Utils.convertToInt(connector)) + ' ATG OVER. Stop transaction ' + this._chargingStation.getConnector(Utils.convertToInt(connector)).transactionId.toString()); - await this._chargingStation.sendStopTransaction(this._chargingStation.getConnector(Utils.convertToInt(connector)).transactionId, reason); + private stopConnectors(): void { + 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); + } } } - this._timeToStop = true; } - async startConnector(connectorId: number): Promise { - do { - if (this._timeToStop) { - logger.error(this._logPrefix(connectorId) + ' Entered in transaction loop while a request to stop it was made'); + private async internalStartConnector(connectorId: number): Promise { + this.setStartConnectorStatus(connectorId); + logger.info( + `${this.logPrefix( + connectorId, + )} started on connector and will run for ${formatDurationMilliSeconds( + this.connectorsStatus.get(connectorId)!.stopDate!.getTime() - + this.connectorsStatus.get(connectorId)!.startDate!.getTime(), + )}`, + ); + while (this.connectorsStatus.get(connectorId)?.start === true) { + if (new Date() > this.connectorsStatus.get(connectorId)!.stopDate!) { + this.stopConnector(connectorId); + break; + } + if (this.chargingStation.inAcceptedState() === false) { + logger.error( + `${this.logPrefix( + connectorId, + )} entered in transaction loop while the charging station is not in accepted state`, + ); + this.stopConnector(connectorId); break; } - if (!this._chargingStation._isRegistered()) { - logger.error(this._logPrefix(connectorId) + ' Entered in transaction loop while the charging station is not registered'); + if (this.chargingStation.isChargingStationAvailable() === false) { + logger.info( + `${this.logPrefix( + connectorId, + )} entered in transaction loop while the charging station is unavailable`, + ); + this.stopConnector(connectorId); break; } - if (!this._chargingStation._isChargingStationAvailable() || !this._chargingStation._isConnectorAvailable(connectorId)) { - logger.error(this._logPrefix(connectorId) + ' Entered in transaction loop while the charging station or connector is unavailable'); + if (this.chargingStation.isConnectorAvailable(connectorId) === false) { + logger.info( + `${this.logPrefix( + connectorId, + )} entered in transaction loop while the connector ${connectorId} is unavailable`, + ); + this.stopConnector(connectorId); break; } - const wait = Utils.getRandomInt(this._chargingStation.stationInfo.AutomaticTransactionGenerator.maxDelayBetweenTwoTransactions, - this._chargingStation.stationInfo.AutomaticTransactionGenerator.minDelayBetweenTwoTransactions) * 1000; - logger.info(this._logPrefix(connectorId) + ' wait for ' + Utils.milliSecondsToHHMMSS(wait)); - await Utils.sleep(wait); - const start = Math.random(); - let skip = 0; - if (start < this._chargingStation.stationInfo.AutomaticTransactionGenerator.probabilityOfStart) { - skip = 0; + 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( + connectorId, + )} transaction loop waiting for charging station service to be initialized`, + ); + do { + await sleep(Constants.CHARGING_STATION_ATG_INITIALIZATION_TIME); + } while (!this.chargingStation?.ocppRequestService); + } + const wait = + getRandomInteger( + this.chargingStation.getAutomaticTransactionGeneratorConfiguration() + .maxDelayBetweenTwoTransactions, + this.chargingStation.getAutomaticTransactionGeneratorConfiguration() + .minDelayBetweenTwoTransactions, + ) * 1000; + logger.info(`${this.logPrefix(connectorId)} waiting for ${formatDurationMilliSeconds(wait)}`); + await sleep(wait); + const start = secureRandom(); + if ( + start < + this.chargingStation.getAutomaticTransactionGeneratorConfiguration().probabilityOfStart + ) { + this.connectorsStatus.get(connectorId)!.skippedConsecutiveTransactions = 0; // Start transaction - let startResponse: StartTransactionResponse; - if (this._chargingStation.getEnableStatistics()) { - const startTransaction = performance.timerify(this.startTransaction); - this._performanceObserver.observe({ entryTypes: ['function'] }); - startResponse = await startTransaction(connectorId, this); - } else { - startResponse = await this.startTransaction(connectorId, this); - } - if (startResponse.idTagInfo.status !== AuthorizationStatus.ACCEPTED) { - logger.info(this._logPrefix(connectorId) + ' transaction rejected'); - await Utils.sleep(Constants.CHARGING_STATION_ATG_WAIT_TIME); - } else { + const startResponse = await this.startTransaction(connectorId); + if (startResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) { // Wait until end of transaction - const waitTrxEnd = Utils.getRandomInt(this._chargingStation.stationInfo.AutomaticTransactionGenerator.maxDuration, - this._chargingStation.stationInfo.AutomaticTransactionGenerator.minDuration) * 1000; - logger.info(this._logPrefix(connectorId) + ' transaction ' + this._chargingStation.getConnector(connectorId).transactionId.toString() + ' will stop in ' + Utils.milliSecondsToHHMMSS(waitTrxEnd)); - await Utils.sleep(waitTrxEnd); + const waitTrxEnd = + getRandomInteger( + this.chargingStation.getAutomaticTransactionGeneratorConfiguration().maxDuration, + this.chargingStation.getAutomaticTransactionGeneratorConfiguration().minDuration, + ) * 1000; + logger.info( + `${this.logPrefix(connectorId)} transaction started with id ${this.chargingStation + .getConnectorStatus(connectorId) + ?.transactionId?.toString()} and will stop in ${formatDurationMilliSeconds( + waitTrxEnd, + )}`, + ); + await sleep(waitTrxEnd); // Stop transaction - if (this._chargingStation.getConnector(connectorId)?.transactionStarted) { - logger.info(this._logPrefix(connectorId) + ' stop transaction ' + this._chargingStation.getConnector(connectorId).transactionId.toString()); - if (this._chargingStation.getEnableStatistics()) { - const stopTransaction = performance.timerify(this.stopTransaction); - this._performanceObserver.observe({ entryTypes: ['function'] }); - await stopTransaction(connectorId, this); - } else { - await this.stopTransaction(connectorId, this); - } - } + logger.info( + `${this.logPrefix(connectorId)} stop transaction with id ${this.chargingStation + .getConnectorStatus(connectorId) + ?.transactionId?.toString()}`, + ); + await this.stopTransaction(connectorId); } } else { - skip++; - logger.info(this._logPrefix(connectorId) + ' transaction skipped ' + skip.toString()); + ++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)`, + ); } - } while (!this._timeToStop); - logger.info(this._logPrefix(connectorId) + ' ATG STOPPED on the connector'); + 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 ${formatDurationMilliSeconds( + this.connectorsStatus.get(connectorId)!.stoppedDate!.getTime() - + this.connectorsStatus.get(connectorId)!.startDate!.getTime(), + )}`, + ); + logger.debug( + `${this.logPrefix(connectorId)} connector status: %j`, + this.connectorsStatus.get(connectorId), + ); + } + + 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)!.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.chargingStation.getAutomaticTransactionGeneratorConfiguration().stopAfterHours * + 3600 * + 1000 - + previousRunDuration, + ); + this.connectorsStatus.get(connectorId)!.start = true; } - // eslint-disable-next-line consistent-this - private async startTransaction(connectorId: number, self: AutomaticTransactionGenerator): Promise { - if (self._chargingStation.hasAuthorizedTags()) { - const tagId = self._chargingStation.getRandomTagId(); - logger.info(self._logPrefix(connectorId) + ' start transaction for tagID ' + tagId); - return await self._chargingStation.sendStartTransaction(connectorId, tagId); + private initializeConnectorsStatus(): void { + 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)); + } + } } - logger.info(self._logPrefix(connectorId) + ' start transaction without a tagID'); - return await self._chargingStation.sendStartTransaction(connectorId); } - // eslint-disable-next-line consistent-this - private async stopTransaction(connectorId: number, self: AutomaticTransactionGenerator): Promise { - return await self._chargingStation.sendStopTransaction(self._chargingStation.getConnector(connectorId).transactionId); + private getConnectorStatus(connectorId: number): Status { + const connectorStatus = this.chargingStation.getAutomaticTransactionGeneratorStatuses() + ? cloneObject(this.chargingStation.getAutomaticTransactionGeneratorStatuses()!)[connectorId] + : undefined; + 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 | undefined; + 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}'`; + if (this.getRequireAuthorize()) { + this.chargingStation.getConnectorStatus(connectorId)!.authorizeIdTag = idTag; + // Authorize idTag + const authorizeResponse: AuthorizeResponse = + await this.chargingStation.ocppRequestService.requestHandler< + AuthorizeRequest, + AuthorizeResponse + >(this.chargingStation, RequestCommand.AUTHORIZE, { + idTag, + }); + ++this.connectorsStatus.get(connectorId)!.authorizeRequests!; + if (authorizeResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) { + ++this.connectorsStatus.get(connectorId)!.acceptedAuthorizeRequests!; + logger.info(startTransactionLogMsg); + // Start transaction + startResponse = await this.chargingStation.ocppRequestService.requestHandler< + StartTransactionRequest, + StartTransactionResponse + >(this.chargingStation, RequestCommand.START_TRANSACTION, { + connectorId, + idTag, + }); + this.handleStartTransactionResponse(connectorId, startResponse); + PerformanceStatistics.endMeasure(measureId, beginId); + return startResponse; + } + ++this.connectorsStatus.get(connectorId)!.rejectedAuthorizeRequests!; + PerformanceStatistics.endMeasure(measureId, beginId); + return startResponse; + } + logger.info(startTransactionLogMsg); + // Start transaction + startResponse = await this.chargingStation.ocppRequestService.requestHandler< + StartTransactionRequest, + StartTransactionResponse + >(this.chargingStation, RequestCommand.START_TRANSACTION, { + connectorId, + idTag, + }); + this.handleStartTransactionResponse(connectorId, startResponse); + PerformanceStatistics.endMeasure(measureId, beginId); + return startResponse; + } + logger.info(`${this.logPrefix(connectorId)} start transaction without an idTag`); + startResponse = await this.chargingStation.ocppRequestService.requestHandler< + StartTransactionRequest, + StartTransactionResponse + >(this.chargingStation, RequestCommand.START_TRANSACTION, { connectorId }); + this.handleStartTransactionResponse(connectorId, startResponse); + PerformanceStatistics.endMeasure(measureId, beginId); + return startResponse; + } + + private async stopTransaction( + connectorId: number, + reason: StopTransactionReason = StopTransactionReason.LOCAL, + ): Promise { + const measureId = 'StopTransaction with ATG'; + const beginId = PerformanceStatistics.beginMeasure(measureId); + let stopResponse: StopTransactionResponse | undefined; + if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) { + stopResponse = await this.chargingStation.stopTransactionOnConnector(connectorId, reason); + ++this.connectorsStatus.get(connectorId)!.stopTransactionRequests!; + if (stopResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) { + ++this.connectorsStatus.get(connectorId)!.acceptedStopTransactionRequests!; + } else { + ++this.connectorsStatus.get(connectorId)!.rejectedStopTransactionRequests!; + } + } else { + const transactionId = this.chargingStation.getConnectorStatus(connectorId)?.transactionId; + logger.warn( + `${this.logPrefix(connectorId)} stopping a not started transaction${ + !isNullOrUndefined(transactionId) ? ` with id ${transactionId?.toString()}` : '' + }`, + ); + } + PerformanceStatistics.endMeasure(measureId, beginId); + return stopResponse; + } + + private getRequireAuthorize(): boolean { + return ( + this.chargingStation.getAutomaticTransactionGeneratorConfiguration()?.requireAuthorize ?? true + ); + } + + private logPrefix = (connectorId?: number): string => { + return logPrefix( + ` ${this.chargingStation.stationInfo.chargingStationId} | ATG${ + !isNullOrUndefined(connectorId) ? ` on connector #${connectorId!.toString()}` : '' + }:`, + ); + }; + + private handleStartTransactionResponse( + connectorId: number, + startResponse: StartTransactionResponse, + ): void { + ++this.connectorsStatus.get(connectorId)!.startTransactionRequests!; + if (startResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) { + ++this.connectorsStatus.get(connectorId)!.acceptedStartTransactionRequests!; + } else { + logger.warn(`${this.logPrefix(connectorId)} start transaction rejected`); + ++this.connectorsStatus.get(connectorId)!.rejectedStartTransactionRequests!; + } } }