-import { AuthorizationStatus, StartTransactionResponse, StopTransactionReason, StopTransactionResponse } from '../types/ocpp/1.6/Transaction';
-import { PerformanceObserver, performance } from 'perf_hooks';
+// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
-import ChargingStation from './ChargingStation';
+import { AsyncResource } from '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 {
+ AuthorizationStatus,
+ type AuthorizeRequest,
+ type AuthorizeResponse,
+ type StartTransactionRequest,
+ type StartTransactionResponse,
+ StopTransactionReason,
+ type StopTransactionResponse,
+} from '../types/ocpp/Transaction';
import Constants from '../utils/Constants';
-import Utils from '../utils/Utils';
import logger from '../utils/Logger';
+import Utils from '../utils/Utils';
+import type ChargingStation from './ChargingStation';
+import { ChargingStationUtils } from './ChargingStationUtils';
-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();
- });
+const moduleName = 'AutomaticTransactionGenerator';
+
+export default class AutomaticTransactionGenerator extends AsyncResource {
+ private static readonly instances: Map<string, AutomaticTransactionGenerator> = new Map<
+ string,
+ AutomaticTransactionGenerator
+ >();
+
+ public readonly connectorsStatus: Map<number, Status>;
+ 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<number, Status>();
+ this.initializeConnectorsStatus();
+ }
+
+ public static getInstance(
+ automaticTransactionGeneratorConfiguration: AutomaticTransactionGeneratorConfiguration,
+ chargingStation: ChargingStation
+ ): AutomaticTransactionGenerator {
+ if (AutomaticTransactionGenerator.instances.has(chargingStation.stationInfo.hashId) === false) {
+ AutomaticTransactionGenerator.instances.set(
+ chargingStation.stationInfo.hashId,
+ new AutomaticTransactionGenerator(
+ automaticTransactionGeneratorConfiguration,
+ chargingStation
+ )
+ );
+ }
+ return AutomaticTransactionGenerator.instances.get(chargingStation.stationInfo.hashId);
+ }
+
+ public start(): void {
+ if (this.started === true) {
+ logger.warn(`${this.logPrefix()} is already started`);
+ return;
+ }
+ this.startConnectors();
+ this.started = true;
+ }
+
+ public stop(): void {
+ if (this.started === false) {
+ logger.warn(`${this.logPrefix()} is already stopped`);
+ return;
}
+ this.stopConnectors();
+ this.started = false;
}
- get timeToStop(): boolean {
- return this._timeToStop;
+ public startConnector(connectorId: number): void {
+ 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: any[]
+ ) => Promise<void>,
+ this,
+ connectorId
+ ).catch(() => {
+ /* This is intentional */
+ });
+ } 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));
+ 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<void> {
- 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 {
+ for (const connectorId of this.chargingStation.connectors.keys()) {
+ if (connectorId > 0) {
+ this.stopConnector(connectorId);
}
}
- this._timeToStop = true;
}
- async startConnector(connectorId: number): Promise<void> {
- 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<void> {
+ 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()
+ )
+ );
+ while (this.connectorsStatus.get(connectorId).start === true) {
+ if (new Date() > this.connectorsStatus.get(connectorId).stopDate) {
+ 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.isInAcceptedState() === 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._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.isChargingStationAvailable() === false) {
+ logger.info(
+ this.logPrefix(connectorId) +
+ ' entered in transaction loop while the charging station 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));
+ 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;
+ }
+ if (!this.chargingStation?.ocppRequestService) {
+ logger.info(
+ `${this.logPrefix(
+ connectorId
+ )} transaction loop waiting for charging station service to be initialized`
+ );
+ do {
+ await Utils.sleep(Constants.CHARGING_STATION_ATG_INITIALIZATION_TIME);
+ } while (!this.chargingStation?.ocppRequestService);
+ }
+ const wait =
+ Utils.getRandomInteger(
+ this.configuration.maxDelayBetweenTwoTransactions,
+ this.configuration.minDelayBetweenTwoTransactions
+ ) * 1000;
+ logger.info(
+ this.logPrefix(connectorId) + ' waiting for ' + Utils.formatDurationMilliSeconds(wait)
+ );
await Utils.sleep(wait);
- const start = Math.random();
- let skip = 0;
- if (start < this._chargingStation.stationInfo.AutomaticTransactionGenerator.probabilityOfStart) {
- skip = 0;
+ const start = Utils.secureRandom();
+ if (start < this.configuration.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));
+ const waitTrxEnd =
+ 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)
+ );
await Utils.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 ' +
+ this.chargingStation.getConnectorStatus(connectorId).transactionId.toString()
+ );
+ await this.stopTransaction(connectorId);
+ }
+ } else {
+ 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.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()
+ )
+ );
+ 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.configuration.stopAfterHours ??
+ Constants.CHARGING_STATION_ATG_DEFAULT_STOP_AFTER_HOURS) *
+ 3600 *
+ 1000 -
+ previousRunDuration
+ );
+ 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<StartTransactionResponse | undefined> {
+ const measureId = 'StartTransaction with ATG';
+ const beginId = PerformanceStatistics.beginMeasure(measureId);
+ let startResponse: StartTransactionResponse;
+ if (this.chargingStation.hasAuthorizedTags()) {
+ const idTag = this.getIdTag(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<StopTransactionResponse> {
+ const measureId = 'StopTransaction with ATG';
+ const beginId = PerformanceStatistics.beginMeasure(measureId);
+ let stopResponse: 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 {
- skip++;
- logger.info(this._logPrefix(connectorId) + ' transaction skipped ' + skip.toString());
+ this.connectorsStatus.get(connectorId).rejectedStopTransactionRequests++;
}
- } while (!this._timeToStop);
- logger.info(this._logPrefix(connectorId) + ' ATG STOPPED on the connector');
+ } else {
+ const transactionId = this.chargingStation.getConnectorStatus(connectorId).transactionId;
+ logger.warn(
+ `${this.logPrefix(connectorId)} stopping a not started transaction${
+ transactionId ? ' ' + transactionId.toString() : ''
+ }`
+ );
+ }
+ PerformanceStatistics.endMeasure(measureId, beginId);
+ return stopResponse;
+ }
+
+ private getRequireAuthorize(): boolean {
+ return this.configuration?.requireAuthorize ?? true;
}
- // eslint-disable-next-line consistent-this
- private async startTransaction(connectorId: number, self: AutomaticTransactionGenerator): Promise<StartTransactionResponse> {
- 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 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);
}
- 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<StopTransactionResponse> {
- return await self._chargingStation.sendStopTransaction(self._chargingStation.getConnector(connectorId).transactionId);
+ private logPrefix(connectorId?: number): string {
+ 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++;
+ }
}
}