refactor: cleanup configuration handling methods namespace

[e-mobility-charging-stations-simulator.git] / src / charging-station / IdTagsCache.ts

diff --git a/src/charging-station/IdTagsCache.ts b/src/charging-station/IdTagsCache.ts
index f19f66f31948b270de58a115fee550a4a6fcbdcb..ff5c49d9a6a2dba2fc2810b0e6a36fa54fbbb125 100644 (file)
--- a/src/charging-station/IdTagsCache.ts
+++ b/src/charging-station/IdTagsCache.ts
@@ -1,8 +1,9 @@
 import fs from 'node:fs';
 
-import { type ChargingStation, ChargingStationUtils } from './internal';
+import type { ChargingStation } from './ChargingStation';
+import { ChargingStationUtils } from './ChargingStationUtils';
 import { FileType, IdTagDistribution } from '../types';
-import { FileUtils, Utils, logger } from '../utils';
+import { ErrorUtils, FileUtils, Utils, logger } from '../utils';
 
 type IdTagsCacheValueType = {
   idTags: string[];
@@ -26,6 +27,15 @@ export class IdTagsCache {
     return IdTagsCache.instance;
   }
 
+  /**
+   * Get one idtag from the cache given the distribution
+   * Must be called after checking the cache is not an empty array
+   *
+   * @param distribution
+   * @param chargingStation
+   * @param connectorId
+   * @returns
+   */
   public getIdTag(
     distribution: IdTagDistribution,
     chargingStation: ChargingStation,
@@ -45,6 +55,13 @@ export class IdTagsCache {
     }
   }
 
+  /**
+   * Get all idtags from the cache
+   * Must be called after checking the cache is not an empty array
+   *
+   * @param file
+   * @returns
+   */
   public getIdTags(file: string): string[] | undefined {
     if (this.hasIdTagsCache(file) === false) {
       this.setIdTagsCache(file, this.getIdTagsFromFile(file));
@@ -58,7 +75,7 @@ export class IdTagsCache {
 
   private getRandomIdTag(hashId: string, file: string): string {
     const idTags = this.getIdTags(file);
-    const addressableKey = this.getIdTagsCacheAddressableKey(file, hashId);
+    const addressableKey = this.getIdTagsCacheIndexesAddressableKey(file, hashId);
     this.idTagsCachesAddressableIndexes.set(
       addressableKey,
       Math.floor(Utils.secureRandom() * idTags.length)
@@ -68,7 +85,7 @@ export class IdTagsCache {
 
   private getRoundRobinIdTag(hashId: string, file: string): string {
     const idTags = this.getIdTags(file);
-    const addressableKey = this.getIdTagsCacheAddressableKey(file, hashId);
+    const addressableKey = this.getIdTagsCacheIndexesAddressableKey(file, hashId);
     const idTagIndex = this.idTagsCachesAddressableIndexes.get(addressableKey) ?? 0;
     const idTag = idTags[idTagIndex];
     this.idTagsCachesAddressableIndexes.set(
@@ -81,8 +98,10 @@ export class IdTagsCache {
   private getConnectorAffinityIdTag(chargingStation: ChargingStation, connectorId: number): string {
     const file = ChargingStationUtils.getIdTagsFile(chargingStation.stationInfo);
     const idTags = this.getIdTags(file);
-    const hashId = chargingStation.stationInfo.hashId;
-    const addressableKey = this.getIdTagsCacheAddressableKey(file, hashId);
+    const addressableKey = this.getIdTagsCacheIndexesAddressableKey(
+      file,
+      chargingStation.stationInfo.hashId
+    );
     this.idTagsCachesAddressableIndexes.set(
       addressableKey,
       (chargingStation.index - 1 + (connectorId - 1)) % idTags.length
@@ -111,7 +130,7 @@ export class IdTagsCache {
               this.deleteIdTagsCache(file);
               this.deleteIdTagsCacheIndexes(file);
             } catch (error) {
-              FileUtils.handleFileException(
+              ErrorUtils.handleFileException(
                 file,
                 FileType.Authorization,
                 error as NodeJS.ErrnoException,
@@ -144,28 +163,24 @@ export class IdTagsCache {
     }
   }
 
-  private getIdTagsCacheAddressableKey(prefix: string, uid: string): string {
+  private getIdTagsCacheIndexesAddressableKey(prefix: string, uid: string): string {
     return `${prefix}${uid}`;
   }
 
   private getIdTagsFromFile(file: string): string[] {
-    let idTags: string[] = [];
-    if (file) {
+    if (Utils.isNotEmptyString(file)) {
       try {
-        // Load id tags file
-        idTags = JSON.parse(fs.readFileSync(file, 'utf8')) as string[];
+        return JSON.parse(fs.readFileSync(file, 'utf8')) as string[];
       } catch (error) {
-        FileUtils.handleFileException(
+        ErrorUtils.handleFileException(
           file,
           FileType.Authorization,
           error as NodeJS.ErrnoException,
           this.logPrefix(file)
         );
       }
-    } else {
-      logger.info(`${this.logPrefix(file)} No id tags file given`);
     }
-    return idTags;
+    return [];
   }
 
   private logPrefix = (file: string): string => {