PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

fixup! Extend QueryMatcher's sorting heuristic

Browse source
This commit is contained in:
Mike Pennisi 2020-06-18 13:24:02 -04:00
parent 6af4d82ce7
commit 4ffc54d143
1 changed files with 23 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
src/autocomplete/QueryMatcher.ts
View file

@ -17,7 +17,6 @@ limitations under the License.
*/ */
import _at from 'lodash/at'; import _at from 'lodash/at';
import _flatMap from 'lodash/flatMap';
import _uniq from 'lodash/uniq'; import _uniq from 'lodash/uniq';
function stripDiacritics(str: string): string { function stripDiacritics(str: string): string {
@ -49,7 +48,7 @@ export default class QueryMatcher<T extends Object> {
private _options: IOptions<T>; private _options: IOptions<T>;
private _keys: IOptions<T>["keys"]; private _keys: IOptions<T>["keys"];
private _funcs: Required<IOptions<T>["funcs"]>; private _funcs: Required<IOptions<T>["funcs"]>;
private _items: Map<{value: string, weight: number}, T[]>; private _items: Map<string, {object: T, keyWeight: number}[]>;
constructor(objects: T[], options: IOptions<T> = { keys: [] }) { constructor(objects: T[], options: IOptions<T> = { keys: [] }) {
this._options = options; this._options = options;
@ -87,14 +86,14 @@ export default class QueryMatcher<T extends Object> {
for (const [index, keyValue] of Object.entries(keyValues)) { for (const [index, keyValue] of Object.entries(keyValues)) {
if (!keyValue) continue; // skip falsy keyValues if (!keyValue) continue; // skip falsy keyValues
const key = { const key = stripDiacritics(keyValue).toLowerCase();
value: stripDiacritics(keyValue).toLowerCase(),
weight: Number(index)
};
if (!this._items.has(key)) { if (!this._items.has(key)) {
this._items.set(key, []); this._items.set(key, []);
} }
this._items.get(key).push(object); this._items.get(key).push({
keyWeight: Number(index),
object,
});
} }
} }
} }
@ -107,35 +106,40 @@ export default class QueryMatcher<T extends Object> {
if (query.length === 0) { if (query.length === 0) {
return []; return [];
} }
const results = []; const matches = [];
// Iterate through the map & check each key. // Iterate through the map & check each key.
// ES6 Map iteration order is defined to be insertion order, so results // ES6 Map iteration order is defined to be insertion order, so results
// here will come out in the order they were put in. // here will come out in the order they were put in.
for (const key of this._items.keys()) { for (const [key, candidates] of this._items.entries()) {
let {value: resultKey} = key; let resultKey = key;
if (this._options.shouldMatchWordsOnly) { if (this._options.shouldMatchWordsOnly) {
resultKey = resultKey.replace(/[^\w]/g, ''); resultKey = resultKey.replace(/[^\w]/g, '');
} }
const index = resultKey.indexOf(query); const index = resultKey.indexOf(query);
if (index !== -1 && (!this._options.shouldMatchPrefix || index === 0)) { if (index !== -1 && (!this._options.shouldMatchPrefix || index === 0)) {
results.push({key, index}); matches.push(
...candidates.map((candidate) => ({key, index, ...candidate}))
);
} }
} }
// Sort them by where the query appeared in the search key, then by // Sort matches by where the query appeared in the search key, then by
// where the matched key appeared in the provided array of keys. // where the matched key appeared in the provided array of keys.
const sortedResults = results.slice().sort((a, b) => { matches.sort((a, b) => {
if (a.index < b.index) { if (a.index < b.index) {
return -1; return -1;
} else if (a.index === b.index && a.key.weight < b.key.weight) { } else if (a.index === b.index) {
return -1; if (a.keyWeight < b.keyWeight) {
return -1;
} else if (a.keyWeight === b.keyWeight) {
return 0;
}
} }
return 1; return 1;
}); });
// Now map the keys to the result objects. Each result object is a list, so // Now map the keys to the result objects. Also remove any duplicates.
// flatMap will flatten those lists out into a single list. Also remove any return _uniq(matches.map((match) => match.object));
// duplicates.
return _uniq(_flatMap(sortedResults, (candidate) => this._items.get(candidate.key)));
} }
} }