fix: send preparing connector status before `StartTransaction`
[e-mobility-charging-stations-simulator.git] / src / charging-station / ocpp / 1.6 / OCPP16IncomingRequestService.ts
index efc3acbace22690d8a374e27657aba7230070dfc..6cafcd4bbc7ad0e136123cc2f1a173a2abe09c7a 100644 (file)
@@ -1,26 +1,26 @@
 // Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
 
+import { randomInt } from 'node:crypto'
 import { createWriteStream, readdirSync } from 'node:fs'
-import { dirname, join, resolve } from 'node:path'
-import { URL, fileURLToPath } from 'node:url'
+import { dirname, extname, join, resolve } from 'node:path'
+import { fileURLToPath, URL } from 'node:url'
 
 import type { ValidateFunction } from 'ajv'
 import { Client, type FTPResponse } from 'basic-ftp'
 import {
-  type Interval,
   addSeconds,
   differenceInSeconds,
+  type Interval,
   isDate,
   secondsToMilliseconds
 } from 'date-fns'
 import { maxTime } from 'date-fns/constants'
+import { isEmpty } from 'rambda'
 import { create } from 'tar'
 
-import { OCPP16Constants } from './OCPP16Constants.js'
-import { OCPP16ServiceUtils } from './OCPP16ServiceUtils.js'
 import {
-  type ChargingStation,
   canProceedChargingProfile,
+  type ChargingStation,
   checkChargingStation,
   getConfigurationKey,
   getConnectorChargingProfiles,
@@ -32,6 +32,7 @@ import { OCPPError } from '../../../exception/index.js'
 import {
   type ChangeConfigurationRequest,
   type ChangeConfigurationResponse,
+  ConfigurationSection,
   ErrorType,
   type GenericResponse,
   GenericStatus,
@@ -41,6 +42,7 @@ import {
   type GetDiagnosticsResponse,
   type IncomingRequestHandler,
   type JsonType,
+  type LogConfiguration,
   OCPP16AuthorizationStatus,
   OCPP16AvailabilityType,
   type OCPP16BootNotificationRequest,
@@ -83,6 +85,7 @@ import {
   OCPP16SupportedFeatureProfiles,
   type OCPP16TriggerMessageRequest,
   type OCPP16TriggerMessageResponse,
+  OCPP16TriggerMessageStatus,
   type OCPP16UpdateFirmwareRequest,
   type OCPP16UpdateFirmwareResponse,
   type OCPPConfigurationKey,
@@ -97,18 +100,20 @@ import {
   type UnlockConnectorResponse
 } from '../../../types/index.js'
 import {
+  Configuration,
   Constants,
   convertToDate,
   convertToInt,
   formatDurationMilliSeconds,
-  getRandomInteger,
-  isEmptyArray,
+  isAsyncFunction,
   isNotEmptyArray,
   isNotEmptyString,
   logger,
   sleep
 } from '../../../utils/index.js'
 import { OCPPIncomingRequestService } from '../OCPPIncomingRequestService.js'
+import { OCPP16Constants } from './OCPP16Constants.js'
+import { OCPP16ServiceUtils } from './OCPP16ServiceUtils.js'
 
 const moduleName = 'OCPP16IncomingRequestService'
 
@@ -404,6 +409,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
           .bind(this)
       ]
     ])
+    // Handle incoming request events
     this.on(
       OCPP16IncomingRequestCommand.REMOTE_START_TRANSACTION,
       (
@@ -435,7 +441,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
                 )
               }
             })
