Factor out JSON schemas parsing with per OCPP stack version

[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 4deabe4f0a099157b1ea7b77020547b8f350a007..6e31a43b80095f9900fce1695ae57b2d16761265 100644 (file)
--- a/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts
+++ b/src/charging-station/ocpp/1.6/OCPP16IncomingRequestService.ts
@@ -1,8 +1,8 @@
 // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
 
-import fs from 'fs';
-import path from 'path';
-import { URL, fileURLToPath } from 'url';
+import fs from 'node:fs';
+import path from 'node:path';
+import { URL, fileURLToPath } from 'node:url';
 
 import type { JSONSchemaType } from 'ajv';
 import { Client, type FTPResponse } from 'basic-ftp';
@@ -140,83 +140,85 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
     this.jsonSchemas = new Map<OCPP16IncomingRequestCommand, JSONSchemaType<JsonObject>>([
       [
         OCPP16IncomingRequestCommand.RESET,
-        this.parseJsonSchemaFile<ResetRequest>('../../../assets/json-schemas/ocpp/1.6/Reset.json'),
+        OCPP16ServiceUtils.parseJsonSchemaFile<ResetRequest>(
+          '../../../assets/json-schemas/ocpp/1.6/Reset.json'
+        ),
       ],
       [
         OCPP16IncomingRequestCommand.CLEAR_CACHE,
-        this.parseJsonSchemaFile<OCPP16ClearCacheRequest>(
+        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16ClearCacheRequest>(
           '../../../assets/json-schemas/ocpp/1.6/ClearCache.json'
         ),
       ],
       [
         OCPP16IncomingRequestCommand.UNLOCK_CONNECTOR,
-        this.parseJsonSchemaFile<UnlockConnectorRequest>(
+        OCPP16ServiceUtils.parseJsonSchemaFile<UnlockConnectorRequest>(
           '../../../assets/json-schemas/ocpp/1.6/UnlockConnector.json'
         ),
       ],
       [
         OCPP16IncomingRequestCommand.GET_CONFIGURATION,
-        this.parseJsonSchemaFile<GetConfigurationRequest>(
+        OCPP16ServiceUtils.parseJsonSchemaFile<GetConfigurationRequest>(
           '../../../assets/json-schemas/ocpp/1.6/GetConfiguration.json'
         ),
       ],
       [
         OCPP16IncomingRequestCommand.CHANGE_CONFIGURATION,
-        this.parseJsonSchemaFile<ChangeConfigurationRequest>(
+        OCPP16ServiceUtils.parseJsonSchemaFile<ChangeConfigurationRequest>(
           '../../../assets/json-schemas/ocpp/1.6/ChangeConfiguration.json'
         ),
       ],
       [
         OCPP16IncomingRequestCommand.GET_DIAGNOSTICS,
-        this.parseJsonSchemaFile<GetDiagnosticsRequest>(
+        OCPP16ServiceUtils.parseJsonSchemaFile<GetDiagnosticsRequest>(
           '../../../assets/json-schemas/ocpp/1.6/GetDiagnostics.json'
         ),
       ],
       [
         OCPP16IncomingRequestCommand.SET_CHARGING_PROFILE,
-        this.parseJsonSchemaFile<SetChargingProfileRequest>(
+        OCPP16ServiceUtils.parseJsonSchemaFile<SetChargingProfileRequest>(
           '../../../assets/json-schemas/ocpp/1.6/SetChargingProfile.json'
         ),
       ],
       [
         OCPP16IncomingRequestCommand.CLEAR_CHARGING_PROFILE,
-        this.parseJsonSchemaFile<ClearChargingProfileRequest>(
+        OCPP16ServiceUtils.parseJsonSchemaFile<ClearChargingProfileRequest>(
           '../../../assets/json-schemas/ocpp/1.6/ClearChargingProfile.json'
         ),
       ],
       [
         OCPP16IncomingRequestCommand.CHANGE_AVAILABILITY,
-        this.parseJsonSchemaFile<ChangeAvailabilityRequest>(
+        OCPP16ServiceUtils.parseJsonSchemaFile<ChangeAvailabilityRequest>(
           '../../../assets/json-schemas/ocpp/1.6/ChangeAvailability.json'
         ),
       ],
       [
         OCPP16IncomingRequestCommand.REMOTE_START_TRANSACTION,
-        this.parseJsonSchemaFile<RemoteStartTransactionRequest>(
+        OCPP16ServiceUtils.parseJsonSchemaFile<RemoteStartTransactionRequest>(
           '../../../assets/json-schemas/ocpp/1.6/RemoteStartTransaction.json'
         ),
       ],
       [
         OCPP16IncomingRequestCommand.REMOTE_STOP_TRANSACTION,
-        this.parseJsonSchemaFile<RemoteStopTransactionRequest>(
+        OCPP16ServiceUtils.parseJsonSchemaFile<RemoteStopTransactionRequest>(
           '../../../assets/json-schemas/ocpp/1.6/RemoteStopTransaction.json'
         ),
       ],
       [
         OCPP16IncomingRequestCommand.TRIGGER_MESSAGE,
-        this.parseJsonSchemaFile<OCPP16TriggerMessageRequest>(
+        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16TriggerMessageRequest>(
           '../../../assets/json-schemas/ocpp/1.6/TriggerMessage.json'
         ),
       ],
       [
         OCPP16IncomingRequestCommand.DATA_TRANSFER,
-        this.parseJsonSchemaFile<OCPP16DataTransferRequest>(
+        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16DataTransferRequest>(
           '../../../assets/json-schemas/ocpp/1.6/DataTransfer.json'
         ),
       ],
       [
         OCPP16IncomingRequestCommand.UPDATE_FIRMWARE,
-        this.parseJsonSchemaFile<OCPP16UpdateFirmwareRequest>(
+        OCPP16ServiceUtils.parseJsonSchemaFile<OCPP16UpdateFirmwareRequest>(
           '../../../assets/json-schemas/ocpp/1.6/UpdateFirmware.json'
         ),
       ],
@@ -572,7 +574,10 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
       return OCPPConstants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_UNKNOWN;
     }
     const connectorStatus = chargingStation.getConnectorStatus(commandPayload.connectorId);
-    if (commandPayload.connectorId && !Utils.isEmptyArray(connectorStatus.chargingProfiles)) {
+    if (
+      !Utils.isNullOrUndefined(commandPayload.connectorId) &&
+      !Utils.isEmptyArray(connectorStatus?.chargingProfiles)
+    ) {
       connectorStatus.chargingProfiles = [];
       logger.debug(
         `${chargingStation.logPrefix()} Charging profile(s) cleared on connector id ${
@@ -581,13 +586,15 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
       );
       return OCPPConstants.OCPP_CLEAR_CHARGING_PROFILE_RESPONSE_ACCEPTED;
     }
-    if (!commandPayload.connectorId) {
+    if (Utils.isNullOrUndefined(commandPayload.connectorId)) {
       let clearedCP = false;
       for (const connectorId of chargingStation.connectors.keys()) {
-        if (!Utils.isEmptyArray(chargingStation.getConnectorStatus(connectorId).chargingProfiles)) {
+        if (
+          !Utils.isEmptyArray(chargingStation.getConnectorStatus(connectorId)?.chargingProfiles)
+        ) {
           chargingStation
             .getConnectorStatus(connectorId)
-            .chargingProfiles?.forEach((chargingProfile: OCPP16ChargingProfile, index: number) => {
+            ?.chargingProfiles?.forEach((chargingProfile: OCPP16ChargingProfile, index: number) => {
               let clearCurrentCP = false;
               if (chargingProfile.chargingProfileId === commandPayload.id) {
                 clearCurrentCP = true;
@@ -611,7 +618,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
                 clearCurrentCP = true;
               }
               if (clearCurrentCP) {
-                connectorStatus.chargingProfiles.splice(index, 1);
+                connectorStatus?.chargingProfiles?.splice(index, 1);
                 logger.debug(
                   `${chargingStation.logPrefix()} Matching charging profile(s) cleared: %j`,
                   chargingProfile
@@ -714,11 +721,13 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
           if (
             chargingStation.getLocalAuthListEnabled() === true &&
             chargingStation.hasAuthorizedTags() === true &&
-            chargingStation.authorizedTagsCache
-              .getAuthorizedTags(
-                ChargingStationUtils.getAuthorizationFile(chargingStation.stationInfo)
-              )
-              .find(idTag => idTag === commandPayload.idTag)
+            !Utils.isEmptyString(
+              chargingStation.authorizedTagsCache
+                .getAuthorizedTags(
+                  ChargingStationUtils.getAuthorizationFile(chargingStation.stationInfo)
+                )
+                ?.find((idTag) => idTag === commandPayload.idTag)
+            )
           ) {
             connectorStatus.localAuthorizeIdTag = commandPayload.idTag;
             connectorStatus.idTagLocalAuthorized = true;
@@ -836,7 +845,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
     idTag: string
   ): Promise<GenericResponse> {
     if (
-      chargingStation.getConnectorStatus(connectorId).status !== OCPP16ChargePointStatus.AVAILABLE
+      chargingStation.getConnectorStatus(connectorId)?.status !== OCPP16ChargePointStatus.AVAILABLE
     ) {
       await chargingStation.ocppRequestService.requestHandler<
         OCPP16StatusNotificationRequest,
@@ -850,8 +859,8 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
     }
     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.getConnectorStatus(connectorId)?.availability
+      }', status '${chargingStation.getConnectorStatus(connectorId)?.status}'`
     );
     return OCPPConstants.OCPP_RESPONSE_REJECTED;
   }
@@ -942,7 +951,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
     }
     const retrieveDate = Utils.convertToDate(commandPayload.retrieveDate);
     const now = Date.now();
-    if (retrieveDate.getTime() <= now) {
+    if (retrieveDate?.getTime() <= now) {
       this.asyncResource
         .runInAsyncScope(
           this.updateFirmware.bind(this) as (
@@ -960,7 +969,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
         this.updateFirmware(chargingStation).catch(() => {
           /* Intentional */
         });
-      }, retrieveDate.getTime() - now);
+      }, retrieveDate?.getTime() - now);
     }
     return OCPPConstants.OCPP_RESPONSE_EMPTY;
   }
@@ -974,7 +983,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
     for (const connectorId of chargingStation.connectors.keys()) {
       if (
         connectorId > 0 &&
-        chargingStation.getConnectorStatus(connectorId).transactionStarted === false
+        chargingStation.getConnectorStatus(connectorId)?.transactionStarted === false
       ) {
         await chargingStation.ocppRequestService.requestHandler<
           OCPP16StatusNotificationRequest,
@@ -1051,8 +1060,8 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
       try {
         const logFiles = fs
           .readdirSync(path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../../../'))
-          .filter(file => file.endsWith('.log'))
-          .map(file => path.join('./', file));
+          .filter((file) => file.endsWith('.log'))
+          .map((file) => path.join('./', file));
         const diagnosticsArchive = `${chargingStation.stationInfo.chargingStationId}_logs.tar.gz`;
         tar.create({ gzip: true }, logFiles).pipe(fs.createWriteStream(diagnosticsArchive));
         ftpClient = new Client();
@@ -1064,7 +1073,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
         });
         let uploadResponse: FTPResponse;
         if (accessResponse.code === 220) {
-          ftpClient.trackProgress(info => {
+          ftpClient.trackProgress((info) => {
             logger.info(
               `${chargingStation.logPrefix()} ${
                 info.bytes / 1024
@@ -1077,7 +1086,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
               >(chargingStation, OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION, {
                 status: OCPP16DiagnosticsStatus.Uploading,
               })
-              .catch(error => {
+              .catch((error) => {
                 logger.error(
                   `${chargingStation.logPrefix()} ${moduleName}.handleRequestGetDiagnostics: Error while sending '${
                     OCPP16RequestCommand.DIAGNOSTICS_STATUS_NOTIFICATION
@@ -1190,7 +1199,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
                 chargingStation.bootNotificationRequest,
                 { skipBufferingOnError: true, triggerMessage: true }
               )
-              .then(response => {
+              .then((response) => {
                 chargingStation.bootNotificationResponse = response;
               })
               .catch(() => {
@@ -1216,7 +1225,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
           return OCPPConstants.OCPP_TRIGGER_MESSAGE_RESPONSE_ACCEPTED;
         case OCPP16MessageTrigger.StatusNotification:
           setTimeout(() => {
-            if (commandPayload?.connectorId) {
+            if (!Utils.isNullOrUndefined(commandPayload?.connectorId)) {
               chargingStation.ocppRequestService
                 .requestHandler<OCPP16StatusNotificationRequest, OCPP16StatusNotificationResponse>(
                   chargingStation,
@@ -1224,7 +1233,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
                   {
                     connectorId: commandPayload.connectorId,
                     errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
-                    status: chargingStation.getConnectorStatus(commandPayload.connectorId).status,
+                    status: chargingStation.getConnectorStatus(commandPayload.connectorId)?.status,
                   },
                   {
                     triggerMessage: true,
@@ -1245,7 +1254,7 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
                     {
                       connectorId,
                       errorCode: OCPP16ChargePointErrorCode.NO_ERROR,
-                      status: chargingStation.getConnectorStatus(connectorId).status,
+                      status: chargingStation.getConnectorStatus(connectorId)?.status,
                     },
                     {
                       triggerMessage: true,
@@ -1293,13 +1302,4 @@ export default class OCPP16IncomingRequestService extends OCPPIncomingRequestSer
       );
     }
   }
-
-  private parseJsonSchemaFile<T extends JsonType>(relativePath: string): JSONSchemaType<T> {
-    return JSON.parse(
-      fs.readFileSync(
-        path.resolve(path.dirname(fileURLToPath(import.meta.url)), relativePath),
-        'utf8'
-      )
-    ) as JSONSchemaType<T>;
-  }
 }