docs: fix README.md formatting
[e-mobility-charging-stations-simulator.git] / src / performance / storage / Storage.ts
index c4a0ce9c5669d2516554d161b11f8234a8e08c09..d9539190cced18006c52d8845dd62ac5ec6b0b37 100644 (file)
@@ -1,45 +1,61 @@
-// Copyright Jerome Benoit. 2021. All Rights Reserved.
+// Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
 
-import { DBName, StorageType } from '../../types/Storage';
+import { URL } from 'node:url'
 
-import { EmptyObject } from '../../types/EmptyObject';
-import { HandleErrorParams } from '../../types/Error';
-import Statistics from '../../types/Statistics';
-import { URL } from 'url';
-import Utils from '../../utils/Utils';
-import logger from '../../utils/Logger';
+import {
+  DBName,
+  type EmptyObject,
+  type HandleErrorParams,
+  type Statistics,
+  StorageType
+} from '../../types/index.js'
+import { logger, setDefaultErrorParams } from '../../utils/index.js'
 
 export abstract class Storage {
-  protected readonly storageUri: URL;
-  protected readonly logPrefix: string;
-  protected dbName: string;
+  protected readonly storageUri: URL
+  protected readonly logPrefix: string
+  protected dbName!: string
 
-  constructor(storageUri: string, logPrefix: string) {
-    this.storageUri = new URL(storageUri);
-    this.logPrefix = logPrefix;
+  constructor (storageUri: string, logPrefix: string) {
+    this.storageUri = new URL(storageUri)
+    this.logPrefix = logPrefix
   }
 
-  protected handleDBError(type: StorageType, error: Error, table?: string, params: HandleErrorParams<EmptyObject> = { throwError: false }): void {
-    logger.error(`${this.logPrefix} ${this.getDBNameFromStorageType(type)} error '${error.message}'${(!Utils.isNullOrUndefined(table) || !table) && ` in table or collection '${table}'`}: %j`, error);
-    if (params?.throwError) {
-      throw error;
+  protected handleDBError (
+    type: StorageType,
+    error: Error,
+    table?: string,
+    params: HandleErrorParams<EmptyObject> = { throwError: false, consoleOut: false }
+  ): void {
+    setDefaultErrorParams(params, { throwError: false, consoleOut: false })
+    const inTableOrCollectionStr = table != null && ` in table or collection '${table}'`
+    logger.error(
+      `${this.logPrefix} ${this.getDBNameFromStorageType(type)} error '${
+        error.message
+      }'${inTableOrCollectionStr}:`,
+      error
+    )
+    if (params.throwError === true) {
+      throw error
     }
   }
 
-  protected getDBNameFromStorageType(type: StorageType): DBName {
+  protected getDBNameFromStorageType (type: StorageType): DBName | undefined {
     switch (type) {
+      case StorageType.SQLITE:
+        return DBName.SQLITE
       case StorageType.MARIA_DB:
-        return DBName.MARIA_DB;
-      case StorageType.MONGO_DB:
-        return DBName.MONGO_DB;
+        return DBName.MARIA_DB
       case StorageType.MYSQL:
-        return DBName.MYSQL;
-      case StorageType.SQLITE:
-        return DBName.SQLITE;
+        return DBName.MYSQL
+      case StorageType.MONGO_DB:
+        return DBName.MONGO_DB
     }
   }
 
-  public abstract open(): void | Promise<void>;
-  public abstract close(): void | Promise<void>;
-  public abstract storePerformanceStatistics(performanceStatistics: Statistics): void | Promise<void>;
+  public abstract open (): void | Promise<void>
+  public abstract close (): void | Promise<void>
+  public abstract storePerformanceStatistics (
+    performanceStatistics: Statistics
+  ): void | Promise<void>
 }