Fixes to OCA OCPP 2.0.1 JSON schemas

[e-mobility-charging-stations-simulator.git] / src / charging-station / ocpp / 2.0 / OCPP20RequestService.ts

diff --git a/src/charging-station/ocpp/2.0/OCPP20RequestService.ts b/src/charging-station/ocpp/2.0/OCPP20RequestService.ts
index 8dfdce680247c2e3c173a28ed6df19a56add7953..336327c9cfde468287e60eb9b4c579bccb83caf2 100644 (file)
--- a/src/charging-station/ocpp/2.0/OCPP20RequestService.ts
+++ b/src/charging-station/ocpp/2.0/OCPP20RequestService.ts
@@ -1,11 +1,19 @@
-// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
+
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
 import type { JSONSchemaType } from 'ajv';
 
 import OCPPError from '../../../exception/OCPPError';
 import type { JsonObject, JsonType } from '../../../types/JsonType';
-import type { OCPP20RequestCommand } from '../../../types/ocpp/2.0/Requests';
+import {
+  type OCPP20BootNotificationRequest,
+  OCPP20RequestCommand,
+} from '../../../types/ocpp/2.0/Requests';
 import { ErrorType } from '../../../types/ocpp/ErrorType';
+import { OCPPVersion } from '../../../types/ocpp/OCPPVersion';
 import type { RequestParams } from '../../../types/ocpp/Requests';
 import logger from '../../../utils/Logger';
 import Utils from '../../../utils/Utils';
@@ -23,10 +31,22 @@ export default class OCPP20RequestService extends OCPPRequestService {
     if (new.target?.name === moduleName) {
       throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
     }
-    super(ocppResponseService);
-    this.jsonSchemas = new Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>();
+    super(OCPPVersion.VERSION_20, ocppResponseService);
+    this.jsonSchemas = new Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>([
+      [
+        OCPP20RequestCommand.BOOT_NOTIFICATION,
+        JSON.parse(
+          fs.readFileSync(
+            path.resolve(
+              path.dirname(fileURLToPath(import.meta.url)),
+              '../../../assets/json-schemas/ocpp/2.0/BootNotificationRequest.json'
+            ),
+            'utf8'
+          )
+        ) as JSONSchemaType<OCPP20BootNotificationRequest>,
+      ],
+    ]);
     this.buildRequestPayload.bind(this);
-    this.validatePayload.bind(this);
   }
 
   public async requestHandler<RequestType extends JsonType, ResponseType extends JsonType>(
@@ -41,7 +61,6 @@ export default class OCPP20RequestService extends OCPPRequestService {
         commandName,
         commandParams
       );
-      this.validatePayload(chargingStation, commandName, requestPayload);
       return (await this.sendMessage(
         chargingStation,
         Utils.generateUUID(),
@@ -59,6 +78,19 @@ export default class OCPP20RequestService extends OCPPRequestService {
     );
   }
 
+  protected getRequestPayloadValidationSchema(
+    chargingStation: ChargingStation,
+    commandName: OCPP20RequestCommand
+  ): JSONSchemaType<JsonObject> | false {
+    if (this.jsonSchemas.has(commandName) === true) {
+      return this.jsonSchemas.get(commandName);
+    }
+    logger.warn(
+      `${chargingStation.logPrefix()} ${moduleName}.getPayloadValidationSchema: No JSON schema found for command ${commandName} PDU validation`
+    );
+    return false;
+  }
+
   private buildRequestPayload<Request extends JsonType>(
     chargingStation: ChargingStation,
     commandName: OCPP20RequestCommand,
@@ -66,6 +98,32 @@ export default class OCPP20RequestService extends OCPPRequestService {
   ): Request {
     commandParams = commandParams as JsonObject;
     switch (commandName) {
+      case OCPP20RequestCommand.BOOT_NOTIFICATION:
+        commandParams.chargingStation = commandParams.chargingStation as JsonObject;
+        commandParams.chargingStation.modem = commandParams.chargingStation.modem as JsonObject;
+        return {
+          reason: commandParams?.reason,
+          chargingStation: {
+            model: commandParams?.chargingStation?.model,
+            vendorName: commandParams?.chargingStation?.vendorName,
+            ...(!Utils.isUndefined(commandParams?.chargingStation?.firmwareVersion) && {
+              firmwareVersion: commandParams.chargingStation?.firmwareVersion,
+            }),
+            ...(!Utils.isUndefined(commandParams?.chargingStation?.serialNumber) && {
+              serialNumber: commandParams.chargingStation?.serialNumber,
+            }),
+            ...(!Utils.isUndefined(commandParams?.chargingStation?.modem) && {
+              modem: {
+                ...(!Utils.isUndefined(commandParams?.chargingStation?.modem?.iccid) && {
+                  iccid: commandParams.chargingStation.modem.iccid,
+                }),
+                ...(!Utils.isUndefined(commandParams?.chargingStation?.modem?.imsi) && {
+                  imsi: commandParams.chargingStation.modem.imsi,
+                }),
+              },
+            }),
+          },
+        } as unknown as Request;
       default:
         // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
         throw new OCPPError(
@@ -77,23 +135,4 @@ export default class OCPP20RequestService extends OCPPRequestService {
         );
     }
   }
-
-  private validatePayload<Request extends JsonType>(
-    chargingStation: ChargingStation,
-    commandName: OCPP20RequestCommand,
-    requestPayload: Request
-  ): boolean {
-    if (this.jsonSchemas.has(commandName)) {
-      return this.validateRequestPayload(
-        chargingStation,
-        commandName,
-        this.jsonSchemas.get(commandName),
-        requestPayload
-      );
-    }
-    logger.warn(
-      `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command ${commandName} PDU validation`
-    );
-    return false;
-  }
 }