From 224099a9dc539490593ac8d150c2353187754bf6 Mon Sep 17 00:00:00 2001 From: Chris Duarte Date: Tue, 2 Jan 2018 14:21:50 -0800 Subject: [PATCH] Add fuzy search to the emoji picker (#1310) * Add fuzy search to the emoji picker remove comments from master rebase Add fusejs to NOTICE.txt * Add fuzzy search support for emoji_picker --- NOTICE.txt | 215 ++++++++++++++++++ .../emoji_suggestion/emoji_suggestion.js | 40 ++-- .../autocomplete/emoji_suggestion/index.js | 19 +- app/components/emoji_picker/emoji_picker.js | 19 +- app/components/emoji_picker/index.js | 23 +- package.json | 1 + yarn.lock | 4 + 7 files changed, 282 insertions(+), 39 deletions(-) diff --git a/NOTICE.txt b/NOTICE.txt index 57b339f0e..9ead66f08 100644 --- a/NOTICE.txt +++ b/NOTICE.txt @@ -8,6 +8,221 @@ This document includes a list of open source components used in Mattermost Mobil -------- +## fusejs + +This product contains 'fusejs', a Lightweight fuzzy-search, in JavaScript by Kirollos Risk. + +* HOMEPAGE: + * https://github.com/krisk/Fuse + +* LICENSE: + +Apache License + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2017 Kirollos Risk + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +--- + ## react-native-tooltip This product contains a modified portion of 'react-native-tooltip', A react-native component from displaying tooltip. Uses UIMenuController. diff --git a/app/components/autocomplete/emoji_suggestion/emoji_suggestion.js b/app/components/autocomplete/emoji_suggestion/emoji_suggestion.js index 4c1748054..605e14fbd 100644 --- a/app/components/autocomplete/emoji_suggestion/emoji_suggestion.js +++ b/app/components/autocomplete/emoji_suggestion/emoji_suggestion.js @@ -25,6 +25,7 @@ export default class EmojiSuggestion extends Component { cursorPosition: PropTypes.number, emojis: PropTypes.array.isRequired, isSearch: PropTypes.bool, + fuse: PropTypes.object.isRequired, theme: PropTypes.object.isRequired, onChangeText: PropTypes.func.isRequired, onResultCountChange: PropTypes.func.isRequired, @@ -63,38 +64,41 @@ export default class EmojiSuggestion extends Component { } const matchTerm = match[3]; - if (matchTerm !== this.state.matchTerm) { + + const matchTermChanged = matchTerm !== this.state.matchTerm; + if (matchTermChanged) { this.setState({ matchTerm }); } - let data = []; - if (matchTerm.length) { - const lowerCaseMatchTerm = matchTerm.toLowerCase(); - const startsWith = []; - const includes = []; - nextProps.emojis.forEach((emoji) => { - if (emoji.startsWith(lowerCaseMatchTerm)) { - startsWith.push(emoji); - } else { - includes.push(emoji); - } - }); - data = [...startsWith.sort(), ...includes.sort()]; - } else { + if (matchTermChanged) { + this.handleFuzzySearch(matchTerm, nextProps); + } else if (!matchTerm.length) { const initialEmojis = [...nextProps.emojis]; initialEmojis.splice(0, 300); - data = initialEmojis.sort(); - } + const data = initialEmojis.sort(); + this.setEmojiData(data); + } + } + + handleFuzzySearch = async (matchTerm, props) => { + const {emojis, fuse} = props; + + const results = await fuse.search(matchTerm.toLowerCase()); + const data = results.map((index) => emojis[index]); + this.setEmojiData(data); + }; + + setEmojiData = (data) => { this.setState({ active: data.length > 0, dataSource: data }); this.props.onResultCountChange(data.length); - } + }; completeSuggestion = (emoji) => { const {actions, cursorPosition, onChangeText, value, rootId} = this.props; diff --git a/app/components/autocomplete/emoji_suggestion/index.js b/app/components/autocomplete/emoji_suggestion/index.js index e4fd2e6bf..1150988e2 100644 --- a/app/components/autocomplete/emoji_suggestion/index.js +++ b/app/components/autocomplete/emoji_suggestion/index.js @@ -12,23 +12,36 @@ import {getTheme} from 'mattermost-redux/selectors/entities/preferences'; import {EmojiIndicesByAlias} from 'app/utils/emojis'; import EmojiSuggestion from './emoji_suggestion'; +import Fuse from 'fuse.js'; const getEmojisByName = createSelector( getCustomEmojisByName, (customEmojis) => { - const emoticons = []; + const emoticons = new Set(); for (const [key] of [...EmojiIndicesByAlias.entries(), ...customEmojis.entries()]) { - emoticons.push(key); + emoticons.add(key); } - return emoticons; + return Array.from(emoticons); } ); function mapStateToProps(state) { + const options = { + shouldSort: true, + threshold: 0.3, + location: 0, + distance: 100, + minMatchCharLength: 2, + maxPatternLength: 32 + }; + const emojis = getEmojisByName(state); + const list = emojis.length ? emojis : []; + const fuse = new Fuse(list, options); return { + fuse, emojis, theme: getTheme(state) }; diff --git a/app/components/emoji_picker/emoji_picker.js b/app/components/emoji_picker/emoji_picker.js index 87c782ea8..a0c3c27a1 100644 --- a/app/components/emoji_picker/emoji_picker.js +++ b/app/components/emoji_picker/emoji_picker.js @@ -33,7 +33,8 @@ const SECTION_HEADER_HEIGHT = 28; export default class EmojiPicker extends PureComponent { static propTypes = { - emojisByName: PropTypes.array.isRequired, + fuse: PropTypes.object.isRequired, + emojis: PropTypes.array.isRequired, emojisBySection: PropTypes.array.isRequired, deviceWidth: PropTypes.number.isRequired, isLandscape: PropTypes.bool.isRequired, @@ -164,24 +165,16 @@ export default class EmojiPicker extends PureComponent { }; searchEmojis = (searchTerm) => { - const {emojisByName} = this.props; + const {emojis, fuse} = this.props; const searchTermLowerCase = searchTerm.toLowerCase(); if (!searchTerm) { return []; } - const startsWith = []; - const includes = []; - emojisByName.forEach((emoji) => { - if (emoji.startsWith(searchTermLowerCase)) { - startsWith.push(emoji); - } else if (emoji.includes(searchTermLowerCase)) { - includes.push(emoji); - } - }); - - return [...startsWith.sort(), ...includes.sort()]; + const results = fuse.search(searchTermLowerCase); + const data = results.map((index) => emojis[index]); + return data; }; getNumberOfColumns = (deviceWidth) => { diff --git a/app/components/emoji_picker/index.js b/app/components/emoji_picker/index.js index 11b82f03c..872723b35 100644 --- a/app/components/emoji_picker/index.js +++ b/app/components/emoji_picker/index.js @@ -11,6 +11,7 @@ import {getTheme} from 'mattermost-redux/selectors/entities/preferences'; import {CategoryNames, Emojis, EmojiIndicesByAlias, EmojiIndicesByCategory} from 'app/utils/emojis'; import EmojiPicker from './emoji_picker'; +import Fuse from 'fuse.js'; const categoryToI18n = { activity: { @@ -120,22 +121,34 @@ const getEmojisBySection = createSelector( const getEmojisByName = createSelector( getCustomEmojisByName, (customEmojis) => { - const emoticons = []; + const emoticons = new Set(); for (const [key] of [...EmojiIndicesByAlias.entries(), ...customEmojis.entries()]) { - emoticons.push(key); + emoticons.add(key); } - return emoticons; + return Array.from(emoticons); } ); function mapStateToProps(state) { const emojisBySection = getEmojisBySection(state); - const emojisByName = getEmojisByName(state); + const emojis = getEmojisByName(state); const {deviceWidth} = getDimensions(state); + const options = { + shouldSort: true, + threshold: 0.3, + location: 0, + distance: 100, + minMatchCharLength: 2, + maxPatternLength: 32 + }; + + const list = emojis.length ? emojis : []; + const fuse = new Fuse(list, options); return { - emojisByName, + fuse, + emojis, emojisBySection, deviceWidth, isLandscape: isLandscape(state), diff --git a/package.json b/package.json index a136f8999..753ee83d4 100644 --- a/package.json +++ b/package.json @@ -12,6 +12,7 @@ "commonmark": "hmhealey/commonmark.js#dda6d89198252d5fd4bb04c4cc0668766c22fd77", "commonmark-react-renderer": "hmhealey/commonmark-react-renderer#1f078d53b7993d30b2762dd7d78fdd21ee84dd21", "deep-equal": "1.0.1", + "fuse.js": "^3.2.0", "intl": "1.2.5", "jail-monkey": "0.1.0", "mattermost-redux": "mattermost/mattermost-redux", diff --git a/yarn.lock b/yarn.lock index cd93242ff..2b402458e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2790,6 +2790,10 @@ functional-red-black-tree@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz#1b0ab3bd553b2a0d6399d29c0e3ea0b252078327" +fuse.js@^3.2.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/fuse.js/-/fuse.js-3.2.0.tgz#f0448e8069855bf2a3e683cdc1d320e7e2a07ef4" + gauge@~1.2.5: version "1.2.7" resolved "https://registry.yarnpkg.com/gauge/-/gauge-1.2.7.tgz#e9cec5483d3d4ee0ef44b60a7d99e4935e136d93"