Merge pull request #3106 from joenunezb/optimize/improve-search perf(search): improve fuzzy character search performance by ~13x (4.5s → 350ms)

c3c16ea0d61802f610f7164a7cf004d9ecc49e8a

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

Signed

Parents: 8b7a14f895399764b7eda0cbab65a88def16fd1a f4ef9697e983a0bb0b3b0ab6388f5ecbfe37898e

public/script.js+4 -3 Viewed

             subEntities = filterByTagState(entities, { subForEntity: entity });
             if (doFilter) {
                 // sub entities filter "hacked" because folder filter should not be applied there, so even in "only folders" mode characters show up
-                subEntities = entitiesFilter.applyFilters(subEntities, { clearScoreCache: false, tempOverrides: { [FILTER_TYPES.FOLDER]: FILTER_STATES.UNDEFINED } });
+                subEntities = entitiesFilter.applyFilters(subEntities, { clearScoreCache: false, tempOverrides: { [FILTER_TYPES.FOLDER]: FILTER_STATES.UNDEFINED }, clearFuzzySearchCaches: false });
+            }
             if (doSort) {
                 sortEntitiesList(subEntities);

@@ -1634,11 +1634,11 @@ export function getEntitiesList({ doFilter = false, doSort = true } = {}) {
1634	// Second run filters, hiding whatever should be filtered later	1634	// Second run filters, hiding whatever should be filtered later
1635	if (doFilter) {	1635	if (doFilter) {
1636	const beforeFinalEntities = filterByTagState(entities, { globalDisplayFilters: true });	1636	const beforeFinalEntities = filterByTagState(entities, { globalDisplayFilters: true });
1637	entities = entitiesFilter.applyFilters(beforeFinalEntities);	1637	entities = entitiesFilter.applyFilters(beforeFinalEntities, { clearFuzzySearchCaches: false });
1638		1638
1639	// Magic for folder filter. If that one is enabled, and no folders are display anymore, we remove that filter to actually show the characters.	1639	// Magic for folder filter. If that one is enabled, and no folders are display anymore, we remove that filter to actually show the characters.
1640	if (isFilterState(entitiesFilter.getFilterData(FILTER_TYPES.FOLDER), FILTER_STATES.SELECTED) && entities.filter(x => x.type == 'tag').length == 0) {	1640	if (isFilterState(entitiesFilter.getFilterData(FILTER_TYPES.FOLDER), FILTER_STATES.SELECTED) && entities.filter(x => x.type == 'tag').length == 0) {
1641	entities = entitiesFilter.applyFilters(beforeFinalEntities, { tempOverrides: { [FILTER_TYPES.FOLDER]: FILTER_STATES.UNDEFINED } });	1641	entities = entitiesFilter.applyFilters(beforeFinalEntities, { tempOverrides: { [FILTER_TYPES.FOLDER]: FILTER_STATES.UNDEFINED }, clearFuzzySearchCaches: false });
1642	}	1642	}
1643	}	1643	}
1644		1644

@@ -1654,6 +1654,7 @@ export function getEntitiesList({ doFilter = false, doSort = true } = {}) {
1654	if (doSort) {	1654	if (doSort) {
1655	sortEntitiesList(entities);	1655	sortEntitiesList(entities);
1656	}	1656	}
		1657	entitiesFilter.clearFuzzySearchCaches();
1657	return entities;	1658	return entities;
1658	}	1659	}
1659		1660

public/scripts/filters.js+45 -6 Viewed

+}
 /**
+ * The fuzzy search categories
+ * @type {{ characters: string, worldInfo: string, personas: string, tags: string, groups: string }}
+ */
+export const fuzzySearchCategories = Object.freeze({
+    characters: 'characters',
+    worldInfo: 'worldInfo',
+    personas: 'personas',
+    tags: 'tags',
+    groups: 'groups',
+});
+/**
  * Helper class for filtering data.
  * @example
  * const filterHelper = new FilterHelper(() => console.log('data changed'));

     scoreCache;
     /**
+     * Cache for fuzzy search results per category.
+     * @type {Object.<string, { resultMap: Map<string, any> }>}
+     */
+    fuzzySearchCaches;
+    /**
      * Creates a new FilterHelper
      * @param {Function} onDataChanged Callback to trigger when the filter data changes
      */
     constructor(onDataChanged) {
         this.onDataChanged = onDataChanged;
         this.scoreCache = new Map();
+        this.fuzzySearchCaches = {
+            [fuzzySearchCategories.characters]: { resultMap: new Map() },
+            [fuzzySearchCategories.worldInfo]: { resultMap: new Map() },
+            [fuzzySearchCategories.personas]: { resultMap: new Map() },
+            [fuzzySearchCategories.tags]: { resultMap: new Map() },
+            [fuzzySearchCategories.groups]: { resultMap: new Map() },
+        };
+    }
     /**

             return data;
+        }
-        const fuzzySearchResults = fuzzySearchWorldInfo(data, term);
+        const fuzzySearchResults = fuzzySearchWorldInfo(data, term, this.fuzzySearchCaches);
         this.cacheScores(FILTER_TYPES.WORLD_INFO_SEARCH, new Map(fuzzySearchResults.map(i => [i.item?.uid, i.score])));
         const filteredData = data.filter(entity => fuzzySearchResults.find(x => x.item === entity));

             return data;
+        }
-        const fuzzySearchResults = fuzzySearchPersonas(data, term);
+        const fuzzySearchResults = fuzzySearchPersonas(data, term, this.fuzzySearchCaches);
         this.cacheScores(FILTER_TYPES.PERSONA_SEARCH, new Map(fuzzySearchResults.map(i => [i.item.key, i.score])));
         const filteredData = data.filter(name => fuzzySearchResults.find(x => x.item.key === name));

         // Save fuzzy search results and scores if enabled
         if (power_user.fuzzy_search) {
-            const fuzzySearchCharactersResults = fuzzySearchCharacters(searchValue);
+            const fuzzySearchCharactersResults = fuzzySearchCharacters(searchValue, this.fuzzySearchCaches);
-            const fuzzySearchGroupsResults = fuzzySearchGroups(searchValue);
+            const fuzzySearchGroupsResults = fuzzySearchGroups(searchValue, this.fuzzySearchCaches);
-            const fuzzySearchTagsResult = fuzzySearchTags(searchValue);
+            const fuzzySearchTagsResult = fuzzySearchTags(searchValue, this.fuzzySearchCaches);
             this.cacheScores(FILTER_TYPES.SEARCH, new Map(fuzzySearchCharactersResults.map(i => [`character.${i.refIndex}`, i.score])));
             this.cacheScores(FILTER_TYPES.SEARCH, new Map(fuzzySearchGroupsResults.map(i => [`group.${i.item.id}`, i.score])));
             this.cacheScores(FILTER_TYPES.SEARCH, new Map(fuzzySearchTagsResult.map(i => [`tag.${i.item.id}`, i.score])));

      * @param {object} options - Optional call parameters
      * @param {boolean} [options.clearScoreCache=true] - Whether the score cache should be cleared.
      * @param {Object.<FilterType, any>} [options.tempOverrides={}] - Temporarily override specific filters for this filter application
+     * @param {boolean} [options.clearFuzzySearchCaches=true] - Whether the fuzzy search caches should be cleared.
      * @returns {any[]} The filtered data.
      */
