refactor: cleanup incoming OCPP requests handling code
[e-mobility-charging-stations-simulator.git] / src / charging-station / ocpp / 1.6 / OCPP16IncomingRequestService.ts
index 81f7540f74cf382c07482347a23adfead9a117a6..dd40ffafd0d89c107fdd3bf3718d4a2615262896 100644 (file)
@@ -6,15 +6,18 @@ import { URL, fileURLToPath } from 'node:url';
 
 import type { JSONSchemaType } from 'ajv';
 import { Client, type FTPResponse } from 'basic-ftp';
-import { addSeconds, isWithinInterval, max, secondsToMilliseconds } from 'date-fns';
+import { addSeconds, differenceInSeconds, isDate, maxTime, secondsToMilliseconds } from 'date-fns';
 import { create } from 'tar';
 
 import { OCPP16Constants } from './OCPP16Constants';
 import { OCPP16ServiceUtils } from './OCPP16ServiceUtils';
 import {
   type ChargingStation,
+  canProceedChargingProfile,
   checkChargingStation,
   getConfigurationKey,
+  getConnectorChargingProfiles,
+  prepareChargingProfileKind,
   removeExpiredReservations,
   setConfigurationKeyValue,
 } from '../../../charging-station';
@@ -461,14 +464,12 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     if (chargingStation.hasConnector(connectorId) === false) {
       logger.error(
         `${chargingStation.logPrefix()} Trying to unlock a non existing
-          connector id ${connectorId.toString()}`,
+          connector id ${connectorId}`,
       );
       return OCPP16Constants.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED;
     }
     if (connectorId === 0) {
-      logger.error(
-        `${chargingStation.logPrefix()} Trying to unlock connector id ${connectorId.toString()}`,
-      );
+      logger.error(`${chargingStation.logPrefix()} Trying to unlock connector id ${connectorId}`);
       return OCPP16Constants.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED;
     }
     if (chargingStation.getConnectorStatus(connectorId)?.transactionStarted === true) {
@@ -623,8 +624,19 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     }
     if (
       csChargingProfiles.chargingProfilePurpose === OCPP16ChargingProfilePurposeType.TX_PROFILE &&
-      (connectorId === 0 ||
-        chargingStation.getConnectorStatus(connectorId)?.transactionStarted === false)
+      connectorId === 0
+    ) {
+      logger.error(
+        `${chargingStation.logPrefix()} Trying to set transaction charging profile(s)
+          on connector ${connectorId}`,
+      );
+      return OCPP16Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
+    }
+    const connectorStatus = chargingStation.getConnectorStatus(connectorId);
+    if (
+      csChargingProfiles.chargingProfilePurpose === OCPP16ChargingProfilePurposeType.TX_PROFILE &&
+      connectorId > 0 &&
+      connectorStatus?.transactionStarted === false
     ) {
       logger.error(
         `${chargingStation.logPrefix()} Trying to set transaction charging profile(s)
@@ -632,6 +644,20 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
       );
       return OCPP16Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
     }
