fix: refine CS registration error message

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

diff --git a/src/charging-station/ocpp/2.0/OCPP20IncomingRequestService.ts b/src/charging-station/ocpp/2.0/OCPP20IncomingRequestService.ts
index 96a66f1ad01d39b9fa8c72d161f0c3ed2c23c6b6..0d657d99f7bd67b365660c3e2888653157485e5c 100644 (file)
--- a/src/charging-station/ocpp/2.0/OCPP20IncomingRequestService.ts
+++ b/src/charging-station/ocpp/2.0/OCPP20IncomingRequestService.ts
@@ -1,87 +1,80 @@
 // 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 { OCPP20ServiceUtils } from './OCPP20ServiceUtils';
+import type { ChargingStation } from '../../../charging-station';
+import { OCPPError } from '../../../exception';
 import {
-  OCPP20ClearCacheRequest,
+  ErrorType,
+  type IncomingRequestHandler,
+  type JsonType,
+  type OCPP20ClearCacheRequest,
   OCPP20IncomingRequestCommand,
-} from '../../../types/ocpp/2.0/Requests';
-import type { OCPP20ClearCacheResponse } from '../../../types/ocpp/2.0/Responses';
-import { ErrorType } from '../../../types/ocpp/ErrorType';
-import { OCPPVersion } from '../../../types/ocpp/OCPPVersion';
-import type { IncomingRequestHandler } from '../../../types/ocpp/Requests';
-import logger from '../../../utils/Logger';
-import type ChargingStation from '../../ChargingStation';
-import { ChargingStationUtils } from '../../ChargingStationUtils';
-import OCPPConstants from '../OCPPConstants';
-import OCPPIncomingRequestService from '../OCPPIncomingRequestService';
-import { OCPP20ServiceUtils } from './OCPP20ServiceUtils';
+  OCPPVersion,
+} from '../../../types';
+import { logger } from '../../../utils';
+import { OCPPIncomingRequestService } from '../OCPPIncomingRequestService';
 
 const moduleName = 'OCPP20IncomingRequestService';
 
