refactor: cleanup get composite schedule code

[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 d550e4d1bd3c2339397a03d4b42a8b98f9e06b6d..e75842365345c7b2327bb84a0479e4044e269592 100644 (file)
--- a/src/charging-station/ocpp/2.0/OCPP20RequestService.ts
+++ b/src/charging-station/ocpp/2.0/OCPP20RequestService.ts
@@ -1,131 +1,109 @@
 // 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 { OCPP20Constants } from './OCPP20Constants';
+import { OCPP20ServiceUtils } from './OCPP20ServiceUtils';
+import type { ChargingStation } from '../../../charging-station';
+import { OCPPError } from '../../../exception';
 import {
+  ErrorType,
+  type JsonObject,
+  type JsonType,
   type OCPP20BootNotificationRequest,
   type OCPP20HeartbeatRequest,
   OCPP20RequestCommand,
   type OCPP20StatusNotificationRequest,
-} 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';
+  OCPPVersion,
+  type RequestParams,
+} from '../../../types';
+import { generateUUID } from '../../../utils';
+import { OCPPRequestService } from '../OCPPRequestService';
+import type { OCPPResponseService } from '../OCPPResponseService';
 
 const moduleName = 'OCPP20RequestService';
 
-export default class OCPP20RequestService extends OCPPRequestService {
+export class OCPP20RequestService extends OCPPRequestService {
   protected jsonSchemas: Map<OCPP20RequestCommand, JSONSchemaType<JsonObject>>;
 
   public constructor(ocppResponseService: OCPPResponseService) {
-    if (new.target?.name === moduleName) {
-      throw new TypeError(`Cannot construct ${new.target?.name} instances directly`);
-    }
+    // 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>>([
       [
         OCPP20RequestCommand.BOOT_NOTIFICATION,
-        this.parseJsonSchemaFile<OCPP20BootNotificationRequest>(
-          '../../../assets/json-schemas/ocpp/2.0/BootNotificationRequest.json'
+        OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20BootNotificationRequest>(
+          'assets/json-schemas/ocpp/2.0/BootNotificationRequest.json',
+          moduleName,
+          'constructor',
         ),
       ],
       [
         OCPP20RequestCommand.HEARTBEAT,
-        this.parseJsonSchemaFile<OCPP20HeartbeatRequest>(
-          '../../../assets/json-schemas/ocpp/2.0/HeartbeatRequest.json'
+        OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20HeartbeatRequest>(
+          'assets/json-schemas/ocpp/2.0/HeartbeatRequest.json',
+          moduleName,
+          'constructor',
         ),
       ],
       [
         OCPP20RequestCommand.STATUS_NOTIFICATION,
-        this.parseJsonSchemaFile<OCPP20StatusNotificationRequest>(
-          '../../../assets/json-schemas/ocpp/2.0/StatusNotificationRequest.json'
+        OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20StatusNotificationRequest>(
+          'assets/json-schemas/ocpp/2.0/StatusNotificationRequest.json',
+          moduleName,
+          'constructor',
         ),
       ],
     ]);
-    this.buildRequestPayload.bind(this);
+    this.buildRequestPayload = this.buildRequestPayload.bind(this) as <Request extends JsonType>(
+      chargingStation: ChargingStation,
+      commandName: OCPP20RequestCommand,
+      commandParams?: JsonType,
+    ) => Request;
   }
 
   public async requestHandler<RequestType extends JsonType, ResponseType extends JsonType>(
     chargingStation: ChargingStation,
     commandName: OCPP20RequestCommand,
     commandParams?: JsonType,
-    params?: RequestParams
+    params?: RequestParams,
   ): Promise<ResponseType> {
+    // FIXME?: add sanity checks on charging station availability, connector availability, connector status, etc.
     if (OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true) {
-      const requestPayload = this.buildRequestPayload<RequestType>(
-        chargingStation,
-        commandName,
-        commandParams
-      );
       return (await this.sendMessage(
         chargingStation,
-        Utils.generateUUID(),
-        requestPayload,
+        generateUUID(),
+        this.buildRequestPayload<RequestType>(chargingStation, commandName, commandParams),
         commandName,
-        params
-      )) as unknown as ResponseType;
+        params,
+      )) 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}'`,
       commandName,
-      commandParams
+      commandParams,
     );
   }
 
   private buildRequestPayload<Request extends JsonType>(
     chargingStation: ChargingStation,
     commandName: OCPP20RequestCommand,
-    commandParams?: JsonType
+    commandParams?: JsonType,
   ): 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;
+        return commandParams as unknown as Request;
       case OCPP20RequestCommand.HEARTBEAT:
-        return {} as unknown as Request;
+        return OCPP20Constants.OCPP_RESPONSE_EMPTY as unknown as Request;
       case OCPP20RequestCommand.STATUS_NOTIFICATION:
         return {
-          timestamp: commandParams?.timestamp,
-          connectorStatus: commandParams?.connectorStatus,
-          evseId: commandParams?.evseId,
-          connectorId: commandParams?.connectorId,
+          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().
@@ -134,17 +112,8 @@ export default class OCPP20RequestService extends OCPPRequestService {
           // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
           `Unsupported OCPP command '${commandName}'`,
           commandName,
-          commandParams
+          commandParams,
         );
     }
   }
-
-  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>;
-  }
 }