Update frequently used emojis in state whenever its onyx key changes by huzaifa-99 · Pull Request #23965 · Expensify/App

huzaifa-99 · 2023-07-31T22:18:57Z

Details

We were not recalculating the frequently used emojis list in the Emoji picker when it was already opened and the frequently used emojis got updated in another device.

With these changes, we are now listening to the onyx key ONYXKEYS.FREQUENTLY_USED_EMOJIS in <EmojiPickerMenu/> and updating the already rendered emojis list when its changes from a different device.

Fixed Issues

$ #23800
PROPOSAL: #23800 (comment)

Tests

Log in to 2 devices with the same account (logout and then log in if you are already logged in)
In both devices, go to any chat and open the emoji picker
From device A select an emoji, and in device B verify the frequently used emojis change (the emoji you used most will be the first in the frequently used list - each emoji has a use counter)
Repeat step 3 but from device B and verify in device A - frequently used list should be updated correctly

Verify that no errors appear in the JS console

Offline tests

Log in to 2 devices with the same account (logout and then login if you are already logged in)
In both devices, go to any chat and open the emoji picker
From device A select an emoji, and in device B verify the frequently used emojis change (the emoji you used most will be the first in the frequently used list - each emoji has a use counter)
Repeat step 3 but from device B and verify in device A - the frequently used list should be updated correctly
Now open the emoji picker from device A and go offline from that device. (do not close the emoji picker)
In device B select an emoji and validate that frequently used emojis change.
Now go online in device A and verify the frequently used emojis change.
Repeat step 5-7 with device B going offline and device A updating frequently used emojis

QA Steps

Same as "Tests" section above

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Chrome:

Web.Chrome.and.Safari.mp4

Safari:

Web.Chrome.and.Safari.mp4

Mobile Web - Chrome

IOS.Safari.and.mWeb.Chrome.mp4

Mobile Web - Safari

IOS.Safari.and.mWeb.Chrome.mp4

Desktop

IOS.Native.and.Desktop.Native.mp4

iOS

IOS.Native.and.Desktop.Native.mp4

Android

Android.Native.and.Desktop.Native.mp4

melvin-bot · 2023-07-31T22:19:02Z

@robertKozik 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]

…-popover-menu

huzaifa-99 · 2023-08-01T10:51:07Z

There were some merge conflicts, the native emoji picker menu was migrated to function component.

@robertKozik bump for review.

robertKozik

Minor requests, overally great job 🚀

robertKozik · 2023-08-01T14:10:58Z

+    // eslint-disable-next-line rulesdir/prefer-early-return
+    componentDidUpdate(prevProps) {
+        if (prevProps.frequentlyUsedEmojis !== this.props.frequentlyUsedEmojis) {
+            const {filteredEmojis, headerRowIndices} = this.getInitialFilteredEmojisAndHeaderRowIndices();
+            this.emojis = filteredEmojis;
+            this.headerRowIndices = headerRowIndices;
+            this.setState({
+                filteredEmojis: this.emojis,
+                headerIndices: this.headerRowIndices,
+            });
+        }
+    }


Can you flip this condition and return early, rather than disabling eslint rule?

Done here, thanks for the suggestion.

robertKozik · 2023-08-01T14:12:00Z

