src/utils/Configuration.ts

   1 import { type FSWatcher, readFileSync, watch } from 'node:fs'
   2 import { dirname, join } from 'node:path'
   3 import { env } from 'node:process'
   4 import { fileURLToPath } from 'node:url'
   5
   6 import chalk from 'chalk'
   7 import merge from 'just-merge'
   8
   9 import {
  10   buildPerformanceUriFilePath,
  11   checkWorkerElementsPerWorker,
  12   checkWorkerProcessType,
  13   getDefaultPerformanceStorageUri,
  14   handleFileException,
  15   logPrefix
  16 } from './ConfigurationUtils.js'
  17 import { Constants } from './Constants.js'
  18 import { hasOwnProp, isCFEnvironment, once } from './Utils.js'
  19 import {
  20   ApplicationProtocol,
  21   type ConfigurationData,
  22   ConfigurationSection,
  23   FileType,
  24   type LogConfiguration,
  25   type StationTemplateUrl,
  26   type StorageConfiguration,
  27   StorageType,
  28   SupervisionUrlDistribution,
  29   type UIServerConfiguration,
  30   type WorkerConfiguration
  31 } from '../types/index.js'
  32 import {
  33   DEFAULT_ELEMENT_START_DELAY,
  34   DEFAULT_POOL_MAX_SIZE,
  35   DEFAULT_POOL_MIN_SIZE,
  36   DEFAULT_WORKER_START_DELAY,
  37   WorkerProcessType
  38 } from '../worker/index.js'
  39
  40 type ConfigurationSectionType =
  41   | LogConfiguration
  42   | StorageConfiguration
  43   | WorkerConfiguration
  44   | UIServerConfiguration
  45
  46 // eslint-disable-next-line @typescript-eslint/no-extraneous-class
  47 export class Configuration {
  48   public static configurationChangeCallback: () => Promise<void>
  49
  50   private static readonly configurationFile = join(
  51     dirname(fileURLToPath(import.meta.url)),
  52     'assets',
  53     'config.json'
  54   )
  55
  56   private static configurationFileReloading = false
  57   private static configurationData?: ConfigurationData
  58   private static configurationFileWatcher?: FSWatcher
  59   private static readonly configurationSectionCache = new Map<
  60   ConfigurationSection,
  61   ConfigurationSectionType
  62   >([
  63     [ConfigurationSection.log, Configuration.buildLogSection()],
  64     [ConfigurationSection.performanceStorage, Configuration.buildPerformanceStorageSection()],
  65     [ConfigurationSection.worker, Configuration.buildWorkerSection()],
  66     [ConfigurationSection.uiServer, Configuration.buildUIServerSection()]
  67   ])
  68
  69   private constructor () {
  70     // This is intentional
  71   }
  72
  73   public static getConfigurationSection<T extends ConfigurationSectionType>(
  74     sectionName: ConfigurationSection
  75   ): T {
  76     if (!Configuration.isConfigurationSectionCached(sectionName)) {
  77       Configuration.cacheConfigurationSection(sectionName)
  78     }
  79     return Configuration.configurationSectionCache.get(sectionName) as T
  80   }
  81
  82   public static getStationTemplateUrls (): StationTemplateUrl[] | undefined {
  83     const checkDeprecatedConfigurationKeysOnce = once(
  84       Configuration.checkDeprecatedConfigurationKeys.bind(Configuration),
  85       Configuration
  86     )
  87     checkDeprecatedConfigurationKeysOnce()
  88     return Configuration.getConfigurationData()?.stationTemplateUrls
  89   }
  90
  91   public static getSupervisionUrls (): string | string[] | undefined {
  92     if (
  93       Configuration.getConfigurationData()?.['supervisionURLs' as keyof ConfigurationData] !==
  94       undefined
  95     ) {
  96       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
  97       Configuration.getConfigurationData()!.supervisionUrls = Configuration.getConfigurationData()![
  98         'supervisionURLs' as keyof ConfigurationData
  99       ] as string | string[]
 100     }
 101     return Configuration.getConfigurationData()?.supervisionUrls
 102   }
 103
 104   public static getSupervisionUrlDistribution (): SupervisionUrlDistribution | undefined {
 105     return hasOwnProp(Configuration.getConfigurationData(), 'supervisionUrlDistribution')
 106       ? Configuration.getConfigurationData()?.supervisionUrlDistribution
 107       : SupervisionUrlDistribution.ROUND_ROBIN
 108   }
 109
 110   public static workerPoolInUse (): boolean {
 111     return [WorkerProcessType.dynamicPool, WorkerProcessType.fixedPool].includes(
 112       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 113       Configuration.getConfigurationSection<WorkerConfiguration>(ConfigurationSection.worker)
 114         .processType!
 115     )
 116   }
 117
 118   public static workerDynamicPoolInUse (): boolean {
 119     return (
 120       Configuration.getConfigurationSection<WorkerConfiguration>(ConfigurationSection.worker)
 121         .processType === WorkerProcessType.dynamicPool
 122     )
 123   }
 124
 125   private static isConfigurationSectionCached (sectionName: ConfigurationSection): boolean {
 126     return Configuration.configurationSectionCache.has(sectionName)
 127   }
 128
 129   private static cacheConfigurationSection (sectionName: ConfigurationSection): void {
 130     switch (sectionName) {
 131       case ConfigurationSection.log:
 132         Configuration.configurationSectionCache.set(sectionName, Configuration.buildLogSection())
 133         break
 134       case ConfigurationSection.performanceStorage:
 135         Configuration.configurationSectionCache.set(
 136           sectionName,
 137           Configuration.buildPerformanceStorageSection()
 138         )
 139         break
 140       case ConfigurationSection.worker:
 141         Configuration.configurationSectionCache.set(sectionName, Configuration.buildWorkerSection())
 142         break
 143       case ConfigurationSection.uiServer:
 144         Configuration.configurationSectionCache.set(
 145           sectionName,
 146           Configuration.buildUIServerSection()
 147         )
 148         break
 149       default:
 150         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
 151         throw new Error(`Unknown configuration section '${sectionName}'`)
 152     }
 153   }
 154
 155   private static buildUIServerSection (): UIServerConfiguration {
 156     let uiServerConfiguration: UIServerConfiguration = {
 157       enabled: false,
 158       type: ApplicationProtocol.WS,
 159       options: {
 160         host: Constants.DEFAULT_UI_SERVER_HOST,
 161         port: Constants.DEFAULT_UI_SERVER_PORT
 162       }
 163     }
 164     if (hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.uiServer)) {
 165       uiServerConfiguration = merge<UIServerConfiguration>(
 166         uiServerConfiguration,
 167         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 168         Configuration.getConfigurationData()!.uiServer!
 169       )
 170     }
 171     if (isCFEnvironment()) {
 172       delete uiServerConfiguration.options?.host
 173       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 174       uiServerConfiguration.options!.port = parseInt(env.PORT!)
 175     }
 176     return uiServerConfiguration
 177   }
 178
 179   private static buildPerformanceStorageSection (): StorageConfiguration {
 180     let storageConfiguration: StorageConfiguration = {
 181       enabled: false,
 182       type: StorageType.JSON_FILE,
 183       uri: getDefaultPerformanceStorageUri(StorageType.JSON_FILE)
 184     }
 185     if (hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.performanceStorage)) {
 186       storageConfiguration = {
 187         ...storageConfiguration,
 188         ...Configuration.getConfigurationData()?.performanceStorage,
 189         ...(Configuration.getConfigurationData()?.performanceStorage?.type ===
 190           StorageType.JSON_FILE &&
 191           Configuration.getConfigurationData()?.performanceStorage?.uri != null && {
 192           uri: buildPerformanceUriFilePath(
 193             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 194             new URL(Configuration.getConfigurationData()!.performanceStorage!.uri!).pathname
 195           )
 196         })
 197       }
 198     }
 199     return storageConfiguration
 200   }
 201
 202   private static buildLogSection (): LogConfiguration {
 203     const defaultLogConfiguration: LogConfiguration = {
 204       enabled: true,
 205       file: 'logs/combined.log',
 206       errorFile: 'logs/error.log',
 207       statisticsInterval: Constants.DEFAULT_LOG_STATISTICS_INTERVAL,
 208       level: 'info',
 209       format: 'simple',
 210       rotate: true
 211     }
 212     const deprecatedLogConfiguration: LogConfiguration = {
 213       ...(hasOwnProp(Configuration.getConfigurationData(), 'logEnabled') && {
 214         enabled: Configuration.getConfigurationData()?.logEnabled
 215       }),
 216       ...(hasOwnProp(Configuration.getConfigurationData(), 'logFile') && {
 217         file: Configuration.getConfigurationData()?.logFile
 218       }),
 219       ...(hasOwnProp(Configuration.getConfigurationData(), 'logErrorFile') && {
 220         errorFile: Configuration.getConfigurationData()?.logErrorFile
 221       }),
 222       ...(hasOwnProp(Configuration.getConfigurationData(), 'logStatisticsInterval') && {
 223         statisticsInterval: Configuration.getConfigurationData()?.logStatisticsInterval
 224       }),
 225       ...(hasOwnProp(Configuration.getConfigurationData(), 'logLevel') && {
 226         level: Configuration.getConfigurationData()?.logLevel
 227       }),
 228       ...(hasOwnProp(Configuration.getConfigurationData(), 'logConsole') && {
 229         console: Configuration.getConfigurationData()?.logConsole
 230       }),
 231       ...(hasOwnProp(Configuration.getConfigurationData(), 'logFormat') && {
 232         format: Configuration.getConfigurationData()?.logFormat
 233       }),
 234       ...(hasOwnProp(Configuration.getConfigurationData(), 'logRotate') && {
 235         rotate: Configuration.getConfigurationData()?.logRotate
 236       }),
 237       ...(hasOwnProp(Configuration.getConfigurationData(), 'logMaxFiles') && {
 238         maxFiles: Configuration.getConfigurationData()?.logMaxFiles
 239       }),
 240       ...(hasOwnProp(Configuration.getConfigurationData(), 'logMaxSize') && {
 241         maxSize: Configuration.getConfigurationData()?.logMaxSize
 242       })
 243     }
 244     const logConfiguration: LogConfiguration = {
 245       ...defaultLogConfiguration,
 246       ...deprecatedLogConfiguration,
 247       ...(hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.log) &&
 248         Configuration.getConfigurationData()?.log)
 249     }
 250     return logConfiguration
 251   }
 252
 253   private static buildWorkerSection (): WorkerConfiguration {
 254     const defaultWorkerConfiguration: WorkerConfiguration = {
 255       processType: WorkerProcessType.workerSet,
 256       startDelay: DEFAULT_WORKER_START_DELAY,
 257       elementsPerWorker: 'auto',
 258       elementStartDelay: DEFAULT_ELEMENT_START_DELAY,
 259       poolMinSize: DEFAULT_POOL_MIN_SIZE,
 260       poolMaxSize: DEFAULT_POOL_MAX_SIZE
 261     }
 262     const deprecatedWorkerConfiguration: WorkerConfiguration = {
 263       ...(hasOwnProp(Configuration.getConfigurationData(), 'workerProcess') && {
 264         processType: Configuration.getConfigurationData()?.workerProcess
 265       }),
 266       ...(hasOwnProp(Configuration.getConfigurationData(), 'workerStartDelay') && {
 267         startDelay: Configuration.getConfigurationData()?.workerStartDelay
 268       }),
 269       ...(hasOwnProp(Configuration.getConfigurationData(), 'chargingStationsPerWorker') && {
 270         elementsPerWorker: Configuration.getConfigurationData()?.chargingStationsPerWorker
 271       }),
 272       ...(hasOwnProp(Configuration.getConfigurationData(), 'elementStartDelay') && {
 273         elementStartDelay: Configuration.getConfigurationData()?.elementStartDelay
 274       }),
 275       ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMinSize') && {
 276         poolMinSize: Configuration.getConfigurationData()?.workerPoolMinSize
 277       }),
 278       ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMaxSize') && {
 279         poolMaxSize: Configuration.getConfigurationData()?.workerPoolMaxSize
 280       })
 281     }
 282     hasOwnProp(Configuration.getConfigurationData(), 'workerPoolStrategy') &&
 283       delete Configuration.getConfigurationData()?.workerPoolStrategy
 284     const workerConfiguration: WorkerConfiguration = {
 285       ...defaultWorkerConfiguration,
 286       ...deprecatedWorkerConfiguration,
 287       ...(hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.worker) &&
 288         Configuration.getConfigurationData()?.worker)
 289     }
 290     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 291     checkWorkerProcessType(workerConfiguration.processType!)
 292     checkWorkerElementsPerWorker(workerConfiguration.elementsPerWorker)
 293     return workerConfiguration
 294   }
 295
 296   private static checkDeprecatedConfigurationKeys (): void {
 297     // connection timeout
 298     Configuration.warnDeprecatedConfigurationKey(
 299       'autoReconnectTimeout',
 300       undefined,
 301       "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead"
 302     )
 303     Configuration.warnDeprecatedConfigurationKey(
 304       'connectionTimeout',
 305       undefined,
 306       "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead"
 307     )
 308     // connection retries
 309     Configuration.warnDeprecatedConfigurationKey(
 310       'autoReconnectMaxRetries',
 311       undefined,
 312       'Use it in charging station template instead'
 313     )
 314     // station template url(s)
 315     Configuration.warnDeprecatedConfigurationKey(
 316       'stationTemplateURLs',
 317       undefined,
 318       "Use 'stationTemplateUrls' instead"
 319     )
 320     Configuration.getConfigurationData()?.['stationTemplateURLs' as keyof ConfigurationData] !==
 321       undefined &&
 322       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 323       (Configuration.getConfigurationData()!.stationTemplateUrls =
 324         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 325         Configuration.getConfigurationData()![
 326           'stationTemplateURLs' as keyof ConfigurationData
 327         ] as StationTemplateUrl[])
 328     Configuration.getConfigurationData()?.stationTemplateUrls.forEach(
 329       (stationTemplateUrl: StationTemplateUrl) => {
 330         if (stationTemplateUrl?.['numberOfStation' as keyof StationTemplateUrl] !== undefined) {
 331           console.error(
 332             `${chalk.green(logPrefix())} ${chalk.red(
 333               `Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead`
 334             )}`
 335           )
 336         }
 337       }
 338     )
 339     // supervision url(s)
 340     Configuration.warnDeprecatedConfigurationKey(
 341       'supervisionURLs',
 342       undefined,
 343       "Use 'supervisionUrls' instead"
 344     )
 345     // supervision urls distribution
 346     Configuration.warnDeprecatedConfigurationKey(
 347       'distributeStationToTenantEqually',
 348       undefined,
 349       "Use 'supervisionUrlDistribution' instead"
 350     )
 351     Configuration.warnDeprecatedConfigurationKey(
 352       'distributeStationsToTenantsEqually',
 353       undefined,
 354       "Use 'supervisionUrlDistribution' instead"
 355     )
 356     // worker section
 357     Configuration.warnDeprecatedConfigurationKey(
 358       'useWorkerPool',
 359       undefined,
 360       `Use '${ConfigurationSection.worker}' section to define the type of worker process model instead`
 361     )
 362     Configuration.warnDeprecatedConfigurationKey(
 363       'workerProcess',
 364       undefined,
 365       `Use '${ConfigurationSection.worker}' section to define the type of worker process model instead`
 366     )
 367     Configuration.warnDeprecatedConfigurationKey(
 368       'workerStartDelay',
 369       undefined,
 370       `Use '${ConfigurationSection.worker}' section to define the worker start delay instead`
 371     )
 372     Configuration.warnDeprecatedConfigurationKey(
 373       'chargingStationsPerWorker',
 374       undefined,
 375       `Use '${ConfigurationSection.worker}' section to define the number of element(s) per worker instead`
 376     )
 377     Configuration.warnDeprecatedConfigurationKey(
 378       'elementStartDelay',
 379       undefined,
 380       `Use '${ConfigurationSection.worker}' section to define the worker's element start delay instead`
 381     )
 382     Configuration.warnDeprecatedConfigurationKey(
 383       'workerPoolMinSize',
 384       undefined,
 385       `Use '${ConfigurationSection.worker}' section to define the worker pool minimum size instead`
 386     )
 387     Configuration.warnDeprecatedConfigurationKey(
 388       'workerPoolSize',
 389       undefined,
 390       `Use '${ConfigurationSection.worker}' section to define the worker pool maximum size instead`
 391     )
 392     Configuration.warnDeprecatedConfigurationKey(
 393       'workerPoolMaxSize',
 394       undefined,
 395       `Use '${ConfigurationSection.worker}' section to define the worker pool maximum size instead`
 396     )
 397     Configuration.warnDeprecatedConfigurationKey(
 398       'workerPoolStrategy',
 399       undefined,
 400       `Use '${ConfigurationSection.worker}' section to define the worker pool strategy instead`
 401     )
 402     Configuration.warnDeprecatedConfigurationKey(
 403       'poolStrategy',
 404       ConfigurationSection.worker,
 405       'Not publicly exposed to end users'
 406     )
 407     if (
 408       Configuration.getConfigurationData()?.worker?.processType ===
 409       ('staticPool' as WorkerProcessType)
 410     ) {
 411       console.error(
 412         `${chalk.green(logPrefix())} ${chalk.red(
 413           `Deprecated configuration 'staticPool' value usage in worker section 'processType' field. Use '${WorkerProcessType.fixedPool}' value instead`
 414         )}`
 415       )
 416     }
 417     // log section
 418     Configuration.warnDeprecatedConfigurationKey(
 419       'logEnabled',
 420       undefined,
 421       `Use '${ConfigurationSection.log}' section to define the logging enablement instead`
 422     )
 423     Configuration.warnDeprecatedConfigurationKey(
 424       'logFile',
 425       undefined,
 426       `Use '${ConfigurationSection.log}' section to define the log file instead`
 427     )
 428     Configuration.warnDeprecatedConfigurationKey(
 429       'logErrorFile',
 430       undefined,
 431       `Use '${ConfigurationSection.log}' section to define the log error file instead`
 432     )
 433     Configuration.warnDeprecatedConfigurationKey(
 434       'logConsole',
 435       undefined,
 436       `Use '${ConfigurationSection.log}' section to define the console logging enablement instead`
 437     )
 438     Configuration.warnDeprecatedConfigurationKey(
 439       'logStatisticsInterval',
 440       undefined,
 441       `Use '${ConfigurationSection.log}' section to define the log statistics interval instead`
 442     )
 443     Configuration.warnDeprecatedConfigurationKey(
 444       'logLevel',
 445       undefined,
 446       `Use '${ConfigurationSection.log}' section to define the log level instead`
 447     )
 448     Configuration.warnDeprecatedConfigurationKey(
 449       'logFormat',
 450       undefined,
 451       `Use '${ConfigurationSection.log}' section to define the log format instead`
 452     )
 453     Configuration.warnDeprecatedConfigurationKey(
 454       'logRotate',
 455       undefined,
 456       `Use '${ConfigurationSection.log}' section to define the log rotation enablement instead`
 457     )
 458     Configuration.warnDeprecatedConfigurationKey(
 459       'logMaxFiles',
 460       undefined,
 461       `Use '${ConfigurationSection.log}' section to define the log maximum files instead`
 462     )
 463     Configuration.warnDeprecatedConfigurationKey(
 464       'logMaxSize',
 465       undefined,
 466       `Use '${ConfigurationSection.log}' section to define the log maximum size instead`
 467     )
 468     // performanceStorage section
 469     Configuration.warnDeprecatedConfigurationKey(
 470       'URI',
 471       ConfigurationSection.performanceStorage,
 472       "Use 'uri' instead"
 473     )
 474     // uiServer section
 475     if (hasOwnProp(Configuration.getConfigurationData(), 'uiWebSocketServer')) {
 476       console.error(
 477         `${chalk.green(logPrefix())} ${chalk.red(
 478           `Deprecated configuration section 'uiWebSocketServer' usage. Use '${ConfigurationSection.uiServer}' instead`
 479         )}`
 480       )
 481     }
 482   }
 483
 484   private static warnDeprecatedConfigurationKey (
 485     key: string,
 486     sectionName?: string,
 487     logMsgToAppend = ''
 488   ): void {
 489     if (
 490       sectionName != null &&
 491       Configuration.getConfigurationData()?.[sectionName as keyof ConfigurationData] !==
 492         undefined &&
 493       (
 494         Configuration.getConfigurationData()?.[sectionName as keyof ConfigurationData] as Record<
 495         string,
 496         unknown
 497         >
 498       )?.[key] !== undefined
 499     ) {
 500       console.error(
 501         `${chalk.green(logPrefix())} ${chalk.red(
 502           `Deprecated configuration key '${key}' usage in section '${sectionName}'${
 503             logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : ''
 504           }`
 505         )}`
 506       )
 507     } else if (
 508       Configuration.getConfigurationData()?.[key as keyof ConfigurationData] !== undefined
 509     ) {
 510       console.error(
 511         `${chalk.green(logPrefix())} ${chalk.red(
 512           `Deprecated configuration key '${key}' usage${
 513             logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : ''
 514           }`
 515         )}`
 516       )
 517     }
 518   }
 519
 520   private static getConfigurationData (): ConfigurationData | undefined {
 521     if (Configuration.configurationData == null) {
 522       try {
 523         Configuration.configurationData = JSON.parse(
 524           readFileSync(Configuration.configurationFile, 'utf8')
 525         ) as ConfigurationData
 526         if (Configuration.configurationFileWatcher == null) {
 527           Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher()
 528         }
 529       } catch (error) {
 530         handleFileException(
 531           Configuration.configurationFile,
 532           FileType.Configuration,
 533           error as NodeJS.ErrnoException,
 534           logPrefix()
 535         )
 536       }
 537     }
 538     return Configuration.configurationData
 539   }
 540
 541   private static getConfigurationFileWatcher (): FSWatcher | undefined {
 542     try {
 543       return watch(Configuration.configurationFile, (event, filename): void => {
 544         if (
 545           !Configuration.configurationFileReloading &&
 546           // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 547           filename!.trim()!.length > 0 &&
 548           event === 'change'
 549         ) {
 550           Configuration.configurationFileReloading = true
 551           const consoleWarnOnce = once(console.warn, this)
 552           consoleWarnOnce(
 553             `${chalk.green(logPrefix())} ${chalk.yellow(
 554               `${FileType.Configuration} ${this.configurationFile} file have changed, reload`
 555             )}`
 556           )
 557           delete Configuration.configurationData
 558           Configuration.configurationSectionCache.clear()
 559           if (Configuration.configurationChangeCallback !== undefined) {
 560             Configuration.configurationChangeCallback()
 561               .catch((error) => {
 562                 throw typeof error === 'string' ? new Error(error) : error
 563               })
 564               .finally(() => {
 565                 Configuration.configurationFileReloading = false
 566               })
 567           } else {
 568             Configuration.configurationFileReloading = false
 569           }
 570         }
 571       })
 572     } catch (error) {
 573       handleFileException(
 574         Configuration.configurationFile,
 575         FileType.Configuration,
 576         error as NodeJS.ErrnoException,
 577         logPrefix()
 578       )
 579     }
 580   }
 581 }