Switch log messages to string literal

[e-mobility-charging-stations-simulator.git] / src / charging-station / ocpp / 1.6 / OCPP16IncomingRequestService.ts

diff --git a/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts b/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts
index b80a8f4bf65d10048d7fe39e4823e52efcb85ec4..6f77cde0f5afaf920cfbff7c9f72d75e878fb697 100644 (file)
--- a/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts
+++ b/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts
@@ -8,6 +8,7 @@ import type { JSONSchemaType } from 'ajv';
 import { Client, type FTPResponse } from 'basic-ftp';
 import tar from 'tar';
 
+import { OCPP16ServiceUtils } from './OCPP16ServiceUtils';
 import OCPPError from '../../../exception/OCPPError';
 import type { JsonObject, JsonType } from '../../../types/JsonType';
 import { OCPP16ChargePointErrorCode } from '../../../types/ocpp/1.6/ChargePointErrorCode';
@@ -87,7 +88,6 @@ import { ChargingStationConfigurationUtils } from '../../ChargingStationConfigur
 import { ChargingStationUtils } from '../../ChargingStationUtils';
 import OCPPConstants from '../OCPPConstants';
 import OCPPIncomingRequestService from '../OCPPIncomingRequestService';
-import { OCPP16ServiceUtils } from './OCPP16ServiceUtils';
 
 const moduleName = 'OCPP16IncomingRequestService';
 
@@ -337,7 +337,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
           ...args: any[]
         ) => Promise<void>,
         chargingStation,
-        (commandPayload.type + 'Reset') as OCPP16StopTransactionReason
+        `${commandPayload.type}Reset` as OCPP16StopTransactionReason
       )
       .catch(() => {
         /* This is intentional */
@@ -365,7 +365,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
     }
     if (connectorId === 0) {
       logger.error(
-        chargingStation.logPrefix() + ' Trying to unlock connector Id ' + connectorId.toString()
+        `${chargingStation.logPrefix()} Trying to unlock connector Id ${connectorId.toString()}`
       );
       return OCPPConstants.OCPP_RESPONSE_UNLOCK_NOT_SUPPORTED;
     }
@@ -544,8 +544,8 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
     logger.debug(
       `${chargingStation.logPrefix()} Charging profile(s) set on connector id ${
         commandPayload.connectorId
-      }, dump their stack: %j`,
-      chargingStation.getConnectorStatus(commandPayload.connectorId).chargingProfiles
+      }: %j`,
+      commandPayload.csChargingProfiles
     );
     return OCPPConstants.OCPP_SET_CHARGING_PROFILE_RESPONSE_ACCEPTED;
   }
@@ -577,8 +577,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
       logger.debug(
         `${chargingStation.logPrefix()} Charging profile(s) cleared on connector id ${
           commandPayload.connectorId
-        }, dump their stack: %j`,
-        connectorStatus.chargingProfiles
+        }`
       );
       return OCPPConstants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED;
     }
@@ -614,10 +613,8 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
               if (clearCurrentCP) {
                 connectorStatus.chargingProfiles.splice(index, 1);
                 logger.debug(
-                  `${chargingStation.logPrefix()} Matching charging profile(s) cleared on connector id ${
-                    commandPayload.connectorId
-                  }, dump their stack: %j`,
-                  connectorStatus.chargingProfiles
+                  `${chargingStation.logPrefix()} Matching charging profile(s) cleared: %j`,
+                  chargingProfile
                 );
                 clearedCP = true;
               }
@@ -697,15 +694,9 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
   ): Promise<GenericResponse> {
     const transactionConnectorId = commandPayload.connectorId;
     if (chargingStation.connectors.has(transactionConnectorId) === true) {
-      const remoteStartTransactionLogMsg =
-        chargingStation.logPrefix() +
-        ' Transaction remotely STARTED on ' +
-        chargingStation.stationInfo.chargingStationId +
-        '#' +
-        transactionConnectorId.toString() +
-        " for idTag '" +
-        commandPayload.idTag +
-        "'";
+      const remoteStartTransactionLogMsg = `${chargingStation.logPrefix()} Transaction remotely STARTED on ${
+        chargingStation.stationInfo.chargingStationId
+      }#${transactionConnectorId.toString()} for idTag '${commandPayload.idTag}'`;
       await chargingStation.ocppRequestService.requestHandler<
         OCPP16StatusNotificationRequest,
         OCPP16StatusNotificationResponse
@@ -858,16 +849,9 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
       chargingStation.getConnectorStatus(connectorId).status = OCPP16ChargePointStatus.AVAILABLE;
     }
     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 +
-        "'"
+      `${chargingStation.logPrefix()} Remote starting transaction REJECTED on connector Id ${connectorId.toString()}, idTag '${idTag}', availability '${
+        chargingStation.getConnectorStatus(connectorId).availability
+      }', status '${chargingStation.getConnectorStatus(connectorId).status}'`
     );
     return OCPPConstants.OCPP_RESPONSE_REJECTED;
   }
