Merge pull request #3158 from SillyTavern/max-total-chat-backups Add maxTotalChatBackups config.yaml value

c05265d1a1c4a7b777d4a2ccd7b3e6f23426eced

Cohee <18619528+Cohee1207@users.noreply.github.com>

Signed

default/config.yaml+2 -0 Viewed

 disableChatBackup: false
 # Number of backups to keep for each chat and settings file
 numberOfBackups: 50
+# Maximum number of chat backups to keep per user (starting from the most recent). Set to -1 to keep all backups.
+maxTotalChatBackups: -1
 # Interval in milliseconds to throttle chat backups per user
 chatBackupThrottleInterval: 10000
 # Allowed hosts for card downloads

src/endpoints/chats.js+10 -2 Viewed

 import { jsonParser, urlencodedParser } from '../express-common.js';
 import { getConfigValue, humanizedISO8601DateTime, tryParse, generateTimestamp, removeOldBackups } from '../util.js';
+const isBackupDisabled = getConfigValue('disableChatBackup', false);
+const maxTotalChatBackups = Number(getConfigValue('maxTotalChatBackups', -1));
+const throttleInterval = getConfigValue('chatBackupThrottleInterval', 10_000);
 /**
  * Saves a chat to the backups directory.
  * @param {string} directory The user's backups directory.

  */
 function backupChat(directory, name, chat) {
     try {
-        const isBackupDisabled = getConfigValue('disableChatBackup', false);
         if (isBackupDisabled) {
             return;

         writeFileAtomicSync(backupFile, chat, 'utf-8');
         removeOldBackups(directory, `chat_${name}_`);
+        if (isNaN(maxTotalChatBackups) || maxTotalChatBackups < 0) {
+            return;
+        }
+        removeOldBackups(directory, 'chat_', maxTotalChatBackups);
     } catch (err) {
         console.log(`Could not backup chat for ${name}`, err);
+    }

  * @returns {function(string, string, string): void} Backup function
  */
 function getBackupFunction(handle) {
-    const throttleInterval = getConfigValue('chatBackupThrottleInterval', 10_000);
     if (!backupFunctions.has(handle)) {
         backupFunctions.set(handle, _.throttle(backupChat, throttleInterval, { leading: true, trailing: true }));
+    }

src/util.js+11 -3 Viewed

  * Remove old backups with the given prefix from a specified directory.
  * @param {string} directory The root directory to remove backups from.
  * @param {string} prefix File prefix to filter backups by.
+ * @param {number?} limit Maximum number of backups to keep. If null, the limit is determined by the `numberOfBackups` config value.
  */
-export function removeOldBackups(directory, prefix) {
+export function removeOldBackups(directory, prefix, limit = null) {
-    const MAX_BACKUPS = Number(getConfigValue('numberOfBackups', 50));
+    const MAX_BACKUPS = limit ?? Number(getConfigValue('numberOfBackups', 50));
     let files = fs.readdirSync(directory).filter(f => f.startsWith(prefix));
     if (files.length > MAX_BACKUPS) {
         files = files.map(f => path.join(directory, f));
         files.sort((a, b) => fs.statSync(a).mtimeMs - fs.statSync(b).mtimeMs);
-        fs.rmSync(files[0]);
+        while (files.length > MAX_BACKUPS) {
+            const oldest = files.shift();
+            if (!oldest) {
+                break;
+            }
+            fs.rmSync(oldest);
+        }
+    }
+}