+    if (
+      csChargingProfiles.chargingProfilePurpose === OCPP16ChargingProfilePurposeType.TX_PROFILE &&
+      connectorId > 0 &&
+      connectorStatus?.transactionStarted === true &&
+      csChargingProfiles.transactionId !== connectorStatus?.transactionId
+    ) {
+      logger.error(
+        `${chargingStation.logPrefix()} Trying to set transaction charging profile(s)
+          on connector ${connectorId} with a different transaction id ${
+            csChargingProfiles.transactionId
+          } than the started transaction id ${connectorStatus?.transactionId}`,
+      );
+      return OCPP16Constants.OCPP_SET_CHARGING_PROFILE_RESPONSE_REJECTED;
+    }
     OCPP16ServiceUtils.setChargingProfile(chargingStation, connectorId, csChargingProfiles);
     logger.debug(
       `${chargingStation.logPrefix()} Charging profile(s) set on connector id ${connectorId}: %j`,
@@ -668,75 +694,107 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
       return OCPP16Constants.OCPP_RESPONSE_REJECTED;
     }
     if (chargingRateUnit) {
-      logger.error(
-        `${chargingStation.logPrefix()} Get composite schedule with a specified rate unit is not yet supported`,
+      logger.warn(
+        `${chargingStation.logPrefix()} Get composite schedule with a specified rate unit is not yet supported, no conversion will be done`,
       );
-      return OCPP16Constants.OCPP_RESPONSE_REJECTED;
     }
-    if (isEmptyArray(chargingStation.getConnectorStatus(connectorId)?.chargingProfiles)) {
+    const connectorStatus = chargingStation.getConnectorStatus(connectorId)!;
+    if (
+      isEmptyArray(
+        connectorStatus?.chargingProfiles &&
+          isEmptyArray(chargingStation.getConnectorStatus(0)?.chargingProfiles),
+      )
+    ) {
       return OCPP16Constants.OCPP_RESPONSE_REJECTED;
     }
-    const startDate = new Date();
-    const interval: Interval = {
-      start: startDate,
-      end: addSeconds(startDate, duration),
+    const currentDate = new Date();
+    const compositeScheduleInterval: Interval = {
+      start: currentDate,
+      end: addSeconds(currentDate, duration),
     };
+    // Get charging profiles sorted by connector id then stack level
+    const chargingProfiles: OCPP16ChargingProfile[] = getConnectorChargingProfiles(
+      chargingStation,
+      connectorId,
+    );
+    let previousCompositeSchedule: OCPP16ChargingSchedule | undefined;
     let compositeSchedule: OCPP16ChargingSchedule | undefined;
-    for (const chargingProfile of chargingStation.getConnectorStatus(connectorId)!
-      .chargingProfiles!) {
+    for (const chargingProfile of chargingProfiles) {
       if (
-        compositeSchedule?.chargingRateUnit &&
-        compositeSchedule.chargingRateUnit !== chargingProfile.chargingSchedule.chargingRateUnit
+        isNullOrUndefined(chargingProfile.chargingSchedule?.startSchedule) &&
+        connectorStatus?.transactionStarted
       ) {
-        logger.error(
-          `${chargingStation.logPrefix()} Building composite schedule with different charging rate units is not yet supported, skipping charging profile id ${
+        logger.debug(
+          `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetCompositeSchedule: Charging profile id ${
             chargingProfile.chargingProfileId
-          }`,
+          } has no startSchedule defined. Trying to set it to the connector current transaction start date`,
+        );
+        // OCPP specifies that if startSchedule is not defined, it should be relative to start of the connector transaction
+        chargingProfile.chargingSchedule.startSchedule = connectorStatus?.transactionStart;
+      }
+      if (
+        !isNullOrUndefined(chargingProfile.chargingSchedule?.startSchedule) &&
+        !isDate(chargingProfile.chargingSchedule?.startSchedule)
+      ) {
+        logger.warn(
+          `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetCompositeSchedule: Charging profile id ${
+            chargingProfile.chargingProfileId
+          } startSchedule property is not a Date instance. Trying to convert it to a Date instance`,
+        );
+        chargingProfile.chargingSchedule.startSchedule = convertToDate(
+          chargingProfile.chargingSchedule?.startSchedule,
+        )!;
+      }
+      if (
+        !isNullOrUndefined(chargingProfile.chargingSchedule?.startSchedule) &&
+        isNullOrUndefined(chargingProfile.chargingSchedule?.duration)
+      ) {
+        logger.debug(
+          `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetCompositeSchedule: Charging profile id ${
+            chargingProfile.chargingProfileId
+          } has no duration defined and will be set to the maximum time allowed`,
+        );
+        // OCPP specifies that if duration is not defined, it should be infinite
+        chargingProfile.chargingSchedule.duration = differenceInSeconds(
+          maxTime,
+          chargingProfile.chargingSchedule.startSchedule!,
         );
+      }
+      if (
+        !prepareChargingProfileKind(
+          connectorStatus,
+          chargingProfile,
+          compositeScheduleInterval.start as Date,
+          chargingStation.logPrefix(),
+        )
+      ) {
         continue;
       }
       if (
-        isWithinInterval(chargingProfile.chargingSchedule.startSchedule!, interval) &&
-        isWithinInterval(
-          addSeconds(
-            chargingProfile.chargingSchedule.startSchedule!,
-            chargingProfile.chargingSchedule.duration!,
-          ),
-          interval,
+        !canProceedChargingProfile(
+          chargingProfile,
+          compositeScheduleInterval.start as Date,
+          chargingStation.logPrefix(),
         )
       ) {
-        compositeSchedule = {
-          startSchedule: max([
-            compositeSchedule?.startSchedule ?? interval.start,
-            chargingProfile.chargingSchedule.startSchedule!,
-          ]),
-          duration: Math.max(
-            compositeSchedule?.duration ?? -Infinity,
-            chargingProfile.chargingSchedule.duration!,
-          ),
-          chargingRateUnit: chargingProfile.chargingSchedule.chargingRateUnit,
-          ...(compositeSchedule?.chargingSchedulePeriod === undefined
-            ? { chargingSchedulePeriod: [] }
-            : {
-                chargingSchedulePeriod: compositeSchedule.chargingSchedulePeriod.concat(
-                  ...chargingProfile.chargingSchedule.chargingSchedulePeriod,
-                ),
-              }),
-          ...(chargingProfile.chargingSchedule.minChargeRate && {
-            minChargeRate: Math.min(
-              compositeSchedule?.minChargeRate ?? Infinity,
-              chargingProfile.chargingSchedule.minChargeRate,
-            ),
-          }),
-        };
+        continue;
       }
+      compositeSchedule = OCPP16ServiceUtils.composeChargingSchedules(
+        previousCompositeSchedule,
+        chargingProfile.chargingSchedule,
+        compositeScheduleInterval,
+      );
+      previousCompositeSchedule = compositeSchedule;
     }
-    return {
-      status: GenericStatus.Accepted,
-      scheduleStart: compositeSchedule?.startSchedule,
-      connectorId,
-      chargingSchedule: compositeSchedule,
-    };
+    if (compositeSchedule) {
+      return {
+        status: GenericStatus.Accepted,
+        scheduleStart: compositeSchedule.startSchedule!,
+        connectorId,
+        chargingSchedule: compositeSchedule,
+      };
+    }
+    return OCPP16Constants.OCPP_RESPONSE_REJECTED;
   }
 
   private handleRequestClearChargingProfile(
@@ -760,11 +818,9 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
       );
       return OCPP16Constants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN;
     }
-    if (
-      !isNullOrUndefined(connectorId) &&
-      isNotEmptyArray(chargingStation.getConnectorStatus(connectorId!)?.chargingProfiles)
-    ) {
-      chargingStation.getConnectorStatus(connectorId!)!.chargingProfiles = [];
+    const connectorStatus = chargingStation.getConnectorStatus(connectorId!);
+    if (!isNullOrUndefined(connectorId) && isNotEmptyArray(connectorStatus?.chargingProfiles)) {
+      connectorStatus!.chargingProfiles = [];
       logger.debug(
         `${chargingStation.logPrefix()} Charging profile(s) cleared on connector id ${connectorId}`,
       );
@@ -774,11 +830,11 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
       let clearedCP = false;
       if (chargingStation.hasEvses) {
         for (const evseStatus of chargingStation.evses.values()) {
-          for (const connectorStatus of evseStatus.connectors.values()) {
+          for (const status of evseStatus.connectors.values()) {
             clearedCP = OCPP16ServiceUtils.clearChargingProfiles(
               chargingStation,
               commandPayload,
-              connectorStatus.chargingProfiles,
+              status.chargingProfiles,
             );
           }
         }
@@ -806,7 +862,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     if (chargingStation.hasConnector(connectorId) === false) {
       logger.error(
         `${chargingStation.logPrefix()} Trying to change the availability of a
-          non existing connector id ${connectorId.toString()}`,
+          non existing connector id ${connectorId}`,
       );
       return OCPP16Constants.OCPP_AVAILABILITY_RESPONSE_REJECTED;
     }
@@ -880,7 +936,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     const remoteStartTransactionLogMsg = `
       ${chargingStation.logPrefix()} Transaction remotely STARTED on ${
         chargingStation.stationInfo.chargingStationId
-      }#${transactionConnectorId.toString()} for idTag '${idTag}'`;
+      }#${transactionConnectorId} for idTag '${idTag}'`;
     await OCPP16ServiceUtils.sendAndSetConnectorStatus(
       chargingStation,
       transactionConnectorId,
@@ -968,9 +1024,8 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     connectorId: number,
     idTag: string,
   ): Promise<GenericResponse> {
-    if (
-      chargingStation.getConnectorStatus(connectorId)?.status !== OCPP16ChargePointStatus.Available
-    ) {
+    const connectorStatus = chargingStation.getConnectorStatus(connectorId);
+    if (connectorStatus?.status !== OCPP16ChargePointStatus.Available) {
       await OCPP16ServiceUtils.sendAndSetConnectorStatus(
         chargingStation,
         connectorId,
@@ -979,9 +1034,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     }
     logger.warn(
       `${chargingStation.logPrefix()} Remote starting transaction REJECTED on connector id
-        ${connectorId.toString()}, idTag '${idTag}', availability '${chargingStation.getConnectorStatus(
-          connectorId,
-        )?.availability}', status '${chargingStation.getConnectorStatus(connectorId)?.status}'`,
+        ${connectorId}, idTag '${idTag}', availability '${connectorStatus?.availability}', status '${connectorStatus?.status}'`,
     );
     return OCPP16Constants.OCPP_RESPONSE_REJECTED;
   }
@@ -991,10 +1044,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     connectorId: number,
     chargingProfile: OCPP16ChargingProfile,
   ): boolean {
-    if (
-      chargingProfile &&
-      chargingProfile.chargingProfilePurpose === OCPP16ChargingProfilePurposeType.TX_PROFILE
-    ) {
+    if (chargingProfile?.chargingProfilePurpose === OCPP16ChargingProfilePurposeType.TX_PROFILE) {
       OCPP16ServiceUtils.setChargingProfile(chargingStation, connectorId, chargingProfile);
       logger.debug(
         `${chargingStation.logPrefix()} Charging profile(s) set at remote start transaction
@@ -1002,18 +1052,13 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
         chargingProfile,
       );
       return true;
-    } else if (
-      chargingProfile &&
-      chargingProfile.chargingProfilePurpose !== OCPP16ChargingProfilePurposeType.TX_PROFILE
-    ) {
-      logger.warn(
-        `${chargingStation.logPrefix()} Not allowed to set ${
-          chargingProfile.chargingProfilePurpose
-        } charging profile(s) at remote start transaction`,
-      );
-      return false;
     }
-    return true;
+    logger.warn(
+      `${chargingStation.logPrefix()} Not allowed to set ${
+        chargingProfile.chargingProfilePurpose
+      } charging profile(s) at remote start transaction`,
+    );
+    return false;
   }
 
   private async handleRequestRemoteStopTransaction(
@@ -1043,7 +1088,7 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
     }
     logger.warn(
       `${chargingStation.logPrefix()} Trying to remote stop a non existing transaction with id
-        ${transactionId.toString()}`,
+        ${transactionId}`,
     );
     return OCPP16Constants.OCPP_RESPONSE_REJECTED;
   }
@@ -1327,16 +1372,16 @@ export class OCPP16IncomingRequestService extends OCPPIncomingRequestService {
           }
           throw new OCPPError(
             ErrorType.GENERIC_ERROR,
-            `Diagnostics transfer failed with error code ${accessResponse.code.toString()}${
-              uploadResponse?.code && `|${uploadResponse?.code.toString()}`
+            `Diagnostics transfer failed with error code ${accessResponse.code}${
+              uploadResponse?.code && `|${uploadResponse?.code}`
             }`,
             OCPP16IncomingRequestCommand.GET_DIAGNOSTICS,
           );
         }
         throw new OCPPError(
           ErrorType.GENERIC_ERROR,
-          `Diagnostics transfer failed with error code ${accessResponse.code.toString()}${
-            uploadResponse?.code && `|${uploadResponse?.code.toString()}`
+          `Diagnostics transfer failed with error code ${accessResponse.code}${
+            uploadResponse?.code && `|${uploadResponse?.code}`
           }`,
           OCPP16IncomingRequestCommand.GET_DIAGNOSTICS,
         );