PonyMirrors/philomena
1
0
Fork 0
mirror of https://github.com/philomena-dev/philomena.git synced 2025-03-17 17:10:03 +01:00
Code Issues Projects Releases Packages Wiki Activity

[Missing change] Adapt local autocompleter to the new API

Browse source
This commit is contained in:
MareStare 2025-03-14 23:29:52 +00:00
parent 76f434b039
commit caa2688c73
2 changed files with 78 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

75
assets/js/utils/__tests__/local-autocompleter.spec.ts
View file

@ -5,7 +5,6 @@ import { TextDecoder } from 'util';
describe('LocalAutocompleter', () => {
let mockData: ArrayBuffer;
const defaultK = 5;
beforeAll(async () => {
const mockDataPath = join(__dirname, 'autocomplete-compiled-v2.bin');
@ -44,59 +43,81 @@ describe('Local Autocompleter', () => {
});
});
describe('topK', () => {
describe('matchPrefix', () => {
const termStem = ['f', 'o'].join('');
let localAutocomplete: LocalAutocompleter;
beforeAll(() => {
localAutocomplete = new LocalAutocompleter(mockData);
function expectLocalAutocomplete(term: string, topK = 5) {
const localAutocomplete = new LocalAutocompleter(mockData);
const results = localAutocomplete.matchPrefix(term, topK);
const actual = results.map(result => {
const canonical = `${result.canonical} (${result.images})`;
return result.alias ? `${result.alias} -> ${canonical}` : canonical;
});
return expect(actual);
}
beforeEach(() => {
window.booru.hiddenTagList = [];
});
it('should return suggestions for exact tag name match', () => {
const result = localAutocomplete.matchPrefix('safe', defaultK);
expect(result).toEqual([expect.objectContaining({ aliasName: 'safe', name: 'safe', imageCount: 6 })]);
expectLocalAutocomplete('safe').toMatchInlineSnapshot(`
[
"safe (6)",
]
`);
});
it('should return suggestion for original tag when passed an alias', () => {
const result = localAutocomplete.matchPrefix('flowers', defaultK);
expect(result).toEqual([expect.objectContaining({ aliasName: 'flowers', name: 'flower', imageCount: 1 })]);
it('should return suggestion for an alias', () => {
expectLocalAutocomplete('flowers').toMatchInlineSnapshot(`
[
"flowers -> flower (1)",
]
`);
});
it('should prefer canonical tag over an alias when both match', () => {
expectLocalAutocomplete('flo').toMatchInlineSnapshot(`
[
"flower (1)",
]
`);
});
it('should return suggestions sorted by image count', () => {
const result = localAutocomplete.matchPrefix(termStem, defaultK);
expect(result).toEqual([
expect.objectContaining({ aliasName: 'forest', name: 'forest', imageCount: 3 }),
expect.objectContaining({ aliasName: 'fog', name: 'fog', imageCount: 1 }),
expect.objectContaining({ aliasName: 'force field', name: 'force field', imageCount: 1 }),
]);
expectLocalAutocomplete(termStem).toMatchInlineSnapshot(`
[
"forest (3)",
"fog (1)",
"force field (1)",
]
`);
});
it('should return namespaced suggestions without including namespace', () => {
const result = localAutocomplete.matchPrefix('test', defaultK);
expect(result).toEqual([
expect.objectContaining({ aliasName: 'artist:test', name: 'artist:test', imageCount: 1 }),
]);
expectLocalAutocomplete('test').toMatchInlineSnapshot(`
[
"artist:test (1)",
]
`);
});
it('should return only the required number of suggestions', () => {
const result = localAutocomplete.matchPrefix(termStem, 1);
expect(result).toEqual([expect.objectContaining({ aliasName: 'forest', name: 'forest', imageCount: 3 })]);
expectLocalAutocomplete(termStem, 1).toMatchInlineSnapshot(`
[
"forest (3)",
]
`);
});
it('should NOT return suggestions associated with hidden tags', () => {
window.booru.hiddenTagList = [1];
const result = localAutocomplete.matchPrefix(termStem, defaultK);
expect(result).toEqual([]);
expectLocalAutocomplete(termStem).toMatchInlineSnapshot(`[]`);
});
it('should return empty array for empty prefix', () => {
const result = localAutocomplete.matchPrefix('', defaultK);
expect(result).toEqual([]);
expectLocalAutocomplete('').toMatchInlineSnapshot(`[]`);
});
});
});

37
assets/js/utils/local-autocompleter.ts
View file

@ -3,9 +3,21 @@ import { UniqueHeap } from './unique-heap';
import store from './store';
export interface Result {
aliasName: string;
name: string;
imageCount: number;
/**
* If present, then this suggestion is for a tag alias.
* If absent, then this suggestion is for the `canonical` tag name.
*/
alias?: null | string;
/**
* The canonical name of the tag (non-alias).
*/
canonical: string;
/**
* Number of images tagged with this tag.
*/
images: number;
}
/**
@ -253,10 +265,19 @@ export class LocalAutocompleter {
this.scanResults(referenceToAliasIndex, namespaceMatch, hasFilteredAssociation, isAlias, results);
// Convert top K from heap into result array
return results.topK(k).map((i: TagReferenceIndex) => ({
aliasName: this.decoder.decode(this.referenceToName(i, false)),
name: this.decoder.decode(this.referenceToName(i)),
imageCount: this.getImageCount(i),
}));
return results.topK(k).map((i: TagReferenceIndex) => {
const alias = this.decoder.decode(this.referenceToName(i, false));
const canonical = this.decoder.decode(this.referenceToName(i));
const result: Result = {
canonical,
images: this.getImageCount(i),
};
if (alias !== canonical) {
result.alias = alias;
}
return result;
});
}
}