-            .catch(error => {
+            .catch((error: unknown) => {
               logger.error(
                 `${chargingStation.logPrefix()} ${moduleName}.constructor: Remote start transaction error:`,
                 error
@@ -444,11 +450,50 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
         }
       }
     )
+    this.on(
+      OCPP16IncomingRequestCommand.REMOTE_STOP_TRANSACTION,
+      (
+        chargingStation: ChargingStation,
+        request: RemoteStopTransactionRequest,
+        response: GenericResponse
+      ) => {
+        if (response.status === GenericStatus.Accepted) {
+          const { transactionId } = request
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          const connectorId = chargingStation.getConnectorIdByTransactionId(transactionId)!
+          OCPP16ServiceUtils.remoteStopTransaction(chargingStation, connectorId)
+            .then(response => {
+              if (response.status === GenericStatus.Accepted) {
+                logger.debug(
+                  `${chargingStation.logPrefix()} Remote stop transaction ACCEPTED on ${chargingStation.stationInfo?.chargingStationId}#${connectorId} for transaction '${transactionId}'`
+                )
+              } else {
+                logger.debug(
+                  `${chargingStation.logPrefix()} Remote stop transaction REJECTED on ${chargingStation.stationInfo?.chargingStationId}#${connectorId} for transaction '${transactionId}'`
+                )
+              }
+            })
+            .catch((error: unknown) => {
+              logger.error(
+                `${chargingStation.logPrefix()} ${moduleName}.constructor: Remote stop transaction error:`,
+                error
+              )
+            })
+        }
+      }
+    )
     this.on(
       OCPP16IncomingRequestCommand.TRIGGER_MESSAGE,
-      (chargingStation: ChargingStation, request: OCPP16TriggerMessageRequest) => {
+      (
+        chargingStation: ChargingStation,
+        request: OCPP16TriggerMessageRequest,
+        response: OCPP16TriggerMessageResponse
+      ) => {
+        if (response.status !== OCPP16TriggerMessageStatus.ACCEPTED) {
+          return
+        }
         const { requestedMessage, connectorId } = request
-        const errorHandler = (error: Error): void => {
+        const errorHandler = (error: unknown): void => {
           logger.error(
             `${chargingStation.logPrefix()} ${moduleName}.constructor: Trigger ${requestedMessage} error:`,
             error
@@ -583,11 +628,12 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
           this.validatePayload(chargingStation, commandName, commandPayload)
           // Call the method to build the response
           // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-          response = (await this.incomingRequestHandlers.get(commandName)!(
-            chargingStation,
-            commandPayload
-          )) as ResType
-          this.emit(commandName, chargingStation, commandPayload, response)
+          const incomingRequestHandler = this.incomingRequestHandlers.get(commandName)!
+          if (isAsyncFunction(incomingRequestHandler)) {
+            response = (await incomingRequestHandler(chargingStation, commandPayload)) as ResType
+          } else {
+            response = incomingRequestHandler(chargingStation, commandPayload) as ResType
+          }
         } catch (error) {
           // Log
           logger.error(
@@ -600,7 +646,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
         // Throw exception
         throw new OCPPError(
           ErrorType.NOT_IMPLEMENTED,
-          `${commandName} is not implemented to handle request PDU ${JSON.stringify(
+          `'${commandName}' is not implemented to handle request PDU ${JSON.stringify(
             commandPayload,
             undefined,
             2
@@ -616,7 +662,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
           commandPayload,
           undefined,
           2
-        )} while the charging station is not registered on the central server.`,
+        )} while the charging station is not registered on the central server`,
         commandName,
         commandPayload
       )
@@ -628,6 +674,8 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
       response,
       commandName
     )
+    // Emit command name event to allow delayed handling
+    this.emit(commandName, chargingStation, commandPayload, response)
   }
 
   private validatePayload (
@@ -895,8 +943,8 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     }
     const connectorStatus = chargingStation.getConnectorStatus(connectorId)
     if (
-      isEmptyArray(connectorStatus?.chargingProfiles) &&
-      isEmptyArray(chargingStation.getConnectorStatus(0)?.chargingProfiles)
+      isEmpty(connectorStatus?.chargingProfiles) &&
+      isEmpty(chargingStation.getConnectorStatus(0)?.chargingProfiles)
     ) {
       return OCPP16Constants.OCPP_RESPONSE_REJECTED
     }
@@ -1105,7 +1153,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
   ): Promise<GenericResponse> {
     const { connectorId: transactionConnectorId, idTag, chargingProfile } = commandPayload
     if (!chargingStation.hasConnector(transactionConnectorId)) {
-      return await this.notifyRemoteStartTransactionRejected(
+      return this.notifyRemoteStartTransactionRejected(
         chargingStation,
         transactionConnectorId,
         idTag
@@ -1115,7 +1163,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
       !chargingStation.isChargingStationAvailable() ||
       !chargingStation.isConnectorAvailable(transactionConnectorId)
     ) {
-      return await this.notifyRemoteStartTransactionRejected(
+      return this.notifyRemoteStartTransactionRejected(
         chargingStation,
         transactionConnectorId,
         idTag
@@ -1126,17 +1174,12 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
       chargingStation.getAuthorizeRemoteTxRequests() &&
       !(await OCPP16ServiceUtils.isIdTagAuthorized(chargingStation, transactionConnectorId, idTag))
     ) {
-      return await this.notifyRemoteStartTransactionRejected(
+      return this.notifyRemoteStartTransactionRejected(
         chargingStation,
         transactionConnectorId,
         idTag
       )
     }
-    await OCPP16ServiceUtils.sendAndSetConnectorStatus(
-      chargingStation,
-      transactionConnectorId,
-      OCPP16ChargePointStatus.Preparing
-    )
     if (
       chargingProfile != null &&
       !this.setRemoteStartTransactionChargingProfile(
@@ -1145,30 +1188,26 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
         chargingProfile
       )
     ) {
-      return await this.notifyRemoteStartTransactionRejected(
+      return this.notifyRemoteStartTransactionRejected(
         chargingStation,
         transactionConnectorId,
         idTag
       )
     }
+    logger.debug(
+      `${chargingStation.logPrefix()} Remote start transaction ACCEPTED on ${chargingStation.stationInfo?.chargingStationId}#${transactionConnectorId}}, idTag '${idTag}'`
+    )
     return OCPP16Constants.OCPP_RESPONSE_ACCEPTED
   }
 
-  private async notifyRemoteStartTransactionRejected (
+  private notifyRemoteStartTransactionRejected (
     chargingStation: ChargingStation,
     connectorId: number,
     idTag: string
-  ): Promise<GenericResponse> {
+  ): GenericResponse {
     const connectorStatus = chargingStation.getConnectorStatus(connectorId)
-    if (connectorStatus?.status !== OCPP16ChargePointStatus.Available) {
-      await OCPP16ServiceUtils.sendAndSetConnectorStatus(
-        chargingStation,
-        connectorId,
-        OCPP16ChargePointStatus.Available
-      )
-    }
-    logger.warn(
-      `${chargingStation.logPrefix()} Remote start transaction REJECTED on connector id ${connectorId}, idTag '${idTag}', availability '${connectorStatus?.availability}', status '${connectorStatus?.status}'`
+    logger.debug(
+      `${chargingStation.logPrefix()} Remote start transaction REJECTED on ${chargingStation.stationInfo?.chargingStationId}#${connectorId}, idTag '${idTag}', availability '${connectorStatus?.availability}', status '${connectorStatus?.status}'`
     )
     return OCPP16Constants.OCPP_RESPONSE_REJECTED
   }
@@ -1181,12 +1220,12 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     if (chargingProfile.chargingProfilePurpose === OCPP16ChargingProfilePurposeType.TX_PROFILE) {
       OCPP16ServiceUtils.setChargingProfile(chargingStation, connectorId, chargingProfile)
       logger.debug(
-        `${chargingStation.logPrefix()} Charging profile(s) set at remote start transaction on connector id ${connectorId}: %j`,
+        `${chargingStation.logPrefix()} Charging profile(s) set at remote start transaction on ${chargingStation.stationInfo?.chargingStationId}#${connectorId}`,
         chargingProfile
       )
       return true
     }
-    logger.warn(
+    logger.debug(
       `${chargingStation.logPrefix()} Not allowed to set ${
         chargingProfile.chargingProfilePurpose
       } charging profile(s) at remote start transaction`
@@ -1194,33 +1233,19 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     return false
   }
 
-  private async handleRequestRemoteStopTransaction (
+  private handleRequestRemoteStopTransaction (
     chargingStation: ChargingStation,
     commandPayload: RemoteStopTransactionRequest
-  ): Promise<GenericResponse> {
+  ): GenericResponse {
     const { transactionId } = commandPayload
-    if (chargingStation.hasEvses) {
-      for (const [evseId, evseStatus] of chargingStation.evses) {
-        if (evseId > 0) {
-          for (const [connectorId, connectorStatus] of evseStatus.connectors) {
-            if (connectorStatus.transactionId === transactionId) {
-              return await OCPP16ServiceUtils.remoteStopTransaction(chargingStation, connectorId)
-            }
-          }
-        }
-      }
-    } else {
-      for (const connectorId of chargingStation.connectors.keys()) {
-        if (
-          connectorId > 0 &&
-          chargingStation.getConnectorStatus(connectorId)?.transactionId === transactionId
-        ) {
-          return await OCPP16ServiceUtils.remoteStopTransaction(chargingStation, connectorId)
-        }
-      }
+    if (chargingStation.getConnectorIdByTransactionId(transactionId) != null) {
+      logger.debug(
+        `${chargingStation.logPrefix()} Remote stop transaction ACCEPTED for transactionId '${transactionId}'`
+      )
+      return OCPP16Constants.OCPP_RESPONSE_ACCEPTED
     }
-    logger.warn(
-      `${chargingStation.logPrefix()} Trying to remote stop a non existing transaction with id ${transactionId}`
+    logger.debug(
+      `${chargingStation.logPrefix()} Remote stop transaction REJECTED for transactionId '${transactionId}'`
     )
     return OCPP16Constants.OCPP_RESPONSE_REJECTED
   }
@@ -1309,7 +1334,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
       chargingStation.stationInfo?.firmwareUpgrade?.failureStatus ===
       OCPP16FirmwareStatus.DownloadFailed
     ) {
-      await sleep(secondsToMilliseconds(getRandomInteger(maxDelay, minDelay)))
+      await sleep(secondsToMilliseconds(randomInt(minDelay, maxDelay)))
       await chargingStation.ocppRequestService.requestHandler<
       OCPP16FirmwareStatusNotificationRequest,
       OCPP16FirmwareStatusNotificationResponse
@@ -1320,7 +1345,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
         chargingStation.stationInfo.firmwareUpgrade.failureStatus
       return
     }
-    await sleep(secondsToMilliseconds(getRandomInteger(maxDelay, minDelay)))
+    await sleep(secondsToMilliseconds(randomInt(minDelay, maxDelay)))
     await chargingStation.ocppRequestService.requestHandler<
     OCPP16FirmwareStatusNotificationRequest,
     OCPP16FirmwareStatusNotificationResponse
@@ -1376,8 +1401,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
         transactionsStarted = false
       }
     } while (transactionsStarted)
-    !wasTransactionsStarted &&
-      (await sleep(secondsToMilliseconds(getRandomInteger(maxDelay, minDelay))))
+    !wasTransactionsStarted && (await sleep(secondsToMilliseconds(randomInt(minDelay, maxDelay))))
     if (!checkChargingStation(chargingStation, chargingStation.logPrefix())) {
       return
     }
@@ -1393,7 +1417,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
       chargingStation.stationInfo?.firmwareUpgrade?.failureStatus ===
       OCPP16FirmwareStatus.InstallationFailed
     ) {
-      await sleep(secondsToMilliseconds(getRandomInteger(maxDelay, minDelay)))
+      await sleep(secondsToMilliseconds(randomInt(minDelay, maxDelay)))
       await chargingStation.ocppRequestService.requestHandler<
       OCPP16FirmwareStatusNotificationRequest,
       OCPP16FirmwareStatusNotificationResponse
@@ -1405,7 +1429,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
       return
     }
     if (chargingStation.stationInfo?.firmwareUpgrade?.reset === true) {
-      await sleep(secondsToMilliseconds(getRandomInteger(maxDelay, minDelay)))
+      await sleep(secondsToMilliseconds(randomInt(minDelay, maxDelay)))
       await chargingStation.reset(OCPP16StopTransactionReason.REBOOT)
     }
   }
@@ -1431,14 +1455,19 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     if (uri.protocol.startsWith('ftp:')) {
       let ftpClient: Client | undefined
       try {
+        const logConfiguration = Configuration.getConfigurationSection<LogConfiguration>(
+          ConfigurationSection.log
+        )
         const logFiles = readdirSync(resolve(dirname(fileURLToPath(import.meta.url)), '../'))
-          .filter(file => file.endsWith('.log'))
-          .map(file => join('./', file))
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          .filter(file => file.endsWith(extname(logConfiguration.file!)))
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          .map(file => join(dirname(logConfiguration.file!), file))
         const diagnosticsArchive = `${chargingStation.stationInfo?.chargingStationId}_logs.tar.gz`
         create({ gzip: true }, logFiles).pipe(createWriteStream(diagnosticsArchive))
         ftpClient = new Client()
         const accessResponse = await ftpClient.access({
-          host: uri.host,
+          host: uri.hostname,
           ...(isNotEmptyString(uri.port) && { port: convertToInt(uri.port) }),
           ...(isNotEmptyString(uri.username) && { user: uri.username }),
           ...(isNotEmptyString(uri.password) && { password: uri.password })
@@ -1458,7 +1487,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
             >(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, {
               status: OCPP16DiagnosticsStatus.Uploading
             })
-              .catch(error => {
+              .catch((error: unknown) => {
                 logger.error(
                   `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: Error while sending '${
                     OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION