-// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
-import { AuthorizationStatus, AuthorizeResponse, StartTransactionResponse, StopTransactionReason, StopTransactionResponse } from '../types/ocpp/Transaction';
+import { AsyncResource } from 'node:async_hooks';
-import ChargingStation from './ChargingStation';
-import Constants from '../utils/Constants';
-import PerformanceStatistics from '../performance/PerformanceStatistics';
-import Utils from '../utils/Utils';
-import logger from '../utils/Logger';
+import { type ChargingStation, ChargingStationUtils, IdTagsCache } from './internal';
+import { BaseError } from '../exception';
+// import { PerformanceStatistics } from '../performance';
+import { PerformanceStatistics } from '../performance/PerformanceStatistics';
+import {
+ AuthorizationStatus,
+ type AuthorizeRequest,
+ type AuthorizeResponse,
+ type AutomaticTransactionGeneratorConfiguration,
+ ConnectorStatusEnum,
+ RequestCommand,
+ type StartTransactionRequest,
+ type StartTransactionResponse,
+ type Status,
+ StopTransactionReason,
+ type StopTransactionResponse,
+} from '../types';
+import { Constants, Utils, logger } from '../utils';
-export default class AutomaticTransactionGenerator {
+const moduleName = 'AutomaticTransactionGenerator';
+
+export 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 chargingStation: ChargingStation;
- private connectorsStartStatus: Record<number, boolean>;
- private startDate!: Date;
- private lastRunDate!: Date;
- private stopDate!: Date;
+ private readonly chargingStation: ChargingStation;
- constructor(chargingStation: ChargingStation) {
- this.chargingStation = chargingStation;
- this.connectorsStartStatus = {} as Record<number, boolean>;
- this.stopConnectors();
+ private constructor(
+ automaticTransactionGeneratorConfiguration: AutomaticTransactionGeneratorConfiguration,
+ chargingStation: ChargingStation
+ ) {
+ super(moduleName);
this.started = false;
+ this.configuration = automaticTransactionGeneratorConfiguration;
+ this.chargingStation = chargingStation;
+ this.connectorsStatus = new Map<number, Status>();
+ this.initializeConnectorsStatus();
+ }
+
+ public static getInstance(
+ automaticTransactionGeneratorConfiguration: AutomaticTransactionGeneratorConfiguration,
+ chargingStation: ChargingStation
+ ): AutomaticTransactionGenerator | undefined {
+ 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) {
- logger.error(`${this.logPrefix()} trying to start while already started`);
+ if (
+ ChargingStationUtils.checkChargingStation(this.chargingStation, this.logPrefix()) === false
+ ) {
+ return;
+ }
+ if (this.started === true) {
+ logger.warn(`${this.logPrefix()} is already started`);
return;
}
- const previousRunDuration = (this?.startDate && this?.lastRunDate) ? (this.lastRunDate.getTime() - this.startDate.getTime()) : 0;
- this.startDate = new Date();
- this.lastRunDate = this.startDate;
- this.stopDate = new Date(this.startDate.getTime()
- + (this.chargingStation.stationInfo?.AutomaticTransactionGenerator?.stopAfterHours ?? Constants.CHARGING_STATION_ATG_DEFAULT_STOP_AFTER_HOURS) * 3600 * 1000
- - previousRunDuration);
this.startConnectors();
this.started = true;
- logger.info(this.logPrefix() + ' started and will run for ' + Utils.formatDurationMilliSeconds(this.stopDate.getTime() - this.startDate.getTime()));
}
public stop(): void {
- if (!this.started) {
- logger.error(`${this.logPrefix()} trying to stop while not started`);
+ if (this.started === false) {
+ logger.warn(`${this.logPrefix()} is already stopped`);
return;
}
this.stopConnectors();
this.started = false;
- logger.info(`${this.logPrefix()} over and lasted for ${Utils.formatDurationMilliSeconds(this.lastRunDate.getTime() - this.startDate.getTime())}. Stopping all transactions`);
+ }
+
+ public startConnector(connectorId: number): void {
+ if (
+ ChargingStationUtils.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: any[]
+ ) => Promise<void>,
+ this,
+ connectorId
+ ).catch(Constants.EMPTY_FUNCTION);
+ } else if (this.connectorsStatus.get(connectorId)?.start === true) {
+ logger.warn(`${this.logPrefix(connectorId)} is already started on connector`);
+ }
+ }
+
+ 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`);
+ }
}
private startConnectors(): void {
- for (const connector in this.chargingStation.connectors) {
- const connectorId = Utils.convertToInt(connector);
+ if (
+ this.connectorsStatus?.size > 0 &&
+ this.connectorsStatus.size !== this.chargingStation.getNumberOfConnectors()
+ ) {
+ this.connectorsStatus.clear();
+ this.initializeConnectorsStatus();
+ }
+ for (const connectorId of this.chargingStation.connectors.keys()) {
if (connectorId > 0) {
- // Avoid hogging the event loop with a busy loop
- setImmediate(() => {
- this.startConnector(connectorId).catch(() => { /* This is intentional */ });
- });
+ this.startConnector(connectorId);
}
}
}
private stopConnectors(): void {
- for (const connector in this.chargingStation.connectors) {
- const connectorId = Utils.convertToInt(connector);
+ for (const connectorId of this.chargingStation.connectors.keys()) {
if (connectorId > 0) {
this.stopConnector(connectorId);
}
}
}
- private async startConnector(connectorId: number): Promise<void> {
- logger.info(this.logPrefix(connectorId) + ' started on connector');
- let skippedTransactions = 0;
- let skippedTransactionsTotal = 0;
- this.connectorsStartStatus[connectorId] = true;
- while (this.connectorsStartStatus[connectorId]) {
- if ((new Date()) > this.stopDate) {
- this.stop();
+ 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.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.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()) {
- logger.info(this.logPrefix(connectorId) + ' Entered in transaction loop while the charging station is unavailable');
- this.stop();
+ 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.isConnectorAvailable(connectorId)) {
- logger.info(`${this.logPrefix(connectorId)} Entered in transaction loop while the connector ${connectorId} is unavailable, stop it`);
+ 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`);
+ 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.chargingStation.stationInfo.AutomaticTransactionGenerator.maxDelayBetweenTwoTransactions,
- this.chargingStation.stationInfo.AutomaticTransactionGenerator.minDelayBetweenTwoTransactions) * 1000;
- logger.info(this.logPrefix(connectorId) + ' waiting for ' + Utils.formatDurationMilliSeconds(wait));
+ 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 = Utils.secureRandom();
- if (start < this.chargingStation.stationInfo.AutomaticTransactionGenerator.probabilityOfStart) {
- skippedTransactions = 0;
+ if (start < this.configuration.probabilityOfStart) {
+ this.connectorsStatus.get(connectorId).skippedConsecutiveTransactions = 0;
// Start transaction
const startResponse = await this.startTransaction(connectorId);
- if (startResponse?.idTagInfo?.status !== AuthorizationStatus.ACCEPTED) {
- logger.warn(this.logPrefix(connectorId) + ' transaction rejected');
- await Utils.sleep(Constants.CHARGING_STATION_ATG_WAIT_TIME);
- } 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;
- logger.info(this.logPrefix(connectorId) + ' transaction ' + this.chargingStation.getConnector(connectorId).transactionId.toString() + ' will stop in ' + Utils.formatDurationMilliSeconds(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
- logger.info(this.logPrefix(connectorId) + ' stop transaction ' + this.chargingStation.getConnector(connectorId).transactionId.toString());
+ logger.info(
+ `${this.logPrefix(connectorId)} stop transaction ${this.chargingStation
+ .getConnectorStatus(connectorId)
+ ?.transactionId?.toString()}`
+ );
await this.stopTransaction(connectorId);
}
} else {
- skippedTransactions++;
- skippedTransactionsTotal++;
- logger.info(this.logPrefix(connectorId) + ' skipped transaction ' + skippedTransactions.toString() + '/' + skippedTransactionsTotal.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)`
+ );
}
- this.lastRunDate = new Date();
+ this.connectorsStatus.get(connectorId).lastRunDate = new Date();
}
- await this.stopTransaction(connectorId);
- logger.info(this.logPrefix(connectorId) + ' stopped on connector');
+ 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 stopConnector(connectorId: number): void {
- this.connectorsStartStatus[connectorId] = false;
+ 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 | AuthorizeResponse> {
+ 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.chargingStation.getRandomIdTag();
- if (this.chargingStation.getAutomaticTransactionGeneratorRequireAuthorize()) {
+ if (this.chargingStation.hasIdTags()) {
+ const idTag = IdTagsCache.getInstance().getIdTag(
+ this.configuration?.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 = await this.chargingStation.ocppRequestService.sendAuthorize(connectorId, 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) {
- logger.info(this.logPrefix(connectorId) + ' start transaction for idTag ' + idTag);
+ this.connectorsStatus.get(connectorId).acceptedAuthorizeRequests++;
+ logger.info(startTransactionLogMsg);
// Start transaction
- startResponse = await this.chargingStation.ocppRequestService.sendStartTransaction(connectorId, idTag);
+ 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.sendStartTransaction(connectorId, idTag);
+ 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.sendStartTransaction(connectorId);
+ 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): Promise<StopTransactionResponse> {
+ private async stopTransaction(
+ connectorId: number,
+ reason: StopTransactionReason = StopTransactionReason.LOCAL
+ ): Promise<StopTransactionResponse> {
const measureId = 'StopTransaction with ATG';
const beginId = PerformanceStatistics.beginMeasure(measureId);
- let transactionId = 0;
let stopResponse: StopTransactionResponse;
- if (this.chargingStation.getConnector(connectorId)?.transactionStarted) {
- transactionId = this.chargingStation.getConnector(connectorId).transactionId;
- stopResponse = await this.chargingStation.ocppRequestService.sendStopTransaction(transactionId,
- this.chargingStation.getEnergyActiveImportRegisterByTransactionId(transactionId),
- 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 {
- logger.warn(`${this.logPrefix(connectorId)} trying to stop a not started transaction${transactionId ? ' ' + transactionId.toString() : ''}`);
+ const transactionId = this.chargingStation.getConnectorStatus(connectorId)?.transactionId;
+ logger.warn(
+ `${this.logPrefix(connectorId)} stopping a not started transaction${
+ !Utils.isNullOrUndefined(transactionId) ? ` ${transactionId?.toString()}` : ''
+ }`
+ );
}
PerformanceStatistics.endMeasure(measureId, beginId);
return stopResponse;
}
- private logPrefix(connectorId?: number): string {
- if (connectorId) {
- return Utils.logPrefix(' ' + this.chargingStation.stationInfo.chargingStationId + ' | ATG on connector #' + connectorId.toString() + ':');
+ private getRequireAuthorize(): boolean {
+ return this.configuration?.requireAuthorize ?? true;
+ }
+
+ private logPrefix = (connectorId?: number): string => {
+ return Utils.logPrefix(
+ ` ${this.chargingStation.stationInfo.chargingStationId} | ATG${
+ !Utils.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++;
}
- return Utils.logPrefix(' ' + this.chargingStation.stationInfo.chargingStationId + ' | ATG:');
}
}