X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FAutomaticTransactionGenerator.ts;h=54b409ed39b7837cc7d988de8719e18512ee4add;hb=10db00b2276f4cc7a88dd18e8f6f80593d6458b3;hp=985e8e4779ff2633e9c089b6f569c3d00fe89b42;hpb=3f94cab5f9ffdc613338a715cf3fad1cede5a687;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/AutomaticTransactionGenerator.ts b/src/charging-station/AutomaticTransactionGenerator.ts index 985e8e47..54b409ed 100644 --- a/src/charging-station/AutomaticTransactionGenerator.ts +++ b/src/charging-station/AutomaticTransactionGenerator.ts @@ -1,21 +1,24 @@ // Partial Copyright Jerome Benoit. 2021. All Rights Reserved. +import PerformanceStatistics from '../performance/PerformanceStatistics'; +import type { + AutomaticTransactionGeneratorConfiguration, + Status, +} from '../types/AutomaticTransactionGenerator'; +import { RequestCommand } from '../types/ocpp/Requests'; import { AuthorizationStatus, + AuthorizeRequest, AuthorizeResponse, + StartTransactionRequest, StartTransactionResponse, StopTransactionReason, StopTransactionResponse, } from '../types/ocpp/Transaction'; - -import type ChargingStation from './ChargingStation'; import Constants from '../utils/Constants'; -import { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils'; -import PerformanceStatistics from '../performance/PerformanceStatistics'; -import { RequestCommand } from '../types/ocpp/Requests'; -import { Status } from '../types/AutomaticTransactionGenerator'; -import Utils from '../utils/Utils'; import logger from '../utils/Logger'; +import Utils from '../utils/Utils'; +import type ChargingStation from './ChargingStation'; export default class AutomaticTransactionGenerator { private static readonly instances: Map = new Map< @@ -23,30 +26,41 @@ export default class AutomaticTransactionGenerator { AutomaticTransactionGenerator >(); + public readonly connectorsStatus: Map; + public readonly configuration: AutomaticTransactionGeneratorConfiguration; public started: boolean; private readonly chargingStation: ChargingStation; - private readonly connectorsStatus: Map; - private constructor(chargingStation: ChargingStation) { + private constructor( + automaticTransactionGeneratorConfiguration: AutomaticTransactionGeneratorConfiguration, + chargingStation: ChargingStation + ) { + this.configuration = automaticTransactionGeneratorConfiguration; this.chargingStation = chargingStation; this.connectorsStatus = new Map(); this.stopConnectors(); this.started = false; } - public static getInstance(chargingStation: ChargingStation): AutomaticTransactionGenerator { - if (!AutomaticTransactionGenerator.instances.has(chargingStation.hashId)) { + public static getInstance( + automaticTransactionGeneratorConfiguration: AutomaticTransactionGeneratorConfiguration, + chargingStation: ChargingStation + ): AutomaticTransactionGenerator { + if (!AutomaticTransactionGenerator.instances.has(chargingStation.stationInfo.hashId)) { AutomaticTransactionGenerator.instances.set( - chargingStation.hashId, - new AutomaticTransactionGenerator(chargingStation) + chargingStation.stationInfo.hashId, + new AutomaticTransactionGenerator( + automaticTransactionGeneratorConfiguration, + chargingStation + ) ); } - return AutomaticTransactionGenerator.instances.get(chargingStation.hashId); + return AutomaticTransactionGenerator.instances.get(chargingStation.stationInfo.hashId); } public start(): void { - if (this.started) { - logger.error(`${this.logPrefix()} trying to start while already started`); + if (this.started === true) { + logger.warn(`${this.logPrefix()} trying to start while already started`); return; } this.startConnectors(); @@ -54,14 +68,38 @@ export default class AutomaticTransactionGenerator { } public stop(): void { - if (!this.started) { - logger.error(`${this.logPrefix()} trying to stop while not started`); + if (this.started === false) { + logger.warn(`${this.logPrefix()} trying to stop while not started`); return; } this.stopConnectors(); this.started = false; } + public startConnector(connectorId: number): void { + if (this.chargingStation.connectors.has(connectorId) === false) { + logger.warn(`${this.logPrefix(connectorId)} trying to start on non existing connector`); + return; + } + if (this.connectorsStatus.get(connectorId)?.start === false) { + // Avoid hogging the event loop with a busy loop + setImmediate(() => { + this.internalStartConnector(connectorId).catch(() => { + /* This is intentional */ + }); + }); + } else if (this.connectorsStatus.get(connectorId)?.start === true) { + logger.warn(`${this.logPrefix(connectorId)} already started on connector`); + } + } + + public stopConnector(connectorId: number): void { + this.connectorsStatus.set(connectorId, { + ...this.connectorsStatus.get(connectorId), + start: false, + }); + } + private startConnectors(): void { if ( this.connectorsStatus?.size > 0 && @@ -85,7 +123,7 @@ export default class AutomaticTransactionGenerator { } private async internalStartConnector(connectorId: number): Promise { - this.initStartConnectorStatus(connectorId); + this.initializeConnectorStatus(connectorId); logger.info( this.logPrefix(connectorId) + ' started on connector and will run for ' + @@ -94,7 +132,7 @@ export default class AutomaticTransactionGenerator { this.connectorsStatus.get(connectorId).startDate.getTime() ) ); - while (this.connectorsStatus.get(connectorId).start) { + while (this.connectorsStatus.get(connectorId).start === true) { if (new Date() > this.connectorsStatus.get(connectorId).stopDate) { this.stopConnector(connectorId); break; @@ -136,33 +174,23 @@ export default class AutomaticTransactionGenerator { } const wait = Utils.getRandomInteger( - this.chargingStation.stationInfo.AutomaticTransactionGenerator - .maxDelayBetweenTwoTransactions, - this.chargingStation.stationInfo.AutomaticTransactionGenerator - .minDelayBetweenTwoTransactions + this.configuration.maxDelayBetweenTwoTransactions, + this.configuration.minDelayBetweenTwoTransactions ) * 1000; logger.info( this.logPrefix(connectorId) + ' waiting for ' + Utils.formatDurationMilliSeconds(wait) ); await Utils.sleep(wait); const start = Utils.secureRandom(); - if ( - start < this.chargingStation.stationInfo.AutomaticTransactionGenerator.probabilityOfStart - ) { + if (start < this.configuration.probabilityOfStart) { 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.chargingStation.stationInfo.AutomaticTransactionGenerator.maxDuration, - this.chargingStation.stationInfo.AutomaticTransactionGenerator.minDuration - ) * 1000; + Utils.getRandomInteger(this.configuration.maxDuration, this.configuration.minDuration) * + 1000; logger.info( this.logPrefix(connectorId) + ' transaction ' + @@ -170,7 +198,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( @@ -194,7 +221,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) + @@ -205,28 +231,12 @@ export default class AutomaticTransactionGenerator { ) ); logger.debug( - `${this.logPrefix(connectorId)} connector status %j`, + `${this.logPrefix(connectorId)} connector status: %j`, this.connectorsStatus.get(connectorId) ); } - private startConnector(connectorId: number): void { - // Avoid hogging the event loop with a busy loop - setImmediate(() => { - this.internalStartConnector(connectorId).catch(() => { - /* This is intentional */ - }); - }); - } - - private stopConnector(connectorId: number): void { - this.connectorsStatus.set(connectorId, { - ...this.connectorsStatus.get(connectorId), - start: false, - }); - } - - private initStartConnectorStatus(connectorId: number): void { + private initializeConnectorStatus(connectorId: number): void { this.connectorsStatus.get(connectorId).authorizeRequests = this?.connectorsStatus.get(connectorId)?.authorizeRequests ?? 0; this.connectorsStatus.get(connectorId).acceptedAuthorizeRequests = @@ -241,6 +251,10 @@ export default class AutomaticTransactionGenerator { 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; this.connectorsStatus.get(connectorId).skippedConsecutiveTransactions = 0; this.connectorsStatus.get(connectorId).skippedTransactions = this?.connectorsStatus.get(connectorId)?.skippedTransactions ?? 0; @@ -253,7 +267,7 @@ export default class AutomaticTransactionGenerator { this.connectorsStatus.get(connectorId).startDate = new Date(); this.connectorsStatus.get(connectorId).stopDate = new Date( this.connectorsStatus.get(connectorId).startDate.getTime() + - (this.chargingStation.stationInfo?.AutomaticTransactionGenerator?.stopAfterHours ?? + (this.configuration.stopAfterHours ?? Constants.CHARGING_STATION_ATG_DEFAULT_STOP_AFTER_HOURS) * 3600 * 1000 - @@ -264,104 +278,85 @@ export default class AutomaticTransactionGenerator { 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(); - if (this.chargingStation.getAutomaticTransactionGeneratorRequireAuthorize()) { + const startTransactionLogMsg = `${this.logPrefix( + connectorId + )} start transaction for idTag '${idTag}'`; + if (this.getRequireAuthorize()) { this.chargingStation.getConnectorStatus(connectorId).authorizeIdTag = idTag; // Authorize idTag const authorizeResponse: AuthorizeResponse = - (await this.chargingStation.ocppRequestService.sendMessageHandler( - RequestCommand.AUTHORIZE, - { - idTag, - } - )) as 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(this.logPrefix(connectorId) + ' start transaction for idTag ' + idTag); + logger.info(startTransactionLogMsg); // Start transaction - startResponse = (await this.chargingStation.ocppRequestService.sendMessageHandler( - RequestCommand.START_TRANSACTION, - { - connectorId, - idTag, - } - )) as StartTransactionResponse; + 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 authorizeResponse; + return startResponse; } - logger.info(this.logPrefix(connectorId) + ' start transaction for idTag ' + idTag); + logger.info(startTransactionLogMsg); // Start transaction - startResponse = (await this.chargingStation.ocppRequestService.sendMessageHandler( - RequestCommand.START_TRANSACTION, - { - connectorId, - idTag, - } - )) as StartTransactionResponse; + 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.sendMessageHandler( - RequestCommand.START_TRANSACTION, - { connectorId } - )) as StartTransactionResponse; + 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.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.sendMessageHandler( - RequestCommand.METER_VALUES, - { - connectorId, - transactionId, - meterValue: transactionEndMeterValue, - } - ); - } - stopResponse = (await this.chargingStation.ocppRequestService.sendMessageHandler( - RequestCommand.STOP_TRANSACTION, - { - transactionId, - meterStop: - this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId), - idTag: this.chargingStation.getTransactionIdTag(transactionId), - reason, - } - )) as StopTransactionResponse; + 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${ transactionId ? ' ' + transactionId.toString() : '' @@ -372,16 +367,28 @@ export default class AutomaticTransactionGenerator { return stopResponse; } + private getRequireAuthorize(): boolean { + return this.configuration?.requireAuthorize ?? true; + } + private logPrefix(connectorId?: number): string { - if (connectorId) { - return Utils.logPrefix( - ' ' + - this.chargingStation.stationInfo.chargingStationId + - ' | ATG on connector #' + - connectorId.toString() + - ':' - ); + return Utils.logPrefix( + ` ${this.chargingStation.stationInfo.chargingStationId} | ATG${ + connectorId !== undefined ? ` 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++; } - return Utils.logPrefix(' ' + this.chargingStation.stationInfo.chargingStationId + ' | ATG:'); } }