refactor: factor out remote stop transaction helper
[e-mobility-charging-stations-simulator.git] / src / charging-station / ocpp / 1.6 / OCPP16IncomingRequestService.ts
index 5fa160c3fa453ace012e645d4039f5efda0d1b25..20cedf507ab556b110504b6202c670ed7551f5e5 100644 (file)
@@ -6,24 +6,23 @@ import { URL, fileURLToPath } from 'node:url';
 
 import type { JSONSchemaType } from 'ajv';
 import { Client, type FTPResponse } from 'basic-ftp';
+import { secondsToMilliseconds } from 'date-fns';
 import { create } from 'tar';
 
 import { OCPP16Constants } from './OCPP16Constants';
 import { OCPP16ServiceUtils } from './OCPP16ServiceUtils';
 import {
   type ChargingStation,
-  ChargingStationConfigurationUtils,
   checkChargingStation,
+  getConfigurationKey,
+  setConfigurationKeyValue,
 } from '../../../charging-station';
 import { OCPPError } from '../../../exception';
 import {
-  type ChangeAvailabilityRequest,
-  type ChangeAvailabilityResponse,
   type ChangeConfigurationRequest,
   type ChangeConfigurationResponse,
   type ClearChargingProfileRequest,
   type ClearChargingProfileResponse,
-  type ConnectorStatus,
   ErrorType,
   type GenericResponse,
   GenericStatus,
@@ -39,6 +38,8 @@ import {
   type OCPP16BootNotificationRequest,
   type OCPP16BootNotificationResponse,
   type OCPP16CancelReservationRequest,
+  type OCPP16ChangeAvailabilityRequest,
+  type OCPP16ChangeAvailabilityResponse,
   OCPP16ChargePointErrorCode,
   OCPP16ChargePointStatus,
   type OCPP16ChargingProfile,
@@ -78,12 +79,10 @@ import {
   OCPPVersion,
   type RemoteStartTransactionRequest,
   type RemoteStopTransactionRequest,
-  ReservationFilterKey,
   ReservationTerminationReason,
   type ResetRequest,
   type SetChargingProfileRequest,
   type SetChargingProfileResponse,
-  type StartTransactionRequest,
   type UnlockConnectorRequest,
   type UnlockConnectorResponse,
 } from '../../../types';
@@ -259,7 +258,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
       ],
       [
         OCPP16IncomingRequestCommand.CHANGE_AVAILABILITY,
-        OCPP16ServiceUtils.parseJsonSchemaFile<ChangeAvailabilityRequest>(
+        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16ChangeAvailabilityRequest>(
           'assets/json-schemas/ocpp/1.6/ChangeAvailability.json',
           moduleName,
           'constructor',
@@ -512,11 +511,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
       }
     } else if (isNotEmptyArray(commandPayload.key) === true) {
       for (const key of commandPayload.key!) {
-        const keyFound = ChargingStationConfigurationUtils.getConfigurationKey(
-          chargingStation,
-          key,
-          true,
-        );
+        const keyFound = getConfigurationKey(chargingStation, key, true);
         if (keyFound) {
           if (isUndefined(keyFound.visible) === true) {
             keyFound.visible = true;
@@ -544,22 +539,13 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     chargingStation: ChargingStation,
     commandPayload: ChangeConfigurationRequest,
   ): ChangeConfigurationResponse {
-    const keyToChange = ChargingStationConfigurationUtils.getConfigurationKey(
-      chargingStation,
-      commandPayload.key,
-      true,
-    );
+    const keyToChange = getConfigurationKey(chargingStation, commandPayload.key, true);
     if (keyToChange?.readonly === true) {
       return OCPP16Constants.OCPP_CONFIGURATION_RESPONSE_REJECTED;
     } else if (keyToChange?.readonly === false) {
       let valueChanged = false;
       if (keyToChange.value !== commandPayload.value) {
-        ChargingStationConfigurationUtils.setConfigurationKeyValue(
-          chargingStation,
-          commandPayload.key,
-          commandPayload.value,
-          true,
-        );
+        setConfigurationKeyValue(chargingStation, commandPayload.key, commandPayload.value, true);
         valueChanged = true;
       }
       let triggerHeartbeatRestart = false;
@@ -568,7 +554,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
           OCPP16StandardParametersKey.HeartBeatInterval &&
         valueChanged
       ) {
-        ChargingStationConfigurationUtils.setConfigurationKeyValue(
+        setConfigurationKeyValue(
           chargingStation,
           OCPP16StandardParametersKey.HeartbeatInterval,
           commandPayload.value,
@@ -580,7 +566,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
           OCPP16StandardParametersKey.HeartbeatInterval &&
         valueChanged
       ) {
-        ChargingStationConfigurationUtils.setConfigurationKeyValue(
+        setConfigurationKeyValue(
           chargingStation,
           OCPP16StandardParametersKey.HeartBeatInterval,
           commandPayload.value,
@@ -685,7 +671,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
       return OCPP16Constants.OCPP_RESPONSE_REJECTED;
     }
     const startDate = new Date();
-    const endDate = new Date(startDate.getTime() + commandPayload.duration * 1000);
+    const endDate = new Date(startDate.getTime() + secondsToMilliseconds(commandPayload.duration));
     let compositeSchedule: OCPP16ChargingSchedule | undefined;
     for (const chargingProfile of chargingStation.getConnectorStatus(commandPayload.connectorId)!
       .chargingProfiles!) {
@@ -742,53 +728,23 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     }
     if (isNullOrUndefined(commandPayload.connectorId)) {
       let clearedCP = false;
-      const clearChargingProfiles = (connectorStatus: ConnectorStatus) => {
-        if (isNotEmptyArray(connectorStatus?.chargingProfiles)) {
-          connectorStatus?.chargingProfiles?.forEach(
-            (chargingProfile: OCPP16ChargingProfile, index: number) => {
-              let clearCurrentCP = false;
-              if (chargingProfile.chargingProfileId === commandPayload.id) {
-                clearCurrentCP = true;
-              }
-              if (
-                !commandPayload.chargingProfilePurpose &&
-                chargingProfile.stackLevel === commandPayload.stackLevel
-              ) {
-                clearCurrentCP = true;
-              }
-              if (
-                !chargingProfile.stackLevel &&
-                chargingProfile.chargingProfilePurpose === commandPayload.chargingProfilePurpose
-              ) {
-                clearCurrentCP = true;
-              }
-              if (
-                chargingProfile.stackLevel === commandPayload.stackLevel &&
-                chargingProfile.chargingProfilePurpose === commandPayload.chargingProfilePurpose
-              ) {
-                clearCurrentCP = true;
-              }
-              if (clearCurrentCP) {
-                connectorStatus?.chargingProfiles?.splice(index, 1);
-                logger.debug(
-                  `${chargingStation.logPrefix()} Matching charging profile(s) cleared: %j`,
-                  chargingProfile,
-                );
-                clearedCP = true;
-              }
-            },
-          );
-        }
-      };
       if (chargingStation.hasEvses) {
         for (const evseStatus of chargingStation.evses.values()) {
           for (const connectorStatus of evseStatus.connectors.values()) {
-            clearChargingProfiles(connectorStatus);
+            clearedCP = OCPP16ServiceUtils.clearChargingProfiles(
+              chargingStation,
+              commandPayload,
+              connectorStatus.chargingProfiles,
+            );
           }
         }
       } else {
         for (const connectorId of chargingStation.connectors.keys()) {
-          clearChargingProfiles(chargingStation.getConnectorStatus(connectorId)!);
+          clearedCP = OCPP16ServiceUtils.clearChargingProfiles(
+            chargingStation,
+            commandPayload,
+            chargingStation.getConnectorStatus(connectorId)?.chargingProfiles,
+          );
         }
       }
       if (clearedCP) {
@@ -800,8 +756,8 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
 
   private async handleRequestChangeAvailability(
     chargingStation: ChargingStation,
-    commandPayload: ChangeAvailabilityRequest,
-  ): Promise<ChangeAvailabilityResponse> {
+    commandPayload: OCPP16ChangeAvailabilityRequest,
+  ): Promise<OCPP16ChangeAvailabilityResponse> {
     const connectorId: number = commandPayload.connectorId;
     if (chargingStation.hasConnector(connectorId) === false) {
       logger.error(
@@ -815,33 +771,29 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
         ? OCPP16ChargePointStatus.Available
         : OCPP16ChargePointStatus.Unavailable;
     if (connectorId === 0) {
-      let response: ChangeAvailabilityResponse =
-        OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED;
-      const changeAvailability = async (id: number, connectorStatus: ConnectorStatus) => {
-        if (connectorStatus?.transactionStarted === true) {
-          response = OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_SCHEDULED;
-        }
-        connectorStatus.availability = commandPayload.type;
-        if (response === OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_ACCEPTED) {
-          await OCPP16ServiceUtils.sendAndSetConnectorStatus(
-            chargingStation,
-            id,
-            chargePointStatus,
-          );
-        }
-      };
+      let response: OCPP16ChangeAvailabilityResponse;
       if (chargingStation.hasEvses) {
         for (const evseStatus of chargingStation.evses.values()) {
-          for (const [id, connectorStatus] of evseStatus.connectors) {
-            await changeAvailability(id, connectorStatus);
+          for (const id of evseStatus.connectors.keys()) {
+            response = await OCPP16ServiceUtils.changeAvailability(
+              chargingStation,
+              id,
+              chargePointStatus,
+              commandPayload.type,
+            );
           }
         }
       } else {
         for (const id of chargingStation.connectors.keys()) {
-          await changeAvailability(id, chargingStation.getConnectorStatus(id)!);
+          response = await OCPP16ServiceUtils.changeAvailability(
+            chargingStation,
+            id,
+            chargePointStatus,
+            commandPayload.type,
+          );
         }
       }
-      return response;
+      return response!;
     } else if (
       connectorId > 0 &&
       (chargingStation.isChargingStationAvailable() === true ||
@@ -868,18 +820,6 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     commandPayload: RemoteStartTransactionRequest,
   ): Promise<GenericResponse> {
     const { connectorId: transactionConnectorId, idTag, chargingProfile } = commandPayload;
-    const reserved =
-      chargingStation.getConnectorStatus(transactionConnectorId)!.status ===
-      OCPP16ChargePointStatus.Reserved;
-    const reservedOnConnectorZero =
-      chargingStation.getConnectorStatus(0)!.status === OCPP16ChargePointStatus.Reserved;
-    if (
-      (reserved &&
-        !chargingStation.validateIncomingRequestWithReservation(transactionConnectorId, idTag)) ||
-      (reservedOnConnectorZero && !chargingStation.validateIncomingRequestWithReservation(0, idTag))
-    ) {
-      return OCPP16Constants.OCPP_RESPONSE_REJECTED;
-    }
     if (chargingStation.hasConnector(transactionConnectorId) === false) {
       return this.notifyRemoteStartTransactionRejected(
         chargingStation,
@@ -897,6 +837,15 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
         idTag,
       );
     }
+    if (
+      (chargingStation.getConnectorStatus(transactionConnectorId)?.status ===
+        OCPP16ChargePointStatus.Reserved &&
+        chargingStation.getReservationBy('connectorId', transactionConnectorId)?.idTag !== idTag) ||
+      (chargingStation.getConnectorStatus(0)?.status === OCPP16ChargePointStatus.Reserved &&
+        chargingStation.getReservationBy('connectorId', 0)?.idTag !== idTag)
+    ) {
+      return OCPP16Constants.OCPP_RESPONSE_REJECTED;
+    }
     const remoteStartTransactionLogMsg = `
       ${chargingStation.logPrefix()} Transaction remotely STARTED on ${
         chargingStation.stationInfo.chargingStationId
@@ -907,9 +856,9 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
       OCPP16ChargePointStatus.Preparing,
     );
     const connectorStatus = chargingStation.getConnectorStatus(transactionConnectorId)!;
-    // Check if authorized
+    // Authorization check required
     if (
-      chargingStation.getAuthorizeRemoteTxRequests() &&
+      chargingStation.getAuthorizeRemoteTxRequests() === true &&
       (await OCPP16ServiceUtils.isIdTagAuthorized(chargingStation, transactionConnectorId, idTag))
     ) {
       // Authorization successful, start transaction
@@ -921,27 +870,21 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
         ) === true
       ) {
         connectorStatus.transactionRemoteStarted = true;
-        const startTransactionPayload: Partial<StartTransactionRequest> = {
-          connectorId: transactionConnectorId,
-          idTag,
-        };
-        if (reserved || reservedOnConnectorZero) {
-          const reservation = chargingStation.getReservationBy(
-            ReservationFilterKey.CONNECTOR_ID,
-            reservedOnConnectorZero ? 0 : transactionConnectorId,
-          )!;
-          startTransactionPayload.reservationId = reservation.id;
-          await chargingStation.removeReservation(
-            reservation,
-            ReservationTerminationReason.TRANSACTION_STARTED,
-          );
-        }
         if (
           (
             await chargingStation.ocppRequestService.requestHandler<
               OCPP16StartTransactionRequest,
               OCPP16StartTransactionResponse
-            >(chargingStation, OCPP16RequestCommand.START_TRANSACTION, startTransactionPayload)
+            >(chargingStation, OCPP16RequestCommand.START_TRANSACTION, {
+              connectorId: transactionConnectorId,
+              idTag,
+              reservationId: chargingStation.getReservationBy(
+                'connectorId',
+                chargingStation.getConnectorStatus(0)?.status === OCPP16ChargePointStatus.Reserved
+                  ? 0
+                  : transactionConnectorId,
+              )!,
+            })
           ).idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED
         ) {
           logger.debug(remoteStartTransactionLogMsg);
@@ -976,6 +919,12 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
           >(chargingStation, OCPP16RequestCommand.START_TRANSACTION, {
             connectorId: transactionConnectorId,
             idTag,
+            reservationId: chargingStation.getReservationBy(
+              'connectorId',
+              chargingStation.getConnectorStatus(0)?.status === OCPP16ChargePointStatus.Reserved
+                ? 0
+                : transactionConnectorId,
+            )!,
           })
         ).idTagInfo.status === OCPP16AuthorizationStatus.ACCEPTED
       ) {
@@ -1021,20 +970,26 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
   private setRemoteStartTransactionChargingProfile(
     chargingStation: ChargingStation,
     connectorId: number,
-    cp: OCPP16ChargingProfile,
+    chargingProfile: OCPP16ChargingProfile,
   ): boolean {
-    if (cp && cp.chargingProfilePurpose === OCPP16ChargingProfilePurposeType.TX_PROFILE) {
-      OCPP16ServiceUtils.setChargingProfile(chargingStation, connectorId, cp);
+    if (
+      chargingProfile &&
+      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`,
-        cp,
+        chargingProfile,
       );
       return true;
-    } else if (cp && cp.chargingProfilePurpose !== OCPP16ChargingProfilePurposeType.TX_PROFILE) {
+    } else if (
+      chargingProfile &&
+      chargingProfile.chargingProfilePurpose !== OCPP16ChargingProfilePurposeType.TX_PROFILE
+    ) {
       logger.warn(
         `${chargingStation.logPrefix()} Not allowed to set ${
-          cp.chargingProfilePurpose
+          chargingProfile.chargingProfilePurpose
         } charging profile(s) at remote start transaction`,
       );
       return false;
@@ -1047,27 +1002,12 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     commandPayload: RemoteStopTransactionRequest,
   ): Promise<GenericResponse> {
     const transactionId = commandPayload.transactionId;
-    const remoteStopTransaction = async (connectorId: number): Promise<GenericResponse> => {
-      await OCPP16ServiceUtils.sendAndSetConnectorStatus(
-        chargingStation,
-        connectorId,
-        OCPP16ChargePointStatus.Finishing,
-      );
-      const stopResponse = await chargingStation.stopTransactionOnConnector(
-        connectorId,
-        OCPP16StopTransactionReason.REMOTE,
-      );
-      if (stopResponse.idTagInfo?.status === OCPP16AuthorizationStatus.ACCEPTED) {
-        return OCPP16Constants.OCPP_RESPONSE_ACCEPTED;
-      }
-      return OCPP16Constants.OCPP_RESPONSE_REJECTED;
-    };
     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 remoteStopTransaction(connectorId);
+              return OCPP16ServiceUtils.remoteStopTransaction(chargingStation, connectorId);
             }
           }
         }
@@ -1078,7 +1018,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
           connectorId > 0 &&
           chargingStation.getConnectorStatus(connectorId)?.transactionId === transactionId
         ) {
-          return remoteStopTransaction(connectorId);
+          return OCPP16ServiceUtils.remoteStopTransaction(chargingStation, connectorId);
         }
       }
     }
@@ -1192,7 +1132,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
       chargingStation.stationInfo?.firmwareUpgrade?.failureStatus ===
       OCPP16FirmwareStatus.DownloadFailed
     ) {
-      await sleep(getRandomInteger(maxDelay, minDelay) * 1000);
+      await sleep(secondsToMilliseconds(getRandomInteger(maxDelay, minDelay)));
       await chargingStation.ocppRequestService.requestHandler<
         OCPP16FirmwareStatusNotificationRequest,
         OCPP16FirmwareStatusNotificationResponse
@@ -1203,7 +1143,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
         chargingStation.stationInfo?.firmwareUpgrade?.failureStatus;
       return;
     }
-    await sleep(getRandomInteger(maxDelay, minDelay) * 1000);
+    await sleep(secondsToMilliseconds(getRandomInteger(maxDelay, minDelay)));
     await chargingStation.ocppRequestService.requestHandler<
       OCPP16FirmwareStatusNotificationRequest,
       OCPP16FirmwareStatusNotificationResponse
@@ -1216,12 +1156,12 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     do {
       const runningTransactions = chargingStation.getNumberOfRunningTransactions();
       if (runningTransactions > 0) {
-        const waitTime = 15 * 1000;
+        const waitTime = secondsToMilliseconds(15);
         logger.debug(
           `${chargingStation.logPrefix()} ${moduleName}.updateFirmwareSimulation:
-            ${runningTransactions} transaction(s) in progress, waiting ${
-              waitTime / 1000
-            } seconds before continuing firmware update simulation`,
+            ${runningTransactions} transaction(s) in progress, waiting ${formatDurationMilliSeconds(
+              waitTime,
+            )} before continuing firmware update simulation`,
         );
         await sleep(waitTime);
         transactionsStarted = true;
@@ -1259,7 +1199,8 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
         transactionsStarted = false;
       }
     } while (transactionsStarted);
-    !wasTransactionsStarted && (await sleep(getRandomInteger(maxDelay, minDelay) * 1000));
+    !wasTransactionsStarted &&
+      (await sleep(secondsToMilliseconds(getRandomInteger(maxDelay, minDelay))));
     if (checkChargingStation(chargingStation, chargingStation.logPrefix()) === false) {
       return;
     }
@@ -1274,7 +1215,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
       chargingStation.stationInfo?.firmwareUpgrade?.failureStatus ===
       OCPP16FirmwareStatus.InstallationFailed
     ) {
-      await sleep(getRandomInteger(maxDelay, minDelay) * 1000);
+      await sleep(secondsToMilliseconds(getRandomInteger(maxDelay, minDelay)));
       await chargingStation.ocppRequestService.requestHandler<
         OCPP16FirmwareStatusNotificationRequest,
         OCPP16FirmwareStatusNotificationResponse
@@ -1286,7 +1227,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
       return;
     }
     if (chargingStation.stationInfo?.firmwareUpgrade?.reset === true) {
-      await sleep(getRandomInteger(maxDelay, minDelay) * 1000);
+      await sleep(secondsToMilliseconds(getRandomInteger(maxDelay, minDelay)));
       await chargingStation.reset(OCPP16StopTransactionReason.REBOOT);
     }
   }
@@ -1581,10 +1522,10 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     const { reservationId, idTag, connectorId } = commandPayload;
     let response: OCPP16ReserveNowResponse;
     try {
-      if (!chargingStation.isConnectorAvailable(connectorId) && connectorId > 0) {
+      if (connectorId > 0 && !chargingStation.isConnectorAvailable(connectorId)) {
         return OCPP16Constants.OCPP_RESERVATION_RESPONSE_REJECTED;
       }
-      if (connectorId === 0 && !chargingStation.getReservationOnConnectorId0Enabled()) {
+      if (connectorId === 0 && !chargingStation.getReserveConnectorZeroSupported()) {
         return OCPP16Constants.OCPP_RESERVATION_RESPONSE_REJECTED;
       }
       if (!(await OCPP16ServiceUtils.isIdTagAuthorized(chargingStation, connectorId, idTag))) {
@@ -1649,8 +1590,8 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     }
     try {
       const { reservationId } = commandPayload;
-      const [exists, reservation] = chargingStation.doesReservationExists({ id: reservationId });
-      if (!exists) {
+      const reservation = chargingStation.getReservationBy('reservationId', reservationId);
+      if (isUndefined(reservation)) {
         logger.error(
           `${chargingStation.logPrefix()} Reservation with ID ${reservationId}
             does not exist on charging station`,