Search throttle for emoji picker web #23846

perunt · 2023-07-29T10:56:43Z

Details

Fixed Issues

$ #21055 (comment)
PROPOSAL: #21055 (comment)

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

On staging web chrome, navigate to a chat and click the emoji on the chat
Type in any emoji name (example search) and after you enter the last character ('h' in my case for search), do not release your fingers and continuous type any other letters.
You'll see it displays 'Not found'

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

After.mov

Mobile Web - Chrome

telegram-cloud-document-2-5341759699161197574.mp4

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-08-11T09:08:50Z

@aimane-chnaif Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

Montchy · 2023-08-16T11:10:17Z

Tried it, lgtm! :)

aimane-chnaif · 2023-08-20T20:07:55Z

src/components/EmojiPicker/EmojiPickerMenu/index.js

@@ -43,6 +44,7 @@ const defaultProps = {
    forwardedRef: () => {},
    preferredSkinTone: CONST.EMOJI_DEFAULT_SKIN_TONE,
 };
+const throttleTime = Browser.isMobile() ? 200 : 50;


Browser.isMobile involves mWeb as well. So you meant 50 on web/desktop, 200 on native/mWeb?

Yes, the idea was to use the smallest timeout for more powerful web/desktop machines and slightly decrease it (from 300 to 200) for mobile devices

aimane-chnaif · 2023-08-20T20:08:36Z

src/components/EmojiPicker/EmojiPickerMenu/index.js

