pengjunjie/server
1
0
Fork 1
mirror of https://github.com/ONLYOFFICE/server.git synced 2026-04-07 14:04:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

[bug] Debounces multiple events to prevent excessive reloads in handleConfigFileChange; Fix bug 77160

Browse Source
This commit is contained in:
Sergey Konovalov
2025-10-01 12:19:27 +03:00
parent a8356eda6b
commit d3e0571099
1 changed files with 28 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
Common/sources/runtimeConfigManager.js
View File

@ -47,6 +47,10 @@ const configFileName = path.basename(configFilePath);
// Initialize cache with TTL and check for expired keys every minute
const nodeCache = new NodeCache(cfgRuntimeConfig.cache);
// Debounce timer to wait for file write completion
let reloadTimer = null;
const RELOAD_DEBOUNCE_MS = 200;
/**
* Get runtime configuration for the current context
* @param {operationContext} ctx - Operation context
@ -99,25 +103,41 @@ async function saveConfig(ctx, config) {
}
/**
* Supports both fs.watch (eventType, filename) and fs.watchFile (current, previous) callbacks
* Handle config file change event from fs.watch or fs.watchFile
* Debounces multiple events to prevent excessive reloads during file write
* @param {string|fs.Stats} eventTypeOrCurrent - Event type for fs.watch or current stats for fs.watchFile
* @param {string|fs.Stats} filenameOrPrevious - Filename for fs.watch or previous stats for fs.watchFile
*/
function handleConfigFileChange(eventTypeOrCurrent, filenameOrPrevious) {
try {
let shouldReload = false;
if (typeof eventTypeOrCurrent === 'object' && eventTypeOrCurrent.isFile) {
// fs.watchFile callback: (current, previous)
shouldReload = eventTypeOrCurrent.mtime !== filenameOrPrevious.mtime;
operationContext.global.logger.info(`handleConfigFileChange reloaded=${shouldReload} watchFile: ${configFileName}`);
} else {
// fs.watch callback: (eventType, filename)
shouldReload = configFileName === filenameOrPrevious;
operationContext.global.logger.info(`handleConfigFileChange reloaded=${shouldReload} watch ${eventTypeOrCurrent}: ${filenameOrPrevious}`);
}
if (shouldReload) {
nodeCache.del(configFileName);
// Reload config and update logging level
getConfig(operationContext.global).then(config => {
logger.configureLogger(config?.log?.options);
});
// Clear timer and wait for file write to complete
if (reloadTimer) {
clearTimeout(reloadTimer);
}
reloadTimer = setTimeout(() => {
reloadTimer = null;
nodeCache.del(configFileName);
operationContext.global.logger.info(`handleConfigFileChange reloading config: ${configFileName}`);
getConfig(operationContext.global)
.then(config => {
logger.configureLogger(config?.log?.options);
})
.catch(err => {
operationContext.global.logger.error(`handleConfigFileChange reload error: ${err.message}`);
});
}, RELOAD_DEBOUNCE_MS);
}
} catch (err) {
operationContext.global.logger.error(`handleConfigFileChange error: ${err.message}`);