-    applyFilters(data, { clearScoreCache = true, tempOverrides = {} } = {}) {
+    applyFilters(data, { clearScoreCache = true, tempOverrides = {}, clearFuzzySearchCaches = true } = {}) {
         if (clearScoreCache) this.clearScoreCache();
+        if (clearFuzzySearchCaches) this.clearFuzzySearchCaches();
         // Save original filter states
         const originalStates = {};
         for (const key in tempOverrides) {

@@ -411,4 +440,14 @@ export class FilterHelper {
411	this.scoreCache = new Map();	440	this.scoreCache = new Map();
412	}	441	}
413	}	442	}
		443
		444	/**
		445	* Clears fuzzy search caches
		446	*/
		447	clearFuzzySearchCaches() {
		448	for (const cache of Object.values(this.fuzzySearchCaches)) {
		449	cache.resultMap.clear();
		450	}
		451	console.log('All fuzzy search caches cleared');
		452	}
414	}	453	}

public/scripts/power-user.js+69 -66 Viewed

 import { commonEnumProviders, enumIcons } from './slash-commands/SlashCommandCommonEnumsProvider.js';
 import { POPUP_TYPE, callGenericPopup } from './popup.js';
 import { loadSystemPrompts } from './sysprompt.js';
+import { fuzzySearchCategories } from './filters.js';
 export {
     loadPowerUserSettings,

     });