@@ -75,7 +77,7 @@ class EmojiPickerMenu extends Component {
        // prevent auto focus when open picker for mobile device
        this.shouldFocusInputOnScreenFocus = canFocusInputOnScreenFocus();

-        this.filterEmojis = _.debounce(this.filterEmojis.bind(this), 300);
+        this.filterEmojis = _.throttle(this.filterEmojis.bind(this), throttleTime);


What's the advantage of throttle vs debounce here?

I used throttle because it invokes a function at specified intervals, so even if we type fast, it would still be called every 50/200 ms. With debounce, we would wait for 50/200 ms after the last user input before invoking the function. Hence, there were instances when users typed quickly and didn't see the immediate result.

perunt · 2023-08-24T15:42:06Z

@aimane-chnaif does it work for you?

aimane-chnaif · 2023-08-29T06:45:25Z

debounce-50.mov

debounce-300.mov

throttle-50.mov

throttle-300.mov

aimane-chnaif · 2023-08-29T06:46:58Z

@perunt I think we should use debounce.

i.e. when type flag very quickly:
debounce renders 2 times: f, flag,
while throttle renders 4 times: f, fl, fla, flag

perunt · 2023-08-29T07:24:09Z

The main issue was being unable to see changes from the input while typing. That's why we need to do a call at the end of a specific time period (throttle) instead of after a certain period following the last keypress (debounce). We could consider extending these periods. Currently, on your machine, it's set to 50ms. I think this is okay since it's not a mobile device, and even on an older laptop, it shouldn't make the app appear laggy.

So, what we can do here:

Extend the timeout from 50ms to 200-300ms.
Close this issue. (as replacing debounce behavior with throttle is a main idea)

Have you tested it on a mobile device? How does it feel there(it uses 200ms)?

perunt · 2023-09-04T16:01:11Z

@aimane-chnaif, what do you think about these options?

perunt · 2023-09-28T08:44:50Z

@aimane-chnaif, what is the future of this PR?

perunt · 2023-10-04T15:17:45Z

@stitesExpensify , sorry for disturbing you over such minor stuff, but it would be great if you could either merge it or close it. Wdyt?

aimane-chnaif · 2023-10-04T15:36:15Z

when type flag very quickly:
debounce renders 2 times: f, flag,
while throttle renders 4 times: f, fl, fla, flag

If we are fine with this, we can merge with throttle solution

perunt · 2023-10-04T16:31:01Z

It depends on how fast you are typing.

const throttle = _.throttle(() => {
  console.log('Throttled function');
}, 200);

throttle()
setTimeout(throttle, 10)
setTimeout(throttle, 30)
setTimeout(throttle, 70)

It would be called once, everything above 200ms will cause a new invocation.

stitesExpensify · 2023-10-05T23:55:52Z

Ah sorry @perunt I wasn't assigned as a reviewer so I didn't know this PR existed. I don't see any downside to merging this do you @aimane-chnaif ? If not could you please do the checklist and we will get this closed out?

perunt · 2023-10-09T06:49:26Z

All's good, I just don't want to leave any PR hanging

aimane-chnaif · 2023-10-09T06:50:11Z

Please merge main. I will checklist shortly

…cker-search

perunt · 2023-10-09T07:02:54Z

done

…cker-search

perunt · 2023-10-16T20:16:56Z

@aimane-chnaif, did you have time for it? I just want merge or close it.

aimane-chnaif · 2023-10-16T20:30:04Z

Sorry for delay

aimane-chnaif · 2023-10-16T20:34:34Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

iOS

Android

OSBotify · 2023-10-17T19:56:29Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-10-17T23:56:12Z

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 1.3.86-0 🚀

platform	result
🤖 android 🤖	failure ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-10-18T23:53:42Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.86-5 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

perunt added 2 commits July 29, 2023 12:54

add throttle

6fef245

adjust a timeout

b6eae29

perunt mentioned this pull request Jul 29, 2023

[HOLD for payment 2023-10-25] [$1000] The search result still shows emoji for wrong texts #21055

Closed

6 tasks

perunt marked this pull request as ready for review August 11, 2023 09:08

perunt requested a review from a team as a code owner August 11, 2023 09:08

melvin-bot bot removed the request for review from a team August 11, 2023 09:08

melvin-bot bot requested a review from aimane-chnaif August 11, 2023 09:08

aimane-chnaif reviewed Aug 20, 2023

View reviewed changes

Merge branch 'main' of https://github.com/Expensify/App into emoji-pi…

46dd628

…cker-search

Merge branch 'main' of https://github.com/Expensify/App into emoji-pi…

c18bf28

…cker-search

aimane-chnaif approved these changes Oct 16, 2023

View reviewed changes

melvin-bot bot requested a review from stitesExpensify October 16, 2023 20:34

stitesExpensify approved these changes Oct 17, 2023

View reviewed changes

stitesExpensify merged commit 9aa14f8 into Expensify:main Oct 17, 2023
12 checks passed

OSBotify mentioned this pull request Oct 17, 2023

Deploy Checklist: New Expensify 2023-10-17 #29837

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Search throttle for emoji picker web #23846

Search throttle for emoji picker web #23846

perunt commented Jul 29, 2023 •

edited

Loading

melvin-bot bot commented Aug 11, 2023

Montchy commented Aug 16, 2023

aimane-chnaif Aug 20, 2023

perunt Aug 21, 2023

aimane-chnaif Aug 20, 2023

perunt Aug 21, 2023

perunt commented Aug 24, 2023

aimane-chnaif commented Aug 29, 2023

aimane-chnaif commented Aug 29, 2023

perunt commented Aug 29, 2023 •

edited

Loading

perunt commented Sep 4, 2023

perunt commented Sep 28, 2023

perunt commented Oct 4, 2023

aimane-chnaif commented Oct 4, 2023

perunt commented Oct 4, 2023

stitesExpensify commented Oct 5, 2023

perunt commented Oct 9, 2023

aimane-chnaif commented Oct 9, 2023

perunt commented Oct 9, 2023

perunt commented Oct 16, 2023

aimane-chnaif commented Oct 16, 2023

aimane-chnaif commented Oct 16, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 18, 2023

Search throttle for emoji picker web #23846

Search throttle for emoji picker web #23846

Conversation

perunt commented Jul 29, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 11, 2023

Montchy commented Aug 16, 2023

aimane-chnaif Aug 20, 2023

Choose a reason for hiding this comment

perunt Aug 21, 2023

Choose a reason for hiding this comment

aimane-chnaif Aug 20, 2023

Choose a reason for hiding this comment

perunt Aug 21, 2023

Choose a reason for hiding this comment

perunt commented Aug 24, 2023

aimane-chnaif commented Aug 29, 2023

aimane-chnaif commented Aug 29, 2023

perunt commented Aug 29, 2023 • edited Loading

perunt commented Sep 4, 2023

perunt commented Sep 28, 2023

perunt commented Oct 4, 2023

aimane-chnaif commented Oct 4, 2023

perunt commented Oct 4, 2023

stitesExpensify commented Oct 5, 2023

perunt commented Oct 9, 2023

aimane-chnaif commented Oct 9, 2023

perunt commented Oct 9, 2023

perunt commented Oct 16, 2023

aimane-chnaif commented Oct 16, 2023

aimane-chnaif commented Oct 16, 2023

Reviewer Checklist

Screenshots/Videos

OSBotify commented Oct 17, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 18, 2023

perunt commented Jul 29, 2023 •

edited

Loading

perunt commented Aug 29, 2023 •

edited

Loading