X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FAutomaticTransactionGenerator.ts;h=80c9a5176937a035dccc699fc39e6e6b2859a88d;hb=edd134392e237a3242dc2093341df70244c51472;hp=bf28e55bfdcbc9e4894996f1b383d47a3e0af0b8;hpb=ecb3869d21232120be79a873a9c81a1dbc902a9b;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/AutomaticTransactionGenerator.ts b/src/charging-station/AutomaticTransactionGenerator.ts index bf28e55b..80c9a517 100644 --- a/src/charging-station/AutomaticTransactionGenerator.ts +++ b/src/charging-station/AutomaticTransactionGenerator.ts @@ -1,55 +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 BaseError from '../exception/BaseError'; import PerformanceStatistics from '../performance/PerformanceStatistics'; -import type { - AutomaticTransactionGeneratorConfiguration, - Status, +import { + type AutomaticTransactionGeneratorConfiguration, + IdTagDistribution, + type Status, } from '../types/AutomaticTransactionGenerator'; -import { MeterValuesRequest, RequestCommand } from '../types/ocpp/Requests'; -import type { MeterValuesResponse } from '../types/ocpp/Responses'; +import { RequestCommand } from '../types/ocpp/Requests'; import { AuthorizationStatus, - AuthorizeRequest, - AuthorizeResponse, - StartTransactionRequest, - StartTransactionResponse, + type AuthorizeRequest, + type AuthorizeResponse, + type StartTransactionRequest, + type StartTransactionResponse, StopTransactionReason, - StopTransactionRequest, - StopTransactionResponse, + 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 { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils'; +import { ChargingStationUtils } from './ChargingStationUtils'; + +const moduleName = 'AutomaticTransactionGenerator'; -export default class AutomaticTransactionGenerator { +export default 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 readonly connectorsStatus: Map; + 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.stopConnectors(); - this.started = false; + this.initializeConnectorsStatus(); } public static getInstance( automaticTransactionGeneratorConfiguration: AutomaticTransactionGeneratorConfiguration, chargingStation: ChargingStation ): AutomaticTransactionGenerator { - if (!AutomaticTransactionGenerator.instances.has(chargingStation.stationInfo.hashId)) { + if (AutomaticTransactionGenerator.instances.has(chargingStation.stationInfo.hashId) === false) { AutomaticTransactionGenerator.instances.set( chargingStation.stationInfo.hashId, new AutomaticTransactionGenerator( @@ -62,8 +69,11 @@ export default class AutomaticTransactionGenerator { } public start(): void { + if (this.checkChargingStation() === false) { + return; + } if (this.started === true) { - logger.warn(`${this.logPrefix()} trying to start while already started`); + logger.warn(`${this.logPrefix()} is already started`); return; } this.startConnectors(); @@ -72,7 +82,7 @@ export default class AutomaticTransactionGenerator { public stop(): void { if (this.started === false) { - logger.warn(`${this.logPrefix()} trying to stop while not started`); + logger.warn(`${this.logPrefix()} is already stopped`); return; } this.stopConnectors(); @@ -80,27 +90,39 @@ export default class AutomaticTransactionGenerator { } public startConnector(connectorId: number): void { - if (this.chargingStation.connectors.has(connectorId) === false) { - logger.warn(`${this.logPrefix(connectorId)} trying to start on non existing connector`); + if (this.checkChargingStation(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) { - // 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)} already started on connector`); + logger.warn(`${this.logPrefix(connectorId)} is already started on connector`); } } public stopConnector(connectorId: number): void { - this.connectorsStatus.set(connectorId, { - ...this.connectorsStatus.get(connectorId), - start: false, - }); + 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`); + } } private startConnectors(): void { @@ -109,6 +131,7 @@ export default class AutomaticTransactionGenerator { this.connectorsStatus.size !== this.chargingStation.getNumberOfConnectors() ) { this.connectorsStatus.clear(); + this.initializeConnectorsStatus(); } for (const connectorId of this.chargingStation.connectors.keys()) { if (connectorId > 0) { @@ -126,7 +149,7 @@ export default class AutomaticTransactionGenerator { } private async internalStartConnector(connectorId: number): Promise { - this.initializeConnectorStatus(connectorId); + this.setStartConnectorStatus(connectorId); logger.info( this.logPrefix(connectorId) + ' started on connector and will run for ' + @@ -140,7 +163,7 @@ export default class AutomaticTransactionGenerator { 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' @@ -148,7 +171,7 @@ export default class AutomaticTransactionGenerator { 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' @@ -156,7 +179,7 @@ export default class AutomaticTransactionGenerator { this.stopConnector(connectorId); break; } - if (!this.chargingStation.isConnectorAvailable(connectorId)) { + if (this.chargingStation.isConnectorAvailable(connectorId) === false) { logger.info( `${this.logPrefix( connectorId @@ -189,11 +212,7 @@ export default class AutomaticTransactionGenerator { this.connectorsStatus.get(connectorId).skippedConsecutiveTransactions = 0; // Start transaction const startResponse = await this.startTransaction(connectorId); - this.connectorsStatus.get(connectorId).startTransactionRequests++; - if (startResponse?.idTagInfo?.status !== AuthorizationStatus.ACCEPTED) { - logger.warn(this.logPrefix(connectorId) + ' start transaction rejected'); - this.connectorsStatus.get(connectorId).rejectedStartTransactionRequests++; - } else { + if (startResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) { // Wait until end of transaction const waitTrxEnd = Utils.getRandomInteger(this.configuration.maxDuration, this.configuration.minDuration) * @@ -205,7 +224,6 @@ export default class AutomaticTransactionGenerator { ' started and will stop in ' + Utils.formatDurationMilliSeconds(waitTrxEnd) ); - this.connectorsStatus.get(connectorId).acceptedStartTransactionRequests++; await Utils.sleep(waitTrxEnd); // Stop transaction logger.info( @@ -229,7 +247,6 @@ export default class AutomaticTransactionGenerator { } this.connectorsStatus.get(connectorId).lastRunDate = new Date(); } - await this.stopTransaction(connectorId); this.connectorsStatus.get(connectorId).stoppedDate = new Date(); logger.info( this.logPrefix(connectorId) + @@ -245,24 +262,8 @@ 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; + 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 @@ -281,17 +282,38 @@ export default class AutomaticTransactionGenerator { this.connectorsStatus.get(connectorId).start = true; } + 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, + }); + } + } + } + private async startTransaction( connectorId: number - ): Promise { + ): Promise { const measureId = 'StartTransaction with ATG'; 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 for idTag '${idTag}'`; + )} start transaction with an idTag '${idTag}'`; if (this.getRequireAuthorize()) { this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag = idTag; // Authorize idTag @@ -314,12 +336,13 @@ export default class AutomaticTransactionGenerator { connectorId, idTag, }); + this.handleStartTransactionResponse(connectorId, startResponse); PerformanceStatistics.endMeasure(measureId, beginId); return startResponse; } this.connectorsStatus.get(connectorId).rejectedAuthorizeRequests++; PerformanceStatistics.endMeasure(measureId, beginId); - return authorizeResponse; + return startResponse; } logger.info(startTransactionLogMsg); // Start transaction @@ -330,6 +353,7 @@ export default class AutomaticTransactionGenerator { connectorId, idTag, }); + this.handleStartTransactionResponse(connectorId, startResponse); PerformanceStatistics.endMeasure(measureId, beginId); return startResponse; } @@ -338,56 +362,30 @@ export default class AutomaticTransactionGenerator { 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.NONE + reason: StopTransactionReason = StopTransactionReason.LOCAL ): Promise { const measureId = 'StopTransaction with ATG'; const beginId = PerformanceStatistics.beginMeasure(measureId); - let transactionId = 0; let stopResponse: StopTransactionResponse; - if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted) { - transactionId = this.chargingStation.getConnectorStatus(connectorId).transactionId; - if ( - this.chargingStation.getBeginEndMeterValues() && - this.chargingStation.getOcppStrictCompliance() && - !this.chargingStation.getOutOfOrderEndMeterValues() - ) { - // FIXME: Implement OCPP version agnostic helpers - const transactionEndMeterValue = OCPP16ServiceUtils.buildTransactionEndMeterValue( - this.chargingStation, - connectorId, - this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId) - ); - await this.chargingStation.ocppRequestService.requestHandler< - MeterValuesRequest, - MeterValuesResponse - >(this.chargingStation, RequestCommand.METER_VALUES, { - connectorId, - transactionId, - meterValue: [transactionEndMeterValue], - }); - } - stopResponse = await this.chargingStation.ocppRequestService.requestHandler< - StopTransactionRequest, - StopTransactionResponse - >(this.chargingStation, RequestCommand.STOP_TRANSACTION, { - transactionId, - meterStop: this.chargingStation.getEnergyActiveImportRegisterByTransactionId( - transactionId, - true - ), - idTag: this.chargingStation.getTransactionIdTag(transactionId), - reason, - }); + 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)} trying to stop a not started transaction${ + `${this.logPrefix(connectorId)} stopping a not started transaction${ transactionId ? ' ' + transactionId.toString() : '' }` ); @@ -400,6 +398,41 @@ export default class AutomaticTransactionGenerator { 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 + ); + 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${ @@ -407,4 +440,25 @@ export default class AutomaticTransactionGenerator { }:` ); } + + 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++; + } + } + + 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; + } }