X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F2.0%2FOCPP20RequestService.ts;h=38dbedf87f9b7f426507cfa8e92bf42ca5ef606d;hb=HEAD;hp=bc056bef13541e3b00f3cde9af16371ab6140765;hpb=b3fc3ff5bc50c2dbe20eb3ac1e681c00a022b4ee;p=e-mobility-charging-stations-simulator.git

diff --git a/src/charging-station/ocpp/2.0/OCPP20RequestService.ts b/src/charging-station/ocpp/2.0/OCPP20RequestService.ts
index bc056bef..38dbedf8 100644
--- a/src/charging-station/ocpp/2.0/OCPP20RequestService.ts
+++ b/src/charging-station/ocpp/2.0/OCPP20RequestService.ts
@@ -1,80 +1,101 @@
-// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
 
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
+import type { ValidateFunction } from 'ajv'
 
-import type { JSONSchemaType } from 'ajv';
-
-import OCPPError from '../../../exception/OCPPError';
-import type { JsonObject, JsonType } from '../../../types/JsonType';
+import type { ChargingStation } from '../../../charging-station/index.js'
+import { OCPPError } from '../../../exception/index.js'
 import {
+  ErrorType,
+  type JsonObject,
+  type JsonType,
   type OCPP20BootNotificationRequest,
+  type OCPP20HeartbeatRequest,
   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 Utils from '../../../utils/Utils';
-import type ChargingStation from '../../ChargingStation';
-import OCPPRequestService from '../OCPPRequestService';
-import type OCPPResponseService from '../OCPPResponseService';
-import { OCPP20ServiceUtils } from './OCPP20ServiceUtils';
+  type OCPP20StatusNotificationRequest,
+  OCPPVersion,
+  type RequestParams
+} from '../../../types/index.js'
+import { generateUUID } from '../../../utils/index.js'
+import { OCPPRequestService } from '../OCPPRequestService.js'
+import type { OCPPResponseService } from '../OCPPResponseService.js'
+import { OCPP20Constants } from './OCPP20Constants.js'
+import { OCPP20ServiceUtils } from './OCPP20ServiceUtils.js'
 
-const moduleName = 'OCPP20RequestService';
+const moduleName = 'OCPP20RequestService'
 
-export default class OCPP20RequestService extends OCPPRequestService {
-  protected jsonSchemas: Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>;
+export class OCPP20RequestService extends OCPPRequestService {
+  protected payloadValidateFunctions: Map<OCPP20RequestCommand, ValidateFunction<JsonType>>
 
-  public constructor(ocppResponseService: OCPPResponseService) {
-    if (new.target?.name === moduleName) {
-      throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
-    }
-    super(OCPPVersion.VERSION_20, ocppResponseService);
-    this.jsonSchemas = new Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>([
+  public constructor (ocppResponseService: OCPPResponseService) {
+    // if (new.target.name === moduleName) {
+    //   throw new TypeError(`Cannot construct ${new.target.name} instances directly`)
+    // }
+    super(OCPPVersion.VERSION_201, ocppResponseService)
+    this.payloadValidateFunctions = new Map<OCPP20RequestCommand, ValidateFunction<JsonType>>([
       [
         OCPP20RequestCommand.BOOT_NOTIFICATION,
-        JSON.parse(
-          fs.readFileSync(
-            path.resolve(
-              path.dirname(fileURLToPath(import.meta.url)),
-              '../../../assets/json-schemas/ocpp/2.0/BootNotificationRequest.json'
-            ),
-            'utf8'
+        this.ajv
+          .compile(
+            OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20BootNotificationRequest>(
+              'assets/json-schemas/ocpp/2.0/BootNotificationRequest.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
+      ],
+      [
+        OCPP20RequestCommand.HEARTBEAT,
+        this.ajv
+          .compile(
+            OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20HeartbeatRequest>(
+              'assets/json-schemas/ocpp/2.0/HeartbeatRequest.json',
+              moduleName,
+              'constructor'
+            )
           )
-        ) as JSONSchemaType<OCPP20BootNotificationRequest>,
+          .bind(this)
       ],
-    ]);
-    this.buildRequestPayload.bind(this);
+      [
+        OCPP20RequestCommand.STATUS_NOTIFICATION,
+        this.ajv
+          .compile(
+            OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20StatusNotificationRequest>(
+              'assets/json-schemas/ocpp/2.0/StatusNotificationRequest.json',
+              moduleName,
+              'constructor'
+            )
+          )
+          .bind(this)
+      ]
+    ])
+    this.buildRequestPayload = this.buildRequestPayload.bind(this)
   }
 
   public async requestHandler<RequestType extends JsonType, ResponseType extends JsonType>(
     chargingStation: ChargingStation,
     commandName: OCPP20RequestCommand,
-    commandParams?: JsonType,
+    commandParams?: RequestType,
     params?: RequestParams
   ): Promise<ResponseType> {
-    if (OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true) {
-      const requestPayload = this.buildRequestPayload<RequestType>(
-        chargingStation,
-        commandName,
-        commandParams
-      );
+    // FIXME?: add sanity checks on charging station availability, connector availability, connector status, etc.
+    if (OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName)) {
+      // TODO: pre request actions hook
       return (await this.sendMessage(
         chargingStation,
-        Utils.generateUUID(),
-        requestPayload,
+        generateUUID(),
+        this.buildRequestPayload<RequestType>(chargingStation, commandName, commandParams),
         commandName,
         params
-      )) as unknown as ResponseType;
+      )) as ResponseType
     }
     // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
     throw new OCPPError(
       ErrorType.NOT_SUPPORTED,
-      `Unsupported OCPP command '${commandName}'`,
+      `Unsupported OCPP command ${commandName}`,
       commandName,
       commandParams
-    );
+    )
   }
 
   private buildRequestPayload<Request extends JsonType>(
@@ -82,43 +103,26 @@ export default class OCPP20RequestService extends OCPPRequestService {
     commandName: OCPP20RequestCommand,
     commandParams?: JsonType
   ): Request {
-    commandParams = commandParams as JsonObject;
+    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 commandParams as unknown as Request
+      case OCPP20RequestCommand.HEARTBEAT:
+        return OCPP20Constants.OCPP_RESPONSE_EMPTY as unknown as Request
+      case OCPP20RequestCommand.STATUS_NOTIFICATION:
         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;
+          timestamp: new Date(),
+          ...commandParams
+        } 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(
           ErrorType.NOT_SUPPORTED,
           // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-          `Unsupported OCPP command '${commandName}'`,
+          `Unsupported OCPP command ${commandName}`,
           commandName,
           commandParams
-        );
+        )
     }
   }
 }