-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 PerformanceStatistics from '../performance/PerformanceStatistics';
+import {
+ AutomaticTransactionGeneratorConfiguration,
+ Status,
+} from '../types/AutomaticTransactionGenerator';
+import { MeterValuesRequest, RequestCommand } from '../types/ocpp/Requests';
+import { MeterValuesResponse } from '../types/ocpp/Responses';
+import {
+ AuthorizationStatus,
+ AuthorizeRequest,
+ AuthorizeResponse,
+ StartTransactionRequest,
+ StartTransactionResponse,
+ StopTransactionReason,
+ StopTransactionRequest,
+ 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 { OCPP16ServiceUtils } from './ocpp/1.6/OCPP16ServiceUtils';
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();
- });
+ private static readonly instances: Map<string, AutomaticTransactionGenerator> = new Map<
+ string,
+ AutomaticTransactionGenerator
+ >();
+
+ public readonly configuration: AutomaticTransactionGeneratorConfiguration;
+ public started: boolean;
+ private readonly chargingStation: ChargingStation;
+ private readonly connectorsStatus: Map<number, Status>;
+
+ private constructor(
+ automaticTransactionGeneratorConfiguration: AutomaticTransactionGeneratorConfiguration,
+ chargingStation: ChargingStation
+ ) {
+ this.configuration = automaticTransactionGeneratorConfiguration;
+ this.chargingStation = chargingStation;
+ this.connectorsStatus = new Map<number, Status>();
+ this.stopConnectors();
+ this.started = false;
+ }
+
+ public static getInstance(
+ automaticTransactionGeneratorConfiguration: AutomaticTransactionGeneratorConfiguration,
+ chargingStation: ChargingStation
+ ): AutomaticTransactionGenerator {
+ if (!AutomaticTransactionGenerator.instances.has(chargingStation.hashId)) {
+ AutomaticTransactionGenerator.instances.set(
+ chargingStation.hashId,
+ new AutomaticTransactionGenerator(
+ automaticTransactionGeneratorConfiguration,
+ chargingStation
+ )
+ );
}
+ return AutomaticTransactionGenerator.instances.get(chargingStation.hashId);
}
- get timeToStop(): boolean {
- return this._timeToStop;
+ public start(): void {
+ if (this.started) {
+ logger.error(`${this.logPrefix()} trying to start while already started`);
+ return;
+ }
+ this.startConnectors();
+ this.started = true;
}
- _logPrefix(connectorId: number = null): string {
- if (connectorId) {
- return Utils.logPrefix(' ' + this._chargingStation.stationInfo.name + ' ATG on connector #' + connectorId.toString() + ':');
+ public stop(): void {
+ if (!this.started) {
+ logger.error(`${this.logPrefix()} trying to stop while not started`);
+ return;
}
- return Utils.logPrefix(' ' + this._chargingStation.stationInfo.name + ' ATG:');
+ this.stopConnectors();
+ this.started = false;
}
- start(): void {
- this._timeToStop = false;
- if (this._chargingStation.stationInfo.AutomaticTransactionGenerator.stopAfterHours &&
- this._chargingStation.stationInfo.AutomaticTransactionGenerator.stopAfterHours > 0) {
- setTimeout(() => {
- void 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();
}
- for (const connector in this._chargingStation.connectors) {
- if (Utils.convertToInt(connector) > 0) {
- void 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.initializeConnectorStatus(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) {
+ 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()) {
+ 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()) {
- logger.info(this._logPrefix(connectorId) + ' Entered in transaction loop while the charging station is unavailable');
- await this.stop();
+ if (!this.chargingStation.isChargingStationAvailable()) {
+ logger.info(
+ this.logPrefix(connectorId) +
+ ' entered in transaction loop while the charging station 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.isConnectorAvailable(connectorId)) {
+ 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));
+ 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);
- }
+ const startResponse = await this.startTransaction(connectorId);
+ this.connectorsStatus.get(connectorId).startTransactionRequests++;
if (startResponse?.idTagInfo?.status !== AuthorizationStatus.ACCEPTED) {
- logger.info(this._logPrefix(connectorId) + ' transaction rejected');
- await Utils.sleep(Constants.CHARGING_STATION_ATG_WAIT_TIME);
+ logger.warn(this.logPrefix(connectorId) + ' start transaction rejected');
+ this.connectorsStatus.get(connectorId).rejectedStartTransactionRequests++;
} else {
// 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)
+ );
+ this.connectorsStatus.get(connectorId).acceptedStartTransactionRequests++;
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 {
- 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();
+ }
+ await this.stopTransaction(connectorId);
+ 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)
+ );
}
- // eslint-disable-next-line consistent-this
- private async startTransaction(connectorId: number, self: AutomaticTransactionGenerator): Promise<StartTransactionResponse> {
- if (self._chargingStation.hasAuthorizedTags()) {
- const tagId = self._chargingStation.getRandomTagId();
- if (self._chargingStation.stationInfo.AutomaticTransactionGenerator.requireAuthorize) {
- // Authorize tagId
- const authorizeResponse = await self._chargingStation.sendAuthorize(tagId);
+ 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 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;
+ 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
+ ? 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 async startTransaction(
+ connectorId: number
+ ): Promise<StartTransactionResponse | AuthorizeResponse> {
+ const measureId = 'StartTransaction with ATG';
+ const beginId = PerformanceStatistics.beginMeasure(measureId);
+ let startResponse: StartTransactionResponse;
+ if (this.chargingStation.hasAuthorizedTags()) {
+ const idTag = this.chargingStation.getRandomIdTag();
+ 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) {
- logger.info(self._logPrefix(connectorId) + ' start transaction for tagID ' + tagId);
+ this.connectorsStatus.get(connectorId).acceptedAuthorizeRequests++;
+ logger.info(this.logPrefix(connectorId) + ' start transaction for idTag ' + idTag);
// Start transaction
- return await self._chargingStation.sendStartTransaction(connectorId, tagId);
+ startResponse = await this.chargingStation.ocppRequestService.requestHandler<
+ StartTransactionRequest,
+ StartTransactionResponse
+ >(this.chargingStation, RequestCommand.START_TRANSACTION, {
+ connectorId,
+ idTag,
+ });
+ PerformanceStatistics.endMeasure(measureId, beginId);
+ return startResponse;
}
- return authorizeResponse as StartTransactionResponse;
+ this.connectorsStatus.get(connectorId).rejectedAuthorizeRequests++;
+ PerformanceStatistics.endMeasure(measureId, beginId);
+ return authorizeResponse;
}
- logger.info(self._logPrefix(connectorId) + ' start transaction for tagID ' + tagId);
+ logger.info(this.logPrefix(connectorId) + ' start transaction for idTag ' + idTag);
// Start transaction
- return await self._chargingStation.sendStartTransaction(connectorId, tagId);
+ startResponse = await this.chargingStation.ocppRequestService.requestHandler<
+ StartTransactionRequest,
+ StartTransactionResponse
+ >(this.chargingStation, RequestCommand.START_TRANSACTION, {
+ connectorId,
+ idTag,
+ });
+ PerformanceStatistics.endMeasure(measureId, beginId);
+ return startResponse;
}
- logger.info(self._logPrefix(connectorId) + ' start transaction without a tagID');
- return await self._chargingStation.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 });
+ PerformanceStatistics.endMeasure(measureId, beginId);
+ return startResponse;
+ }
+
+ private async stopTransaction(
+ connectorId: number,
+ reason: StopTransactionReason = StopTransactionReason.NONE
+ ): Promise<StopTransactionResponse> {
+ 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),
+ idTag: this.chargingStation.getTransactionIdTag(transactionId),
+ reason,
+ });
+ this.connectorsStatus.get(connectorId).stopTransactionRequests++;
+ } else {
+ logger.warn(
+ `${this.logPrefix(connectorId)} trying to stop 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 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 && ` on connector #${connectorId.toString()}`
+ }:`
+ );
}
}