src/performance/storage/Storage.ts

   1 // Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
   2
   3 import { URL } from 'node:url'
   4
   5 import {
   6   DBName,
   7   type EmptyObject,
   8   type HandleErrorParams,
   9   type Statistics,
  10   StorageType
  11 } from '../../types/index.js'
  12 import { logger, setDefaultErrorParams } from '../../utils/index.js'
  13
  14 export abstract class Storage {
  15   protected readonly storageUri: URL
  16   protected readonly logPrefix: string
  17   protected dbName!: string
  18   private static readonly performanceStatistics = new Map<string, Statistics>()
  19
  20   constructor (storageUri: string, logPrefix: string) {
  21     this.storageUri = new URL(storageUri)
  22     this.logPrefix = logPrefix
  23   }
  24
  25   protected handleDBError (
  26     type: StorageType,
  27     error: Error,
  28     table?: string,
  29     params: HandleErrorParams<EmptyObject> = { throwError: false, consoleOut: false }
  30   ): void {
  31     setDefaultErrorParams(params, { throwError: false, consoleOut: false })
  32     const inTableOrCollectionStr = table != null && ` in table or collection '${table}'`
  33     logger.error(
  34       `${this.logPrefix} ${this.getDBNameFromStorageType(type)} error '${
  35         error.message
  36       }'${inTableOrCollectionStr}:`,
  37       error
  38     )
  39     if (params.throwError === true) {
  40       throw error
  41     }
  42   }
  43
  44   protected getDBNameFromStorageType (type: StorageType): DBName | undefined {
  45     switch (type) {
  46       case StorageType.SQLITE:
  47         return DBName.SQLITE
  48       case StorageType.MARIA_DB:
  49         return DBName.MARIA_DB
  50       case StorageType.MYSQL:
  51         return DBName.MYSQL
  52       case StorageType.MONGO_DB:
  53         return DBName.MONGO_DB
  54     }
  55   }
  56
  57   public getPerformanceStatistics (): IterableIterator<Statistics> {
  58     return Storage.performanceStatistics.values()
  59   }
  60
  61   protected setPerformanceStatistics (performanceStatistics: Statistics): void {
  62     Storage.performanceStatistics.set(performanceStatistics.id, performanceStatistics)
  63   }
  64
  65   protected clearPerformanceStatistics (): void {
  66     Storage.performanceStatistics.clear()
  67   }
  68
  69   public abstract open (): void | Promise<void>
  70   public abstract close (): void | Promise<void>
  71   public abstract storePerformanceStatistics (
  72     performanceStatistics: Statistics
  73   ): void | Promise<void>
  74 }