Add config, increase cache TTL, use async file reads

684ee9816878de4e86c73901adce979dfbeb25c5

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

default/config.yaml+2 -0 Viewed

   lazyLoadCharacters: false
   # The maximum amount of memory that parsed character cards can use. Set to 0 to disable memory caching.
   memoryCacheCapacity: '100mb'
+  # Enables disk caching for character cards. Improves performances with large card libraries.
+  useDiskCache: false
 # Allow secret keys exposure via API
 allowKeysExposure: false

src/character-card-parser.js+3 -3 Viewed

  * Parses a card image and returns the character metadata.
  * @param {string} cardUrl Path to the card image
  * @param {string} format File format
- * @returns {string} Character data
+ * @returns {Promise<string>} Character data
  */
-export const parse = (cardUrl, format) => {
+export const parse = async (cardUrl, format) => {
     let fileFormat = format === undefined ? 'png' : format;
     switch (fileFormat) {
         case 'png': {
-            const buffer = fs.readFileSync(cardUrl);
+            const buffer = await fs.promises.readFile(cardUrl);
             return read(buffer);
+        }
+    }

src/endpoints/characters.js+4 -3 Viewed

 const isAndroid = process.platform === 'android';
 // Use shallow character data for the character list
 const useShallowCharacters = !!getConfigValue('performance.lazyLoadCharacters', false, 'boolean');
-const useDiskCache = true; // !!getConfigValue('performance.useDiskCache', false, 'boolean');
+const useDiskCache = !!getConfigValue('performance.useDiskCache', false, 'boolean');
 const diskCache = {
     /**

+        }
         const cacheDir = path.join(globalThis.DATA_ROOT, '_cache', 'characters');
-        this._instance = storage.create({ dir: cacheDir, ttl: true });
+        const ttl = 7 * 24 * 60 * 60 * 1000; // 7 days
+        this._instance = storage.create({ dir: cacheDir, ttl: ttl });
         await this._instance.init();
         return this._instance;
     },

@@ -73,7 +74,7 @@ async function readCharacterData(inputFile, inputFormat = 'png') {
73	}	74	}
74	}	75	}
75		76
76	const result = parse(inputFile, inputFormat);	77	const result = await parse(inputFile, inputFormat);
77	!isAndroid && memoryCache.set(cacheKey, result);	78	!isAndroid && memoryCache.set(cacheKey, result);
78	if (useDiskCache) {	79	if (useDiskCache) {
79	await diskCache.instance().then(i => i.setItem(cacheKey, result));	80	await diskCache.instance().then(i => i.setItem(cacheKey, result));