import { type FSWatcher, readFileSync, watch } from 'node:fs';
import { dirname, join, resolve } from 'node:path';
+import { env } from 'node:process';
import { fileURLToPath } from 'node:url';
import chalk from 'chalk';
| WorkerConfiguration
| UIServerConfiguration;
+// Avoid ESM race condition at class initialization
+const configurationLogPrefix = (): string => {
+ return logPrefix(' Simulator configuration |');
+};
+
export class Configuration {
+ public static configurationChangeCallback: () => Promise<void>;
+
private static configurationFile = join(
dirname(fileURLToPath(import.meta.url)),
'assets',
'config.json',
);
+ private static configurationFileReloading = false;
private static configurationData?: ConfigurationData;
private static configurationFileWatcher?: FSWatcher;
private static configurationSectionCache = new Map<
[ConfigurationSection.uiServer, Configuration.buildUIServerSection()],
]);
- private static configurationChangeCallback?: () => Promise<void>;
-
private constructor() {
// This is intentional
}
- public static setConfigurationChangeCallback(cb: () => Promise<void>): void {
- Configuration.configurationChangeCallback = cb;
- }
-
public static getConfigurationSection<T extends ConfigurationSectionType>(
sectionName: ConfigurationSection,
): T {
}
public static workerPoolInUse(): boolean {
- return [WorkerProcessType.dynamicPool, WorkerProcessType.staticPool].includes(
+ return [WorkerProcessType.dynamicPool, WorkerProcessType.fixedPool].includes(
Configuration.getConfigurationSection<WorkerConfiguration>(ConfigurationSection.worker)
.processType!,
);
);
}
- private static logPrefix = (): string => {
- return logPrefix(' Simulator configuration |');
- };
-
private static isConfigurationSectionCached(sectionName: ConfigurationSection): boolean {
return Configuration.configurationSectionCache.has(sectionName);
}
}
if (isCFEnvironment() === true) {
delete uiServerConfiguration.options?.host;
- uiServerConfiguration.options!.port = parseInt(process.env.PORT!);
+ uiServerConfiguration.options!.port = parseInt(env.PORT!);
}
return uiServerConfiguration;
}
(stationTemplateUrl: StationTemplateUrl) => {
if (!isUndefined(stationTemplateUrl?.['numberOfStation' as keyof StationTemplateUrl])) {
console.error(
- `${chalk.green(Configuration.logPrefix())} ${chalk.red(
+ `${chalk.green(configurationLogPrefix())} ${chalk.red(
`Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead`,
)}`,
);
`Use '${ConfigurationSection.worker}' section to define the worker pool minimum size instead`,
);
Configuration.warnDeprecatedConfigurationKey(
- 'workerPoolSize;',
+ 'workerPoolSize',
undefined,
`Use '${ConfigurationSection.worker}' section to define the worker pool maximum size instead`,
);
Configuration.warnDeprecatedConfigurationKey(
- 'workerPoolMaxSize;',
+ 'workerPoolMaxSize',
undefined,
`Use '${ConfigurationSection.worker}' section to define the worker pool maximum size instead`,
);
Configuration.warnDeprecatedConfigurationKey(
- 'workerPoolStrategy;',
+ 'workerPoolStrategy',
undefined,
`Use '${ConfigurationSection.worker}' section to define the worker pool strategy instead`,
);
ConfigurationSection.worker,
'Not publicly exposed to end users',
);
+ if (
+ Configuration.getConfigurationData()?.worker?.processType ===
+ ('staticPool' as WorkerProcessType)
+ ) {
+ console.error(
+ `${chalk.green(configurationLogPrefix())} ${chalk.red(
+ `Deprecated configuration 'staticPool' value usage in worker section 'processType' field. Use '${WorkerProcessType.fixedPool}' value instead`,
+ )}`,
+ );
+ }
// log section
Configuration.warnDeprecatedConfigurationKey(
'logEnabled',
// uiServer section
if (hasOwnProp(Configuration.getConfigurationData(), 'uiWebSocketServer')) {
console.error(
- `${chalk.green(Configuration.logPrefix())} ${chalk.red(
+ `${chalk.green(configurationLogPrefix())} ${chalk.red(
`Deprecated configuration section 'uiWebSocketServer' usage. Use '${ConfigurationSection.uiServer}' instead`,
)}`,
);
)
) {
console.error(
- `${chalk.green(Configuration.logPrefix())} ${chalk.red(
+ `${chalk.green(configurationLogPrefix())} ${chalk.red(
`Deprecated configuration key '${key}' usage in section '${sectionName}'${
logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : ''
}`,
!isUndefined(Configuration.getConfigurationData()?.[key as keyof ConfigurationData])
) {
console.error(
- `${chalk.green(Configuration.logPrefix())} ${chalk.red(
+ `${chalk.green(configurationLogPrefix())} ${chalk.red(
`Deprecated configuration key '${key}' usage${
logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : ''
}`,
Configuration.configurationFile,
FileType.Configuration,
error as NodeJS.ErrnoException,
- Configuration.logPrefix(),
+ configurationLogPrefix(),
);
}
}
private static getConfigurationFileWatcher(): FSWatcher | undefined {
try {
return watch(Configuration.configurationFile, (event, filename): void => {
- if (filename!.trim()!.length > 0 && event === 'change') {
+ if (
+ !Configuration.configurationFileReloading &&
+ filename!.trim()!.length > 0 &&
+ event === 'change'
+ ) {
+ Configuration.configurationFileReloading = true;
+ const consoleWarnOnce = once(console.warn, this);
+ consoleWarnOnce(
+ `${chalk.green(configurationLogPrefix())} ${chalk.yellow(
+ `${FileType.Configuration} ${this.configurationFile} file have changed, reload`,
+ )}`,
+ );
delete Configuration.configurationData;
Configuration.configurationSectionCache.clear();
if (!isUndefined(Configuration.configurationChangeCallback)) {
- Configuration.configurationChangeCallback!().catch((error) => {
- throw typeof error === 'string' ? new Error(error) : error;
- });
+ Configuration.configurationChangeCallback()
+ .catch((error) => {
+ throw typeof error === 'string' ? new Error(error) : error;
+ })
+ .finally(() => {
+ Configuration.configurationFileReloading = false;
+ });
+ } else {
+ Configuration.configurationFileReloading = false;
}
}
});
Configuration.configurationFile,
FileType.Configuration,
error as NodeJS.ErrnoException,
- Configuration.logPrefix(),
+ configurationLogPrefix(),
);
}
}