-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #37909 from callstack-internal/perf/search-options…
…-filtering perf: Implement filtering in search page
- Loading branch information
Showing
6 changed files
with
421 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| /** | ||
| * This file is a slim version of match-sorter library (https://github.com/kentcdodds/match-sorter) adjusted to the needs. | ||
| Use `threshold` option with one of the rankings defined below to control the strictness of the match. | ||
| */ | ||
| import type {ValueOf} from 'type-fest'; | ||
| import StringUtils from './StringUtils'; | ||
|
|
||
| const MATCH_RANK = { | ||
| CASE_SENSITIVE_EQUAL: 7, | ||
| EQUAL: 6, | ||
| STARTS_WITH: 5, | ||
| WORD_STARTS_WITH: 4, | ||
| CONTAINS: 3, | ||
| ACRONYM: 2, | ||
| MATCHES: 1, | ||
| NO_MATCH: 0, | ||
| } as const; | ||
|
|
||
| type Ranking = ValueOf<typeof MATCH_RANK>; | ||
|
|
||
| /** | ||
| * Gives a rankings score based on how well the two strings match. | ||
| * @param testString - the string to test against | ||
| * @param stringToRank - the string to rank | ||
| * @returns the ranking for how well stringToRank matches testString | ||
| */ | ||
| function getMatchRanking(testString: string, stringToRank: string): Ranking { | ||
| // too long | ||
| if (stringToRank.length > testString.length) { | ||
| return MATCH_RANK.NO_MATCH; | ||
| } | ||
|
|
||
| // case sensitive equals | ||
| if (testString === stringToRank) { | ||
| return MATCH_RANK.CASE_SENSITIVE_EQUAL; | ||
| } | ||
|
|
||
| // Lower casing before further comparison | ||
| const lowercaseTestString = testString.toLowerCase(); | ||
| const lowercaseStringToRank = stringToRank.toLowerCase(); | ||
|
|
||
| // case insensitive equals | ||
| if (lowercaseTestString === lowercaseStringToRank) { | ||
| return MATCH_RANK.EQUAL; | ||
| } | ||
|
|
||
| // starts with | ||
| if (lowercaseTestString.startsWith(lowercaseStringToRank)) { | ||
| return MATCH_RANK.STARTS_WITH; | ||
| } | ||
|
|
||
| // word starts with | ||
| if (lowercaseTestString.includes(` ${lowercaseStringToRank}`)) { | ||
| return MATCH_RANK.WORD_STARTS_WITH; | ||
| } | ||
|
|
||
| // contains | ||
| if (lowercaseTestString.includes(lowercaseStringToRank)) { | ||
| return MATCH_RANK.CONTAINS; | ||
| } | ||
| if (lowercaseStringToRank.length === 1) { | ||
| return MATCH_RANK.NO_MATCH; | ||
| } | ||
|
|
||
| // acronym | ||
| if (StringUtils.getAcronym(lowercaseTestString).includes(lowercaseStringToRank)) { | ||
| return MATCH_RANK.ACRONYM; | ||
| } | ||
|
|
||
| // will return a number between rankings.MATCHES and rankings.MATCHES + 1 depending on how close of a match it is. | ||
| let matchingInOrderCharCount = 0; | ||
| let charNumber = 0; | ||
| for (const char of stringToRank) { | ||
| charNumber = lowercaseTestString.indexOf(char, charNumber) + 1; | ||
| if (!charNumber) { | ||
| return MATCH_RANK.NO_MATCH; | ||
| } | ||
| matchingInOrderCharCount++; | ||
| } | ||
|
|
||
| // Calculate ranking based on character sequence and spread | ||
| const spread = charNumber - lowercaseTestString.indexOf(stringToRank[0]); | ||
| const spreadPercentage = 1 / spread; | ||
| const inOrderPercentage = matchingInOrderCharCount / stringToRank.length; | ||
| const ranking = MATCH_RANK.MATCHES + inOrderPercentage * spreadPercentage; | ||
|
|
||
| return ranking as Ranking; | ||
| } | ||
|
|
||
| /** | ||
| * Takes an array of items and a value and returns a new array with the items that match the given value | ||
| * @param items - the items to filter | ||
| * @param searchValue - the value to use for ranking | ||
| * @param extractRankableValuesFromItem - an array of functions | ||
| * @returns the new filtered array | ||
| */ | ||
| function filterArrayByMatch<T = string>(items: readonly T[], searchValue: string, extractRankableValuesFromItem: (item: T) => string[]): T[] { | ||
| const filteredItems = []; | ||
| for (const item of items) { | ||
| const valuesToRank = extractRankableValuesFromItem(item); | ||
| let itemRank: Ranking = MATCH_RANK.NO_MATCH; | ||
| for (const value of valuesToRank) { | ||
| const rank = getMatchRanking(value, searchValue); | ||
| if (rank > itemRank) { | ||
| itemRank = rank; | ||
| } | ||
| } | ||
|
|
||
| if (itemRank >= MATCH_RANK.MATCHES + 1) { | ||
| filteredItems.push(item); | ||
| } | ||
| } | ||
| return filteredItems; | ||
| } | ||
|
|
||
| export default filterArrayByMatch; | ||
| export {MATCH_RANK}; |
Oops, something went wrong.