-// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
+
+import { randomInt } from 'node:crypto'
import { hoursToMilliseconds, secondsToMilliseconds } from 'date-fns'
-import type { ChargingStation } from './ChargingStation.js'
-import { checkChargingStation } from './Helpers.js'
-import { IdTagsCache } from './IdTagsCache.js'
-import { isIdTagAuthorized } from './ocpp/index.js'
import { BaseError } from '../exception/index.js'
import { PerformanceStatistics } from '../performance/index.js'
import {
AuthorizationStatus,
+ ChargingStationEvents,
RequestCommand,
type StartTransactionRequest,
type StartTransactionResponse,
type StopTransactionResponse
} from '../types/index.js'
import {
+ clone,
Constants,
- cloneObject,
+ convertToDate,
formatDurationMilliSeconds,
- getRandomInteger,
- isNullOrUndefined,
- logPrefix,
+ isValidDate,
logger,
+ logPrefix,
secureRandom,
sleep
} from '../utils/index.js'
+import type { ChargingStation } from './ChargingStation.js'
+import { checkChargingStation } from './Helpers.js'
+import { IdTagsCache } from './IdTagsCache.js'
+import { isIdTagAuthorized } from './ocpp/index.js'
export class AutomaticTransactionGenerator {
private static readonly instances: Map<string, AutomaticTransactionGenerator> = new Map<
public static getInstance (
chargingStation: ChargingStation
): AutomaticTransactionGenerator | undefined {
- if (!AutomaticTransactionGenerator.instances.has(chargingStation.stationInfo.hashId)) {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ if (!AutomaticTransactionGenerator.instances.has(chargingStation.stationInfo!.hashId)) {
AutomaticTransactionGenerator.instances.set(
- chargingStation.stationInfo.hashId,
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ chargingStation.stationInfo!.hashId,
new AutomaticTransactionGenerator(chargingStation)
)
}
- return AutomaticTransactionGenerator.instances.get(chargingStation.stationInfo.hashId)
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ return AutomaticTransactionGenerator.instances.get(chargingStation.stationInfo!.hashId)
+ }
+
+ public static deleteInstance (chargingStation: ChargingStation): boolean {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ return AutomaticTransactionGenerator.instances.delete(chargingStation.stationInfo!.hashId)
}
- public start (): void {
+ public start (stopAbsoluteDuration?: boolean): void {
if (!checkChargingStation(this.chargingStation, this.logPrefix())) {
return
}
return
}
this.starting = true
- this.startConnectors()
+ this.startConnectors(stopAbsoluteDuration)
this.started = true
this.starting = false
}
this.stopping = false
}
- public startConnector (connectorId: number): void {
+ public startConnector (connectorId: number, stopAbsoluteDuration?: boolean): void {
if (!checkChargingStation(this.chargingStation, this.logPrefix(connectorId))) {
return
}
throw new BaseError(`Connector ${connectorId} does not exist`)
}
if (this.connectorsStatus.get(connectorId)?.start === false) {
- this.internalStartConnector(connectorId).catch(Constants.EMPTY_FUNCTION)
+ this.internalStartConnector(connectorId, stopAbsoluteDuration).catch(Constants.EMPTY_FUNCTION)
} else if (this.connectorsStatus.get(connectorId)?.start === true) {
logger.warn(`${this.logPrefix(connectorId)} is already started on connector`)
}
}
}
- private startConnectors (): void {
+ private startConnectors (stopAbsoluteDuration?: boolean): void {
if (
- this.connectorsStatus?.size > 0 &&
+ this.connectorsStatus.size > 0 &&
this.connectorsStatus.size !== this.chargingStation.getNumberOfConnectors()
) {
this.connectorsStatus.clear()
for (const [evseId, evseStatus] of this.chargingStation.evses) {
if (evseId > 0) {
for (const connectorId of evseStatus.connectors.keys()) {
- this.startConnector(connectorId)
+ this.startConnector(connectorId, stopAbsoluteDuration)
}
}
}
} else {
for (const connectorId of this.chargingStation.connectors.keys()) {
if (connectorId > 0) {
- this.startConnector(connectorId)
+ this.startConnector(connectorId, stopAbsoluteDuration)
}
}
}
}
}
- private async internalStartConnector (connectorId: number): Promise<void> {
- this.setStartConnectorStatus(connectorId)
+ private async internalStartConnector (
+ connectorId: number,
+ stopAbsoluteDuration?: boolean
+ ): Promise<void> {
+ this.setStartConnectorStatus(connectorId, stopAbsoluteDuration)
logger.info(
`${this.logPrefix(
connectorId
)}`
)
while (this.connectorsStatus.get(connectorId)?.start === true) {
- await this.waitChargingStationServiceInitialization(connectorId)
await this.waitChargingStationAvailable(connectorId)
await this.waitConnectorAvailable(connectorId)
+ await this.waitRunningTransactionStopped(connectorId)
if (!this.canStartConnector(connectorId)) {
this.stopConnector(connectorId)
break
}
const wait = secondsToMilliseconds(
- getRandomInteger(
+ randomInt(
this.chargingStation.getAutomaticTransactionGeneratorConfiguration()
- .maxDelayBetweenTwoTransactions,
+ ?.minDelayBetweenTwoTransactions,
this.chargingStation.getAutomaticTransactionGeneratorConfiguration()
- .minDelayBetweenTwoTransactions
+ ?.maxDelayBetweenTwoTransactions
)
)
logger.info(`${this.logPrefix(connectorId)} waiting for ${formatDurationMilliSeconds(wait)}`)
const start = secureRandom()
if (
start <
- this.chargingStation.getAutomaticTransactionGeneratorConfiguration().probabilityOfStart
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.chargingStation.getAutomaticTransactionGeneratorConfiguration()!.probabilityOfStart
) {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
this.connectorsStatus.get(connectorId)!.skippedConsecutiveTransactions = 0
// Start transaction
const startResponse = await this.startTransaction(connectorId)
- if (startResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
+ if (startResponse?.idTagInfo.status === AuthorizationStatus.ACCEPTED) {
// Wait until end of transaction
const waitTrxEnd = secondsToMilliseconds(
- getRandomInteger(
- this.chargingStation.getAutomaticTransactionGeneratorConfiguration().maxDuration,
- this.chargingStation.getAutomaticTransactionGeneratorConfiguration().minDuration
+ randomInt(
+ this.chargingStation.getAutomaticTransactionGeneratorConfiguration()?.minDuration,
+ this.chargingStation.getAutomaticTransactionGeneratorConfiguration()?.maxDuration
)
)
logger.info(
- `${this.logPrefix(
- connectorId
- )} transaction started with id ${this.chargingStation.getConnectorStatus(connectorId)
- ?.transactionId} and will stop in ${formatDurationMilliSeconds(waitTrxEnd)}`
+ `${this.logPrefix(connectorId)} transaction started with id ${
+ this.chargingStation.getConnectorStatus(connectorId)?.transactionId
+ } and will stop in ${formatDurationMilliSeconds(waitTrxEnd)}`
)
await sleep(waitTrxEnd)
await this.stopTransaction(connectorId)
}
} else {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- ++this.connectorsStatus.get(connectorId)!.skippedConsecutiveTransactions!
+ ++this.connectorsStatus.get(connectorId)!.skippedConsecutiveTransactions
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- ++this.connectorsStatus.get(connectorId)!.skippedTransactions!
+ ++this.connectorsStatus.get(connectorId)!.skippedTransactions
logger.info(
- `${this.logPrefix(connectorId)} skipped consecutively ${this.connectorsStatus.get(
- connectorId
- )?.skippedConsecutiveTransactions}/${this.connectorsStatus.get(connectorId)
- ?.skippedTransactions} transaction(s)`
+ `${this.logPrefix(connectorId)} skipped consecutively ${
+ this.connectorsStatus.get(connectorId)?.skippedConsecutiveTransactions
+ }/${this.connectorsStatus.get(connectorId)?.skippedTransactions} transaction(s)`
)
}
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
)}`
)
logger.debug(
- `${this.logPrefix(connectorId)} connector status: %j`,
+ `${this.logPrefix(connectorId)} stopped with connector status: %j`,
this.connectorsStatus.get(connectorId)
)
+ this.chargingStation.emit(ChargingStationEvents.updated)
}
- private setStartConnectorStatus (connectorId: number): void {
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.connectorsStatus.get(connectorId)!.skippedConsecutiveTransactions = 0
- const previousRunDuration =
- this.connectorsStatus.get(connectorId)?.startDate != null &&
- this.connectorsStatus.get(connectorId)?.lastRunDate != null
- ? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.connectorsStatus.get(connectorId)!.lastRunDate!.getTime() -
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.connectorsStatus.get(connectorId)!.startDate!.getTime()
- : 0
+ private setStartConnectorStatus (
+ connectorId: number,
+ stopAbsoluteDuration = this.chargingStation.getAutomaticTransactionGeneratorConfiguration()
+ ?.stopAbsoluteDuration
+ ): void {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
this.connectorsStatus.get(connectorId)!.startDate = new Date()
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.connectorsStatus.get(connectorId)!.stopDate = new Date(
+ if (
+ stopAbsoluteDuration === false ||
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.connectorsStatus.get(connectorId)!.startDate!.getTime() +
- hoursToMilliseconds(
- this.chargingStation.getAutomaticTransactionGeneratorConfiguration().stopAfterHours
- ) -
- previousRunDuration
- )
+ !isValidDate(this.connectorsStatus.get(connectorId)!.stopDate)
+ ) {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.connectorsStatus.get(connectorId)!.stopDate = new Date(
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.connectorsStatus.get(connectorId)!.startDate!.getTime() +
+ hoursToMilliseconds(
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.chargingStation.getAutomaticTransactionGeneratorConfiguration()!.stopAfterHours
+ )
+ )
+ }
+ delete this.connectorsStatus.get(connectorId)?.stoppedDate
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.connectorsStatus.get(connectorId)!.skippedConsecutiveTransactions = 0
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
this.connectorsStatus.get(connectorId)!.start = true
+ this.chargingStation.emit(ChargingStationEvents.updated)
}
private canStartConnector (connectorId: number): boolean {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
if (new Date() > this.connectorsStatus.get(connectorId)!.stopDate!) {
+ logger.info(
+ `${this.logPrefix(
+ connectorId
+ )} entered in transaction loop while the ATG stop date has been reached`
+ )
return false
}
if (!this.chargingStation.inAcceptedState()) {
)
return false
}
+ const connectorStatus = this.chargingStation.getConnectorStatus(connectorId)
+ if (connectorStatus?.transactionStarted === true) {
+ logger.info(
+ `${this.logPrefix(connectorId)} entered in transaction loop while a transaction ${
+ connectorStatus.transactionId
+ } is already started on connector ${connectorId}`
+ )
+ return false
+ }
return true
}
- private async waitChargingStationServiceInitialization (connectorId: number): Promise<void> {
+ private async waitChargingStationAvailable (connectorId: number): Promise<void> {
let logged = false
- while (this.chargingStation?.ocppRequestService == null) {
+ while (!this.chargingStation.isChargingStationAvailable()) {
if (!logged) {
logger.info(
`${this.logPrefix(
connectorId
- )} transaction loop waiting for charging station service to be initialized`
+ )} transaction loop waiting for charging station to be available`
)
logged = true
}
- await sleep(Constants.CHARGING_STATION_ATG_INITIALIZATION_TIME)
+ await sleep(Constants.DEFAULT_ATG_WAIT_TIME)
}
}
- private async waitChargingStationAvailable (connectorId: number): Promise<void> {
+ private async waitConnectorAvailable (connectorId: number): Promise<void> {
let logged = false
- while (!this.chargingStation.isChargingStationAvailable()) {
+ while (!this.chargingStation.isConnectorAvailable(connectorId)) {
if (!logged) {
logger.info(
`${this.logPrefix(
connectorId
- )} transaction loop waiting for charging station to be available`
+ )} transaction loop waiting for connector ${connectorId} to be available`
)
logged = true
}
- await sleep(Constants.CHARGING_STATION_ATG_AVAILABILITY_TIME)
+ await sleep(Constants.DEFAULT_ATG_WAIT_TIME)
}
}
- private async waitConnectorAvailable (connectorId: number): Promise<void> {
+ private async waitRunningTransactionStopped (connectorId: number): Promise<void> {
+ const connectorStatus = this.chargingStation.getConnectorStatus(connectorId)
let logged = false
- while (!this.chargingStation.isConnectorAvailable(connectorId)) {
+ while (connectorStatus?.transactionStarted === true) {
if (!logged) {
logger.info(
- `${this.logPrefix(
- connectorId
- )} transaction loop waiting for connector ${connectorId} to be available`
+ `${this.logPrefix(connectorId)} transaction loop waiting for started transaction ${
+ connectorStatus.transactionId
+ } on connector ${connectorId} to be stopped`
)
logged = true
}
- await sleep(Constants.CHARGING_STATION_ATG_AVAILABILITY_TIME)
+ await sleep(Constants.DEFAULT_ATG_WAIT_TIME)
}
}
}
private getConnectorStatus (connectorId: number): Status {
- const connectorStatus =
- this.chargingStation.getAutomaticTransactionGeneratorStatuses()?.[connectorId] != null
- ? cloneObject<Status>(
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.chargingStation.getAutomaticTransactionGeneratorStatuses()![connectorId]
- )
- : undefined
- this.resetConnectorStatus(connectorStatus)
+ const statusIndex = connectorId - 1
+ if (statusIndex < 0) {
+ logger.error(`${this.logPrefix(connectorId)} invalid connector id`)
+ throw new BaseError(`Invalid connector id ${connectorId}`)
+ }
+ let connectorStatus: Status | undefined
+ if (this.chargingStation.getAutomaticTransactionGeneratorStatuses()?.[statusIndex] != null) {
+ connectorStatus = clone<Status>(
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.chargingStation.getAutomaticTransactionGeneratorStatuses()![statusIndex]
+ )
+ } else {
+ logger.warn(
+ `${this.logPrefix(
+ connectorId
+ )} no status found for connector #${connectorId} in charging station configuration file. New status will be created`
+ )
+ }
+ if (connectorStatus != null) {
+ connectorStatus.startDate = convertToDate(connectorStatus.startDate)
+ connectorStatus.lastRunDate = convertToDate(connectorStatus.lastRunDate)
+ connectorStatus.stopDate = convertToDate(connectorStatus.stopDate)
+ connectorStatus.stoppedDate = convertToDate(connectorStatus.stoppedDate)
+ if (
+ !this.started &&
+ (connectorStatus.start ||
+ this.chargingStation.getAutomaticTransactionGeneratorConfiguration()?.enable !== true)
+ ) {
+ connectorStatus.start = false
+ }
+ }
return (
connectorStatus ?? {
start: false,
)
}
- private resetConnectorStatus (connectorStatus: Status | undefined): void {
- if (connectorStatus === undefined) {
- return
- }
- delete connectorStatus?.startDate
- delete connectorStatus?.lastRunDate
- delete connectorStatus?.stopDate
- delete connectorStatus?.stoppedDate
- if (
- !this.started &&
- (connectorStatus.start ||
- !this.chargingStation.getAutomaticTransactionGeneratorConfiguration().enable)
- ) {
- connectorStatus.start = false
- }
- }
-
private async startTransaction (
connectorId: number
): Promise<StartTransactionResponse | undefined> {
if (this.chargingStation.hasIdTags()) {
const idTag = IdTagsCache.getInstance().getIdTag(
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- this.chargingStation.getAutomaticTransactionGeneratorConfiguration().idTagDistribution!,
+ this.chargingStation.getAutomaticTransactionGeneratorConfiguration()!.idTagDistribution!,
this.chargingStation,
connectorId
)
)} start transaction with an idTag '${idTag}'`
if (this.getRequireAuthorize()) {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- ++this.connectorsStatus.get(connectorId)!.authorizeRequests!
+ ++this.connectorsStatus.get(connectorId)!.authorizeRequests
if (await isIdTagAuthorized(this.chargingStation, connectorId, idTag)) {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- ++this.connectorsStatus.get(connectorId)!.acceptedAuthorizeRequests!
+ ++this.connectorsStatus.get(connectorId)!.acceptedAuthorizeRequests
logger.info(startTransactionLogMsg)
// Start transaction
startResponse = await this.chargingStation.ocppRequestService.requestHandler<
- StartTransactionRequest,
+ Partial<StartTransactionRequest>,
StartTransactionResponse
>(this.chargingStation, RequestCommand.START_TRANSACTION, {
connectorId,
return startResponse
}
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- ++this.connectorsStatus.get(connectorId)!.rejectedAuthorizeRequests!
+ ++this.connectorsStatus.get(connectorId)!.rejectedAuthorizeRequests
PerformanceStatistics.endMeasure(measureId, beginId)
return startResponse
}
logger.info(startTransactionLogMsg)
// Start transaction
startResponse = await this.chargingStation.ocppRequestService.requestHandler<
- StartTransactionRequest,
+ Partial<StartTransactionRequest>,
StartTransactionResponse
>(this.chargingStation, RequestCommand.START_TRANSACTION, {
connectorId,
}
logger.info(`${this.logPrefix(connectorId)} start transaction without an idTag`)
startResponse = await this.chargingStation.ocppRequestService.requestHandler<
- StartTransactionRequest,
+ Partial<StartTransactionRequest>,
StartTransactionResponse
- >(this.chargingStation, RequestCommand.START_TRANSACTION, { connectorId })
+ >(this.chargingStation, RequestCommand.START_TRANSACTION, {
+ connectorId
+ })
this.handleStartTransactionResponse(connectorId, startResponse)
PerformanceStatistics.endMeasure(measureId, beginId)
return startResponse
let stopResponse: StopTransactionResponse | undefined
if (this.chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) {
logger.info(
- `${this.logPrefix(
- connectorId
- )} stop transaction with id ${this.chargingStation.getConnectorStatus(connectorId)
- ?.transactionId}`
+ `${this.logPrefix(connectorId)} stop transaction with id ${
+ this.chargingStation.getConnectorStatus(connectorId)?.transactionId
+ }`
)
stopResponse = await this.chargingStation.stopTransactionOnConnector(connectorId, reason)
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- ++this.connectorsStatus.get(connectorId)!.stopTransactionRequests!
- if (stopResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
+ ++this.connectorsStatus.get(connectorId)!.stopTransactionRequests
+ if (stopResponse.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- ++this.connectorsStatus.get(connectorId)!.acceptedStopTransactionRequests!
+ ++this.connectorsStatus.get(connectorId)!.acceptedStopTransactionRequests
} else {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- ++this.connectorsStatus.get(connectorId)!.rejectedStopTransactionRequests!
+ ++this.connectorsStatus.get(connectorId)!.rejectedStopTransactionRequests
}
} else {
const transactionId = this.chargingStation.getConnectorStatus(connectorId)?.transactionId
logger.debug(
`${this.logPrefix(connectorId)} stopping a not started transaction${
- !isNullOrUndefined(transactionId) ? ` with id ${transactionId}` : ''
+ transactionId != null ? ` with id ${transactionId}` : ''
}`
)
}
private readonly logPrefix = (connectorId?: number): string => {
return logPrefix(
- ` ${this.chargingStation.stationInfo.chargingStationId} | ATG${
- !isNullOrUndefined(connectorId) ? ` on connector #${connectorId}` : ''
+ ` ${this.chargingStation.stationInfo?.chargingStationId} | ATG${
+ connectorId != null ? ` on connector #${connectorId}` : ''
}:`
)
}
startResponse: StartTransactionResponse
): void {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- ++this.connectorsStatus.get(connectorId)!.startTransactionRequests!
- if (startResponse?.idTagInfo?.status === AuthorizationStatus.ACCEPTED) {
+ ++this.connectorsStatus.get(connectorId)!.startTransactionRequests
+ if (startResponse.idTagInfo.status === AuthorizationStatus.ACCEPTED) {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- ++this.connectorsStatus.get(connectorId)!.acceptedStartTransactionRequests!
+ ++this.connectorsStatus.get(connectorId)!.acceptedStartTransactionRequests
} else {
logger.warn(`${this.logPrefix(connectorId)} start transaction rejected`)
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- ++this.connectorsStatus.get(connectorId)!.rejectedStartTransactionRequests!
+ ++this.connectorsStatus.get(connectorId)!.rejectedStartTransactionRequests
}
}
}