-export default class OCPP20IncomingRequestService extends OCPPIncomingRequestService {
+export class OCPP20IncomingRequestService extends OCPPIncomingRequestService {
+  protected jsonSchemas: Map<OCPP20IncomingRequestCommand, JSONSchemaType<JsonType>>;
   private incomingRequestHandlers: Map<OCPP20IncomingRequestCommand, IncomingRequestHandler>;
-  private jsonSchemas: Map<OCPP20IncomingRequestCommand, JSONSchemaType<JsonObject>>;
 
   public constructor() {
-    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);
     this.incomingRequestHandlers = new Map<OCPP20IncomingRequestCommand, IncomingRequestHandler>([
       [OCPP20IncomingRequestCommand.CLEAR_CACHE, this.handleRequestClearCache.bind(this)],
     ]);
-    this.jsonSchemas = new Map<OCPP20IncomingRequestCommand, JSONSchemaType<JsonObject>>([
+    this.jsonSchemas = new Map<OCPP20IncomingRequestCommand, JSONSchemaType<JsonType>>([
       [
         OCPP20IncomingRequestCommand.CLEAR_CACHE,
-        JSON.parse(
-          fs.readFileSync(
-            path.resolve(
-              path.dirname(fileURLToPath(import.meta.url)),
-              '../../../assets/json-schemas/ocpp/2.0/ClearCacheRequest.json'
-            ),
-            'utf8'
-          )
-        ) as JSONSchemaType<OCPP20ClearCacheRequest>,
+        OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20ClearCacheRequest>(
+          'assets/json-schemas/ocpp/2.0/ClearCacheRequest.json',
+          moduleName,
+          'constructor',
+        ),
       ],
     ]);
-    this.validatePayload.bind(this);
+    this.validatePayload = this.validatePayload.bind(this) as (
+      chargingStation: ChargingStation,
+      commandName: OCPP20IncomingRequestCommand,
+      commandPayload: JsonType,
+    ) => boolean;
   }
 
-  public async incomingRequestHandler(
+  public async incomingRequestHandler<ReqType extends JsonType, ResType extends JsonType>(
     chargingStation: ChargingStation,
     messageId: string,
     commandName: OCPP20IncomingRequestCommand,
-    commandPayload: JsonType
+    commandPayload: ReqType,
   ): Promise<void> {
-    let response: JsonType;
+    let response: ResType;
     if (
-      chargingStation.getOcppStrictCompliance() === true &&
-      chargingStation.isInPendingState() === true /* &&
-       (commandName === OCPP20IncomingRequestCommand.REMOTE_START_TRANSACTION ||
-        commandName === OCPP20IncomingRequestCommand.REMOTE_STOP_TRANSACTION ) */
+      chargingStation.stationInfo?.ocppStrictCompliance === true &&
+      chargingStation.inPendingState() === true &&
+      (commandName === OCPP20IncomingRequestCommand.REQUEST_START_TRANSACTION ||
+        commandName === OCPP20IncomingRequestCommand.REQUEST_STOP_TRANSACTION)
     ) {
       throw new OCPPError(
         ErrorType.SECURITY_ERROR,
         `${commandName} cannot be issued to handle request PDU ${JSON.stringify(
           commandPayload,
-          null,
-          2
+          undefined,
+          2,
         )} while the charging station is in pending state on the central server`,
         commandName,
-        commandPayload
+        commandPayload,
       );
     }
     if (
       chargingStation.isRegistered() === true ||
-      (chargingStation.getOcppStrictCompliance() === false &&
-        chargingStation.isInUnknownState() === true)
+      (chargingStation.stationInfo?.ocppStrictCompliance === false &&
+        chargingStation.inUnknownState() === true)
     ) {
       if (
         this.incomingRequestHandlers.has(commandName) === true &&
@@ -90,15 +83,15 @@ export default class OCPP20IncomingRequestService extends OCPPIncomingRequestSer
         try {
           this.validatePayload(chargingStation, commandName, commandPayload);
           // Call the method to build the response
-          response = await this.incomingRequestHandlers.get(commandName)(
+          response = (await this.incomingRequestHandlers.get(commandName)!(
             chargingStation,
-            commandPayload
-          );
+            commandPayload,
+          )) as ResType;
         } catch (error) {
           // Log
           logger.error(
             `${chargingStation.logPrefix()} ${moduleName}.incomingRequestHandler: Handle incoming request error:`,
-            error
+            error,
           );
           throw error;
         }
@@ -108,11 +101,11 @@ export default class OCPP20IncomingRequestService extends OCPPIncomingRequestSer
           ErrorType.NOT_IMPLEMENTED,
           `${commandName} is not implemented to handle request PDU ${JSON.stringify(
             commandPayload,
-            null,
-            2
+            undefined,
+            2,
           )}`,
           commandName,
-          commandPayload
+          commandPayload,
         );
       }
     } else {
@@ -120,11 +113,11 @@ export default class OCPP20IncomingRequestService extends OCPPIncomingRequestSer
         ErrorType.SECURITY_ERROR,
         `${commandName} cannot be issued to handle request PDU ${JSON.stringify(
           commandPayload,
-          null,
-          2
+          undefined,
+          2,
         )} while the charging station is not registered on the central server.`,
         commandName,
-        commandPayload
+        commandPayload,
       );
     }
     // Send the built response
@@ -132,33 +125,26 @@ export default class OCPP20IncomingRequestService extends OCPPIncomingRequestSer
       chargingStation,
       messageId,
       response,
-      commandName
+      commandName,
     );
   }
 
   private validatePayload(
     chargingStation: ChargingStation,
     commandName: OCPP20IncomingRequestCommand,
-    commandPayload: JsonType
+    commandPayload: JsonType,
   ): boolean {
     if (this.jsonSchemas.has(commandName) === true) {
       return this.validateIncomingRequestPayload(
         chargingStation,
         commandName,
-        this.jsonSchemas.get(commandName),
-        commandPayload
+        this.jsonSchemas.get(commandName)!,
+        commandPayload,
       );
     }
     logger.warn(
-      `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command ${commandName} PDU validation`
+      `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema found for command '${commandName}' PDU validation`,
     );
     return false;
   }
-
-  private handleRequestClearCache(chargingStation: ChargingStation): OCPP20ClearCacheResponse {
-    chargingStation.authorizedTagsCache.deleteAuthorizedTags(
-      ChargingStationUtils.getAuthorizationFile(chargingStation.stationInfo)
-    );
-    return OCPPConstants.OCPP_RESPONSE_ACCEPTED;
-  }
 }