Implement disk caching for character data using node-persist

3c65b2dcf319f6af5745a661dc03a78a867b8b89

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

src/endpoints/characters.js+42 -0 Viewed

 import _ from 'lodash';
 import mime from 'mime-types';
 import jimp from 'jimp';
 +import storage from 'node-persist';
 import { AVATAR_WIDTH, AVATAR_HEIGHT } from '../constants.js';
 import { jsonParser, urlencodedParser } from '../express-common.js';

 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 diskCache = {
 +    /**
 +     * @type {import('node-persist').LocalStorage?}
 +     * @private
 +     */
 +    _instance: null,
 +    /**
 +     * Gets the disk cache instance.
 +     * @returns {Promise<import('node-persist').LocalStorage>}
 +     */
 +    instance: async function() {
 +        if (this._instance) {
 +            return this._instance;
 +        }
++
 +        const cacheDir = path.join(globalThis.DATA_ROOT, '_cache', 'characters');
 +        this._instance = storage.create({ dir: cacheDir, ttl: true });
 +        await this._instance.init();
 +        return this._instance;
 +    },
 +};
 /**
  * Reads the character card from the specified image file.

     if (memoryCache.has(cacheKey)) {
         return memoryCache.get(cacheKey);
+    }
 +    if (useDiskCache) {
 +        const cachedData = await diskCache.instance().then(i => i.getItem(cacheKey));
 +        if (cachedData) {
 +            return cachedData;
 +        }
 +    }
     const result = parse(inputFile, inputFormat);
     !isAndroid && memoryCache.set(cacheKey, result);
 +    if (useDiskCache) {
 +        await diskCache.instance().then(i => i.setItem(cacheKey, result));
 +    }
     return result;
+}

                 break;
+            }
+        }
 +        if (useDiskCache && !Buffer.isBuffer(inputFile)) {
 +            const keys = await diskCache.instance().then(i => i.keys());
 +            for (const key of keys) {
 +                if (key.startsWith(inputFile)) {
 +                    await diskCache.instance().then(i => i.removeItem(key));
 +                    break;
 +                }
 +            }
 +        }
         /**
          * Read the image, resize, and save it as a PNG into the buffer.