+}
 /**
- * Fuzzy search characters by a search term
+ * Common function to perform fuzzy search with optional caching
+ * @param {string} type - Type of search from fuzzySearchCategories
+ * @param {any[]} data - Data array to search in
+ * @param {Array<{name: string, weight: number, getFn?: Function}>} keys - Fuse.js keys configuration
  * @param {string} searchValue - The search term
+ * @param {Object.<string, { resultMap: Map<string, any> }>} [fuzzySearchCaches=null] - Optional fuzzy search caches
  * @returns {import('fuse.js').FuseResult<any>[]} Results as items with their score
  */
-export function fuzzySearchCharacters(searchValue) {
+function performFuzzySearch(type, data, keys, searchValue, fuzzySearchCaches = null) {
+    // Check cache if provided
+    if (fuzzySearchCaches) {
+        const cache = fuzzySearchCaches[type];
+        if (cache?.resultMap.has(searchValue)) {
+            return cache.resultMap.get(searchValue);
+        }
+    }
     // @ts-ignore
-    const fuse = new Fuse(characters, {
+    const fuse = new Fuse(data, {
-        keys: [
+        keys: keys,
+        includeScore: true,
+        ignoreLocation: true,
+        useExtendedSearch: true,
+        threshold: 0.2,
+    });
+    const results = fuse.search(searchValue);
+    // Store in cache if provided
+    if (fuzzySearchCaches) {
+        fuzzySearchCaches[type].resultMap.set(searchValue, results);
+    }
+    return results;
+}
+/**
+ * Fuzzy search characters by a search term
+ * @param {string} searchValue - The search term
+ * @param {Object.<string, { resultMap: Map<string, any> }>} [fuzzySearchCaches=null] - Optional fuzzy search caches
+ * @returns {import('fuse.js').FuseResult<any>[]} Results as items with their score
+ */
+export function fuzzySearchCharacters(searchValue, fuzzySearchCaches = null) {
+    const keys = [
         { name: 'data.name', weight: 20 },
         { name: '#tags', weight: 10, getFn: (character) => getTagsList(character.avatar).map(x => x.name).join('||') },
         { name: 'data.description', weight: 3 },

         { name: 'data.creator', weight: 1 },
         { name: 'data.tags', weight: 1 },
         { name: 'data.alternate_greetings', weight: 1 },
-        ],
+    ];
-        includeScore: true,
-        ignoreLocation: true,
-        useExtendedSearch: true,
-        threshold: 0.2,
-    });
-    const results = fuse.search(searchValue);
+    return performFuzzySearch(fuzzySearchCategories.characters, characters, keys, searchValue, fuzzySearchCaches);
-    console.debug('Characters fuzzy search results for ' + searchValue, results);
-    return results;
+}
 /**
  * Fuzzy search world info entries by a search term
  * @param {*[]} data - WI items data array
  * @param {string} searchValue - The search term
+ * @param {Object.<string, { resultMap: Map<string, any> }>} [fuzzySearchCaches=null] - Optional fuzzy search caches
  * @returns {import('fuse.js').FuseResult<any>[]} Results as items with their score
  */
-export function fuzzySearchWorldInfo(data, searchValue) {
+export function fuzzySearchWorldInfo(data, searchValue, fuzzySearchCaches = null) {
-    // @ts-ignore
+    const keys = [
-    const fuse = new Fuse(data, {
-        keys: [
         { name: 'key', weight: 20 },
         { name: 'group', weight: 15 },
         { name: 'comment', weight: 10 },

         { name: 'content', weight: 3 },
         { name: 'uid', weight: 1 },
         { name: 'automationId', weight: 1 },
-        ],
+    ];
-        includeScore: true,
-        ignoreLocation: true,
-        useExtendedSearch: true,
-        threshold: 0.2,
-    });
-    const results = fuse.search(searchValue);
+    return performFuzzySearch(fuzzySearchCategories.worldInfo, data, keys, searchValue, fuzzySearchCaches);
-    console.debug('World Info fuzzy search results for ' + searchValue, results);
-    return results;
+}
 /**
  * Fuzzy search persona entries by a search term
  * @param {*[]} data - persona data array
  * @param {string} searchValue - The search term
+ * @param {Object.<string, { resultMap: Map<string, any> }>} [fuzzySearchCaches=null] - Optional fuzzy search caches
  * @returns {import('fuse.js').FuseResult<any>[]} Results as items with their score
  */
-export function fuzzySearchPersonas(data, searchValue) {
+export function fuzzySearchPersonas(data, searchValue, fuzzySearchCaches = null) {
-    data = data.map(x => ({ key: x, name: power_user.personas[x] ?? '', description: power_user.persona_descriptions[x]?.description ?? '' }));
+    const mappedData = data.map(x => ({
-    // @ts-ignore
+        key: x,
-    const fuse = new Fuse(data, {
+        name: power_user.personas[x] ?? '',
-        keys: [
+        description: power_user.persona_descriptions[x]?.description ?? ''
+    }));
+    const keys = [
         { name: 'name', weight: 20 },
         { name: 'description', weight: 3 },
-        ],
+    ];
-        includeScore: true,
-        ignoreLocation: true,
-        useExtendedSearch: true,
-        threshold: 0.2,
-    });
-    const results = fuse.search(searchValue);
+    return performFuzzySearch(fuzzySearchCategories.personas, mappedData, keys, searchValue, fuzzySearchCaches);
-    console.debug('Personas fuzzy search results for ' + searchValue, results);
-    return results;
+}
 /**
  * Fuzzy search tags by a search term
  * @param {string} searchValue - The search term
+ * @param {Object.<string, { resultMap: Map<string, any> }>} [fuzzySearchCaches=null] - Optional fuzzy search caches
  * @returns {import('fuse.js').FuseResult<any>[]} Results as items with their score
  */
-export function fuzzySearchTags(searchValue) {
+export function fuzzySearchTags(searchValue, fuzzySearchCaches = null) {
-    // @ts-ignore
+    const keys = [
-    const fuse = new Fuse(tags, {
-        keys: [
         { name: 'name', weight: 1 },
-        ],
+    ];
-        includeScore: true,
-        ignoreLocation: true,
-        useExtendedSearch: true,
-        threshold: 0.2,
-    });
-    const results = fuse.search(searchValue);
+    return performFuzzySearch(fuzzySearchCategories.tags, tags, keys, searchValue, fuzzySearchCaches);
-    console.debug('Tags fuzzy search results for ' + searchValue, results);
-    return results;
+}
 /**
  * Fuzzy search groups by a search term
  * @param {string} searchValue - The search term
+ * @param {Object.<string, { resultMap: Map<string, any> }>} [fuzzySearchCaches=null] - Optional fuzzy search caches
  * @returns {import('fuse.js').FuseResult<any>[]} Results as items with their score
  */
-export function fuzzySearchGroups(searchValue) {
+export function fuzzySearchGroups(searchValue, fuzzySearchCaches = null) {
-    // @ts-ignore
+    const keys = [
-    const fuse = new Fuse(groups, {
-        keys: [
         { name: 'name', weight: 20 },
         { name: 'members', weight: 15 },
         { name: '#tags', weight: 10, getFn: (group) => getTagsList(group.id).map(x => x.name).join('||') },
         { name: 'id', weight: 1 },
-        ],
+    ];
-        includeScore: true,
-        ignoreLocation: true,
-        useExtendedSearch: true,
-        threshold: 0.2,
-    });
-    const results = fuse.search(searchValue);
+    return performFuzzySearch(fuzzySearchCategories.groups, groups, keys, searchValue, fuzzySearchCaches);
-    console.debug('Groups fuzzy search results for ' + searchValue, results);
-    return results;
+}
 /**