+     * Calculate the initial filtered emojis and header row indices
+     * @returns {Object}
+     */
+    getInitialFilteredEmojisAndHeaderRowIndices() {


As this method is not only calculated the emojis and indices on initial render, can we change the name to be more appropriate?

sure. I couldn't think of a more relevant name 😅, any suggestions?

imo remove initial from it and should be fine 😆

Thanks, done here

huzaifa-99 · 2023-08-01T14:32:07Z

Thanks for the feedback @robertKozik. I have applied the suggested changes!

huzaifa-99 · 2023-08-02T07:05:05Z

@robertKozik bumping for review.

robertKozik · 2023-08-02T07:58:07Z

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 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

android-web.mov

Mobile Web - Safari

iOS-web.mov

Desktop

desktop.mov

iOS

iOS.-.native.mov

Android

android-native.mov

robertKozik · 2023-08-02T08:59:49Z

Minor things according to author checklist @huzaifa-99 :

could you tick all the Verify that no errors appear in the JS console (or check it if you didn't yet 😄)
could you update the offline tests - as there won't be updating between devices when offline, only on the device which typed the emoji

In the meantime I'll record the videos

huzaifa-99 · 2023-08-02T09:02:40Z

Ah missed those. Thanks, @robertKozik

could you tick all the Verify that no errors appear in the JS console (or check it if you didn't yet 😄)
could you update the offline tests - as there won't be updating between devices when offline, only on the device which typed the emoji

on it.

huzaifa-99 · 2023-08-02T09:34:32Z

Minor things according to author checklist @huzaifa-99 :

could you tick all the Verify that no errors appear in the JS console (or check it if you didn't yet 😄)

could you update the offline tests - as there won't be updating between devices when offline, only on the device which typed the emoji

In the meantime I'll record the videos

Done @robertKozik. Thanks

robertKozik

One regression which I encounter after tests

robertKozik · 2023-08-02T10:31:45Z

-
-        // Get the header emojis along with the code, index and icon.
-        // index is the actual header index starting at the first emoji and counting each one
-        this.headerEmojis = EmojiUtils.getHeaderEmojis(this.emojis);


Did you delete this assignment entirely? I see you are calculating it inside ComponentDidUpdate but there is no assignment to this.headerEmojis there. I see it's used in CategoryShortcutBar, and because of that it's not visible now

after:

before:

My bad, this is a mistake. Fixing it.

I fixed it here, @robertKozik. Sry i missed this and thanks for the spot

robertKozik

Tests well now, let's push this forward

puneetlath

Couple small things. Great collaboration on this PR.

puneetlath · 2023-08-02T21:42:18Z

    }

+    /**
+     * Calculate the initial filtered + header emojis and header row indices


Suggested change

* Calculate the initial filtered + header emojis and header row indices

* Calculate the filtered + header emojis and header row indices

It looks like this function is used any time the component updates, not just initially.

puneetlath · 2023-08-02T21:43:56Z

+function EmojiPickerMenu({preferredLocale, onEmojiSelected, preferredSkinTone, translate, frequentlyUsedEmojis}) {
    const emojiList = useAnimatedRef();
-    const allEmojis = useMemo(() => EmojiUtils.mergeEmojisWithFrequentlyUsedEmojis(emojis), []);
+    // eslint-disable-next-line react-hooks/exhaustive-deps


Could you explain to me why we need this? I'd just like to understand.

We are calculating allEmojis whenever frequentlyUsedEmojis are changing. Since we are not directly using the frequentlyUsedEmojis value in the memo hook, it gives lint error.

The EmojiUtils.mergeEmojisWithFrequentlyUsedEmojis() function uses the frequentlyUsedEmojis value internally by subscribing to onyx in EmojiUtils.

Got it! Thanks for the explanation.

huzaifa-99 · 2023-08-02T22:12:24Z

Thanks for the feedback @puneetlath. I have applied the suggested changes.

OSBotify · 2023-08-02T23:43:03Z

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

huzaifa-99 · 2023-08-03T05:16:52Z

TYSM guys 🚀

OSBotify · 2023-08-03T17:41:22Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.50-0 🚀

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

OSBotify · 2023-08-07T18:29:42Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.50-3 🚀

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

OSBotify · 2023-08-07T18:56:55Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.51-0 🚀

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

OSBotify · 2023-08-09T08:46:03Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.51-2 🚀

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

Update frequently used emojis in state whenever its onyx key changes

04ab9fc

huzaifa-99 requested a review from a team as a code owner July 31, 2023 22:18

melvin-bot bot requested review from robertKozik and removed request for a team July 31, 2023 22:19

huzaifa-99 added 3 commits August 1, 2023 03:31

Fix lint

cac3ed3

Fix lint

4e61c76

Fix prop type

ac20ac9

huzaifa-99 mentioned this pull request Jul 31, 2023

[Ready for payment - $1000] mWeb- Chat- In secondary device, in real time, emoji selected is not updated in frequently used #23800

Closed

6 tasks

huzaifa-99 added 2 commits August 1, 2023 15:38

Merge branch 'main' into 23800-update-frequently-used-emojis-in-emoji…

a026502

…-popover-menu

Fix lint

08017f7

robertKozik suggested changes Aug 1, 2023

View reviewed changes

huzaifa-99 added 2 commits August 1, 2023 19:21

Return early in componentDidUpdate() for <EmojiPopoverMenu/>

d2f71e2

Renamed function

079e5bf

robertKozik suggested changes Aug 2, 2023

View reviewed changes

Correctly set header emojis in emoji picker

4d7800b

robertKozik approved these changes Aug 2, 2023

View reviewed changes

melvin-bot bot requested a review from puneetlath August 2, 2023 11:42

puneetlath requested changes Aug 2, 2023

View reviewed changes

Updated comment

5949859

puneetlath approved these changes Aug 2, 2023

View reviewed changes

puneetlath merged commit 6d56956 into Expensify:main Aug 2, 2023

OSBotify mentioned this pull request Aug 3, 2023

Deploy Checklist: New Expensify 2023-08-03 #24121

Closed

86 tasks

OSBotify mentioned this pull request Aug 7, 2023

Deploy Checklist: New Expensify 2023-08-07 #24230

Closed

98 tasks

	* Calculate the initial filtered + header emojis and header row indices
	* Calculate the filtered + header emojis and header row indices

Conversation

huzaifa-99 commented Jul 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Jul 31, 2023

Uh oh!

huzaifa-99 commented Aug 1, 2023

Uh oh!

robertKozik left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

huzaifa-99 commented Aug 1, 2023

Uh oh!

huzaifa-99 commented Aug 2, 2023

Uh oh!

robertKozik commented Aug 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

robertKozik commented Aug 2, 2023

Uh oh!

huzaifa-99 commented Aug 2, 2023

Uh oh!

huzaifa-99 commented Aug 2, 2023

Uh oh!

robertKozik left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

robertKozik left a comment

Choose a reason for hiding this comment

Uh oh!

puneetlath left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

huzaifa-99 Aug 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

huzaifa-99 commented Aug 2, 2023

Uh oh!

OSBotify commented Aug 2, 2023

Uh oh!

huzaifa-99 commented Aug 3, 2023

Uh oh!

huzaifa-99 commented Jul 31, 2023 •

edited

Loading

robertKozik commented Aug 2, 2023 •

edited

Loading

huzaifa-99 Aug 2, 2023 •

edited

Loading