@@ -880,8 +864,8 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
     if (cp && cp.chargingProfilePurpose === ChargingProfilePurposeType.TX_PROFILE) {
       OCPP16ServiceUtils.setChargingProfile(chargingStation, connectorId, cp);
       logger.debug(
-        `${chargingStation.logPrefix()} Charging profile(s) set at remote start transaction on connector id ${connectorId}, dump their stack: %j`,
-        chargingStation.getConnectorStatus(connectorId).chargingProfiles
+        `${chargingStation.logPrefix()} Charging profile(s) set at remote start transaction on connector id ${connectorId}: %j`,
+        cp
       );
       return true;
     } else if (cp && cp.chargingProfilePurpose !== ChargingProfilePurposeType.TX_PROFILE) {
@@ -926,9 +910,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
       }
     }
     logger.warn(
-      chargingStation.logPrefix() +
-        ' Trying to remote stop a non existing transaction ' +
-        transactionId.toString()
+      `${chargingStation.logPrefix()} Trying to remote stop a non existing transaction ${transactionId.toString()}`
     );
     return OCPPConstants.OCPP_RESPONSE_REJECTED;
   }
@@ -945,7 +927,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
       ) === false
     ) {
       logger.warn(
-        `${chargingStation.logPrefix()} Cannot simulate firmware update: feature profile not supported`
+        `${chargingStation.logPrefix()} ${moduleName}.handleRequestUpdateFirmware: Cannot simulate firmware update: feature profile not supported`
       );
       return OCPPConstants.OCPP_RESPONSE_EMPTY;
     }
@@ -954,12 +936,13 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
       chargingStation.stationInfo.firmwareStatus !== OCPP16FirmwareStatus.Installed
     ) {
       logger.warn(
-        `${chargingStation.logPrefix()} Cannot simulate firmware update: firmware update is already in progress`
+        `${chargingStation.logPrefix()} ${moduleName}.handleRequestUpdateFirmware: Cannot simulate firmware update: firmware update is already in progress`
       );
       return OCPPConstants.OCPP_RESPONSE_EMPTY;
     }
     const retrieveDate = Utils.convertToDate(commandPayload.retrieveDate);
-    if (retrieveDate.getTime() <= Date.now()) {
+    const now = Date.now();
+    if (retrieveDate.getTime() <= now) {
       this.asyncResource
         .runInAsyncScope(
           this.updateFirmware.bind(this) as (
@@ -977,15 +960,15 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
         this.updateFirmware(chargingStation).catch(() => {
           /* Intentional */
         });
-      }, retrieveDate.getTime() - Date.now());
+      }, retrieveDate.getTime() - now);
     }
     return OCPPConstants.OCPP_RESPONSE_EMPTY;
   }
 
   private async updateFirmware(
     chargingStation: ChargingStation,
-    minDelay = 15,
-    maxDelay = 30
+    maxDelay = 30,
+    minDelay = 15
   ): Promise<void> {
     chargingStation.stopAutomaticTransactionGenerator();
     for (const connectorId of chargingStation.connectors.keys()) {
@@ -1006,14 +989,14 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
       }
     }
     if (
-      chargingStation.getFirmwareUpgrade()?.failureStatus &&
-      !Utils.isEmptyString(chargingStation.getFirmwareUpgrade().failureStatus)
+      chargingStation.stationInfo?.firmwareUpgrade?.failureStatus &&
+      !Utils.isEmptyString(chargingStation.stationInfo?.firmwareUpgrade?.failureStatus)
     ) {
       await chargingStation.ocppRequestService.requestHandler<
         OCPP16FirmwareStatusNotificationRequest,
         OCPP16FirmwareStatusNotificationResponse
       >(chargingStation, OCPP16RequestCommand.FIRMWARE_STATUS_NOTIFICATION, {
-        status: chargingStation.getFirmwareUpgrade().failureStatus,
+        status: chargingStation.stationInfo?.firmwareUpgrade?.failureStatus,
       });
       return;
     }
@@ -1024,7 +1007,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
       status: OCPP16FirmwareStatus.Downloading,
     });
     chargingStation.stationInfo.firmwareStatus = OCPP16FirmwareStatus.Downloading;
