fix: send preparing connector status before `StartTransaction`

[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 3b1e269556338a958568f2d4e16217a756716ddb..c9c4b17b24d6060e7ac102e9ab70664f97c2d13a 100644 (file)
--- a/src/charging-station/ocpp/2.0/OCPP20RequestService.ts
+++ b/src/charging-station/ocpp/2.0/OCPP20RequestService.ts
@@ -1,54 +1,93 @@
-// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
 
-import type { JSONSchemaType } from 'ajv';
+import type { ValidateFunction } from 'ajv'
 
-import OCPPError from '../../../exception/OCPPError';
-import type { JsonObject, JsonType } from '../../../types/JsonType';
-import type { OCPP20RequestCommand } from '../../../types/ocpp/2.0/Requests';
-import { ErrorType } from '../../../types/ocpp/ErrorType';
-import type { RequestParams } from '../../../types/ocpp/Requests';
-import logger from '../../../utils/Logger';
-import Utils from '../../../utils/Utils';
-import type ChargingStation from '../../ChargingStation';
-import OCPPRequestService from '../OCPPRequestService';
-import type OCPPResponseService from '../OCPPResponseService';
-import { OCPP20ServiceUtils } from './OCPP20ServiceUtils';
+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,
+  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 {
-  private 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(ocppResponseService);
-    this.jsonSchemas = new Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>();
-    this.buildRequestPayload.bind(this);
-    this.validatePayload.bind(this);
+  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,
+        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'
+            )
+          )
+          .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
-      );
-      this.validatePayload(chargingStation, commandName, requestPayload);
+    // FIXME?: add sanity checks on charging station availability, connector availability, connector status, etc.
+    if (OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName)) {
+      // TODO: post 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(
@@ -56,7 +95,7 @@ export default class OCPP20RequestService extends OCPPRequestService {
       `Unsupported OCPP command '${commandName}'`,
       commandName,
       commandParams
-    );
+    )
   }
 
   private buildRequestPayload<Request extends JsonType>(
@@ -64,8 +103,17 @@ 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:
+        return commandParams as unknown as Request
+      case OCPP20RequestCommand.HEARTBEAT:
+        return OCPP20Constants.OCPP_RESPONSE_EMPTY as unknown as Request
+      case OCPP20RequestCommand.STATUS_NOTIFICATION:
+        return {
+          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(
@@ -74,26 +122,7 @@ export default class OCPP20RequestService extends OCPPRequestService {
           `Unsupported OCPP command '${commandName}'`,
           commandName,
           commandParams
-        );
-    }
-  }
-
-  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;
   }
 }