[Refactor] Extract fuse search class as a separate file (#3274)

This commit is contained in:
Chenlei Hu
2025-03-29 12:04:29 -04:00
committed by GitHub
parent 4a40e83b98
commit 3922a5882b
2 changed files with 146 additions and 132 deletions

View File

@@ -1,7 +1,8 @@
import Fuse, { FuseSearchOptions, IFuseOptions } from 'fuse.js'
import { FuseSearchOptions, IFuseOptions } from 'fuse.js'
import _ from 'lodash'
import { ComfyNodeDefImpl } from '@/stores/nodeDefStore'
import { FuseSearch } from '@/utils/fuseUtil'
export type SearchAuxScore = number[]
@@ -9,130 +10,6 @@ interface ExtraSearchOptions {
matchWildcards?: boolean
}
export class FuseSearch<T> {
public readonly fuse: Fuse<T>
public readonly keys: string[]
public readonly data: T[]
public readonly advancedScoring: boolean
constructor(
data: T[],
options?: IFuseOptions<T>,
createIndex: boolean = true,
advancedScoring: boolean = false
) {
this.data = data
// @ts-expect-error fixme ts strict error
this.keys = (options.keys ?? []) as string[]
this.advancedScoring = advancedScoring
const index =
createIndex && options?.keys
? Fuse.createIndex(options.keys, data)
: undefined
this.fuse = new Fuse(data, options, index)
}
public search(query: string, options?: FuseSearchOptions): T[] {
const fuseResult = !query
? this.data.map((x) => ({ item: x, score: 0 }))
: this.fuse.search(query, options)
if (!this.advancedScoring) {
return fuseResult.map((x) => x.item)
}
const aux = fuseResult
.map((x) => ({
item: x.item,
// @ts-expect-error fixme ts strict error
scores: this.calcAuxScores(query.toLocaleLowerCase(), x.item, x.score)
}))
.sort((a, b) => this.compareAux(a.scores, b.scores))
return aux.map((x) => x.item)
}
public calcAuxScores(query: string, entry: T, score: number): SearchAuxScore {
let values: string[] = []
if (!this.keys.length) values = [entry as string]
// @ts-expect-error fixme ts strict error
else values = this.keys.map((x) => entry[x])
const scores = values.map((x) => this.calcAuxSingle(query, x, score))
let result = scores.sort(this.compareAux)[0]
const deprecated = values.some((x) =>
x.toLocaleLowerCase().includes('deprecated')
)
result[0] += deprecated && result[0] != 0 ? 5 : 0
// @ts-expect-error fixme ts strict error
if (entry['postProcessSearchScores']) {
// @ts-expect-error fixme ts strict error
result = entry['postProcessSearchScores'](result) as SearchAuxScore
}
return result
}
public calcAuxSingle(
query: string,
item: string,
score: number
): SearchAuxScore {
const itemWords = item
.split(/ |\b|(?<=[a-z])(?=[A-Z])|(?=[A-Z][a-z])/)
.map((x) => x.toLocaleLowerCase())
const queryParts = query.split(' ')
item = item.toLocaleLowerCase()
let main = 9
let aux1 = 0
let aux2 = 0
if (item == query) {
main = 0
} else if (item.startsWith(query)) {
main = 1
aux2 = item.length
} else if (itemWords.includes(query)) {
main = 2
aux1 = item.indexOf(query) + item.length * 0.5
aux2 = item.length
} else if (item.includes(query)) {
main = 3
aux1 = item.indexOf(query) + item.length * 0.5
aux2 = item.length
} else if (queryParts.every((x) => itemWords.includes(x))) {
const indexes = queryParts.map((x) => itemWords.indexOf(x))
const min = Math.min(...indexes)
const max = Math.max(...indexes)
main = 4
aux1 = max - min + max * 0.5 + item.length * 0.5
aux2 = item.length
} else if (queryParts.every((x) => item.includes(x))) {
const min = Math.min(...queryParts.map((x) => item.indexOf(x)))
const max = Math.max(...queryParts.map((x) => item.indexOf(x) + x.length))
main = 5
aux1 = max - min + max * 0.5 + item.length * 0.5
aux2 = item.length
}
const lengthPenalty =
0.2 *
(1 -
Math.min(item.length, query.length) /
Math.max(item.length, query.length))
return [main, aux1, aux2, score + lengthPenalty]
}
public compareAux(a: SearchAuxScore, b: SearchAuxScore) {
for (let i = 0; i < Math.min(a.length, b.length); i++) {
if (a[i] !== b[i]) {
return a[i] - b[i]
}
}
return a.length - b.length
}
}
export type FilterAndValue<T = string> = [NodeFilter<T>, T]
export class NodeFilter<FilterOptionT = string> {
@@ -149,7 +26,9 @@ export class NodeFilter<FilterOptionT = string> {
nodeDefs: ComfyNodeDefImpl[],
options?: IFuseOptions<FilterOptionT>
) {
this.fuseSearch = new FuseSearch(this.getAllNodeOptions(nodeDefs), options)
this.fuseSearch = new FuseSearch(this.getAllNodeOptions(nodeDefs), {
fuseOptions: options
})
}
public getNodeOptions(node: ComfyNodeDefImpl): FilterOptionT[] {
@@ -192,18 +71,17 @@ export class NodeSearchService {
public readonly nodeFilters: NodeFilter<string>[]
constructor(data: ComfyNodeDefImpl[]) {
this.nodeFuseSearch = new FuseSearch(
data,
{
this.nodeFuseSearch = new FuseSearch(data, {
fuseOptions: {
keys: ['name', 'display_name'],
includeScore: true,
threshold: 0.3,
shouldSort: false,
useExtendedSearch: true
},
true,
true
)
createIndex: true,
advancedScoring: true
})
const filterSearchOptions = {
includeScore: true,

136
src/utils/fuseUtil.ts Normal file
View File

@@ -0,0 +1,136 @@
import Fuse, { FuseOptionKey, FuseSearchOptions, IFuseOptions } from 'fuse.js'
type SearchAuxScore = number[]
/**
* A wrapper around Fuse.js that provides a more type-safe API.
*/
export class FuseSearch<T> {
public readonly fuse: Fuse<T>
public readonly keys: FuseOptionKey<T>[]
public readonly data: T[]
public readonly advancedScoring: boolean
constructor(
data: T[],
options: {
fuseOptions?: IFuseOptions<T>
createIndex?: boolean
advancedScoring?: boolean
}
) {
const { fuseOptions, createIndex = true, advancedScoring = false } = options
this.data = data
this.keys = fuseOptions?.keys ?? []
this.advancedScoring = advancedScoring
const index =
createIndex && this.keys.length
? Fuse.createIndex(this.keys, data)
: undefined
this.fuse = new Fuse(data, fuseOptions, index)
}
public search(query: string, options?: FuseSearchOptions): T[] {
const fuseResult = !query
? this.data.map((x) => ({ item: x, score: 0 }))
: this.fuse.search(query, options)
if (!this.advancedScoring) {
return fuseResult.map((x) => x.item)
}
const aux = fuseResult
.map((x) => ({
item: x.item,
scores: this.calcAuxScores(
query.toLocaleLowerCase(),
x.item,
x.score ?? 0
)
}))
.sort((a, b) => this.compareAux(a.scores, b.scores))
return aux.map((x) => x.item)
}
public calcAuxScores(query: string, entry: T, score: number): SearchAuxScore {
let values: string[] = []
if (!this.keys.length) values = [entry as string]
// @ts-expect-error fixme ts strict error
else values = this.keys.map((x) => entry[x])
const scores = values.map((x) => this.calcAuxSingle(query, x, score))
let result = scores.sort(this.compareAux)[0]
const deprecated = values.some((x) =>
x.toLocaleLowerCase().includes('deprecated')
)
result[0] += deprecated && result[0] != 0 ? 5 : 0
// @ts-expect-error fixme ts strict error
if (entry['postProcessSearchScores']) {
// @ts-expect-error fixme ts strict error
result = entry['postProcessSearchScores'](result) as SearchAuxScore
}
return result
}
public calcAuxSingle(
query: string,
item: string,
score: number
): SearchAuxScore {
const itemWords = item
.split(/ |\b|(?<=[a-z])(?=[A-Z])|(?=[A-Z][a-z])/)
.map((x) => x.toLocaleLowerCase())
const queryParts = query.split(' ')
item = item.toLocaleLowerCase()
let main = 9
let aux1 = 0
let aux2 = 0
if (item == query) {
main = 0
} else if (item.startsWith(query)) {
main = 1
aux2 = item.length
} else if (itemWords.includes(query)) {
main = 2
aux1 = item.indexOf(query) + item.length * 0.5
aux2 = item.length
} else if (item.includes(query)) {
main = 3
aux1 = item.indexOf(query) + item.length * 0.5
aux2 = item.length
} else if (queryParts.every((x) => itemWords.includes(x))) {
const indexes = queryParts.map((x) => itemWords.indexOf(x))
const min = Math.min(...indexes)
const max = Math.max(...indexes)
main = 4
aux1 = max - min + max * 0.5 + item.length * 0.5
aux2 = item.length
} else if (queryParts.every((x) => item.includes(x))) {
const min = Math.min(...queryParts.map((x) => item.indexOf(x)))
const max = Math.max(...queryParts.map((x) => item.indexOf(x) + x.length))
main = 5
aux1 = max - min + max * 0.5 + item.length * 0.5
aux2 = item.length
}
const lengthPenalty =
0.2 *
(1 -
Math.min(item.length, query.length) /
Math.max(item.length, query.length))
return [main, aux1, aux2, score + lengthPenalty]
}
public compareAux(a: SearchAuxScore, b: SearchAuxScore) {
for (let i = 0; i < Math.min(a.length, b.length); i++) {
if (a[i] !== b[i]) {
return a[i] - b[i]
}
}
return a.length - b.length
}
}