-    await Utils.sleep(Utils.getRandomInteger(minDelay, maxDelay) * 1000);
+    await Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000);
     await chargingStation.ocppRequestService.requestHandler<
       OCPP16FirmwareStatusNotificationRequest,
       OCPP16FirmwareStatusNotificationResponse
@@ -1032,7 +1015,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
       status: OCPP16FirmwareStatus.Downloaded,
     });
     chargingStation.stationInfo.firmwareStatus = OCPP16FirmwareStatus.Downloaded;
-    await Utils.sleep(Utils.getRandomInteger(minDelay, maxDelay) * 1000);
+    await Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000);
     await chargingStation.ocppRequestService.requestHandler<
       OCPP16FirmwareStatusNotificationRequest,
       OCPP16FirmwareStatusNotificationResponse
@@ -1040,8 +1023,8 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
       status: OCPP16FirmwareStatus.Installing,
     });
     chargingStation.stationInfo.firmwareStatus = OCPP16FirmwareStatus.Installing;
-    if (chargingStation.getFirmwareUpgrade().reset === true) {
-      await Utils.sleep(Utils.getRandomInteger(minDelay, maxDelay) * 1000);
+    if (chargingStation.stationInfo?.firmwareUpgrade?.reset === true) {
+      await Utils.sleep(Utils.getRandomInteger(maxDelay, minDelay) * 1000);
       await chargingStation.reset(OCPP16StopTransactionReason.REBOOT);
     }
   }
@@ -1057,6 +1040,9 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
         OCPP16IncomingRequestCommand.GET_DIAGNOSTICS
       ) === false
     ) {
+      logger.warn(
+        `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: Cannot get diagnostics: feature profile not supported`
+      );
       return OCPPConstants.OCPP_RESPONSE_EMPTY;
     }
     const uri = new URL(commandPayload.location);
@@ -1067,7 +1053,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
           .readdirSync(path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../../../'))
           .filter((file) => file.endsWith('.log'))
           .map((file) => path.join('./', file));
-        const diagnosticsArchive = chargingStation.stationInfo.chargingStationId + '_logs.tar.gz';
+        const diagnosticsArchive = `${chargingStation.stationInfo.chargingStationId}_logs.tar.gz`;
         tar.create({ gzip: true }, logFiles).pipe(fs.createWriteStream(diagnosticsArchive));
         ftpClient = new Client();
         const accessResponse = await ftpClient.access({
@@ -1078,19 +1064,27 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
         });
         let uploadResponse: FTPResponse;
         if (accessResponse.code === 220) {
-          // eslint-disable-next-line @typescript-eslint/no-misused-promises
-          ftpClient.trackProgress(async (info) => {
+          ftpClient.trackProgress((info) => {
             logger.info(
               `${chargingStation.logPrefix()} ${
                 info.bytes / 1024
               } bytes transferred from diagnostics archive ${info.name}`
             );
-            await chargingStation.ocppRequestService.requestHandler<
-              OCPP16DiagnosticsStatusNotificationRequest,
-              OCPP16DiagnosticsStatusNotificationResponse
-            >(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, {
-              status: OCPP16DiagnosticsStatus.Uploading,
-            });
+            chargingStation.ocppRequestService
+              .requestHandler<
+                OCPP16DiagnosticsStatusNotificationRequest,
+                OCPP16DiagnosticsStatusNotificationResponse
+              >(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, {
+                status: OCPP16DiagnosticsStatus.Uploading,
+              })
+              .catch((error) => {
+                logger.error(
+                  `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: Error while sending '${
+                    OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION
+                  }'`,
+                  error
+                );
+              });
           });
           uploadResponse = await ftpClient.uploadFrom(
             path.join(
@@ -1114,7 +1108,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
           throw new OCPPError(
             ErrorType.GENERIC_ERROR,
             `Diagnostics transfer failed with error code ${accessResponse.code.toString()}${
-              uploadResponse?.code && '|' + uploadResponse?.code.toString()
+              uploadResponse?.code && `|${uploadResponse?.code.toString()}`
             }`,
             OCPP16IncomingRequestCommand.GET_DIAGNOSTICS
           );
@@ -1122,7 +1116,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
         throw new OCPPError(
           ErrorType.GENERIC_ERROR,
           `Diagnostics transfer failed with error code ${accessResponse.code.toString()}${
-            uploadResponse?.code && '|' + uploadResponse?.code.toString()
+            uploadResponse?.code && `|${uploadResponse?.code.toString()}`
           }`,
           OCPP16IncomingRequestCommand.GET_DIAGNOSTICS
         );