Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate EmojiPickerMenu to FlashList #31479

Merged

Conversation

TMisiukiewicz
Copy link
Contributor

@TMisiukiewicz TMisiukiewicz commented Nov 17, 2023

Details

Migrating EmojiPickerMenu to FlashList for both Web and Mobile

Fixed Issues

$ #30911
PROPOSAL:

Tests

  1. Open emoji picker
  2. Scroll the list
  3. Press the emojis category on the top and verify it scrolls to the category
  4. Change skin tone and verify it changed in the emoji list
  5. Type "aaa" in search bar and verify no results message is displayed
  6. Type "a" in search bar and verify filtered list scrolls
  • Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

  1. Open emoji picker
  2. Scroll the list
  3. Press the emojis category on the top and verify it scrolls to the category
  4. Change skin tone and verify it changed in the emoji list
  5. Type "aaa" in search bar and verify no results message is displayed
  6. Type "a" in search bar and verify filtered list scrolls
  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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 the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • 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.

Screenshots/Videos

Android: Native
ANDROID.mov
Android: mWeb Chrome
ANDROID_WEB.mov
iOS: Native
IOS.mp4
iOS: mWeb Safari
IOS_WEB.mp4
MacOS: Chrome / Safari
WEB.mov
MacOS: Desktop
DESKTOP.mov

@TMisiukiewicz TMisiukiewicz marked this pull request as ready for review November 17, 2023 10:57
@TMisiukiewicz TMisiukiewicz requested a review from a team as a code owner November 17, 2023 10:57
@melvin-bot melvin-bot bot requested review from cubuspl42 and removed request for a team November 17, 2023 10:57
Copy link

melvin-bot bot commented Nov 17, 2023

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

@cubuspl42
Copy link
Contributor

Exception:

emojipicker-flashlist-migration-ios.mp4

@TMisiukiewicz TMisiukiewicz force-pushed the feat/emojipicker-flashlist-migration branch from 4f41024 to a55a640 Compare November 20, 2023 14:13
@TMisiukiewicz
Copy link
Contributor Author

@cubuspl42 thanks for testing, I addressed both of your comments

@TMisiukiewicz
Copy link
Contributor Author

hi @cubuspl42, did you have a chance to take another look on this PR?

@cubuspl42
Copy link
Contributor

@TMisiukiewicz I will; I have a personal situation that affects my capacity. Everything will be back to normal after Friday. Is this urgent or conflict-prone?

@TMisiukiewicz
Copy link
Contributor Author

@cubuspl42 no worries, it can wait until you are back!

@TMisiukiewicz
Copy link
Contributor Author

hi @cubuspl42, will you find some time to check this PR this week? 🙏

@cubuspl42
Copy link
Contributor

@TMisiukiewicz I'll do this right now, thank you for reminding ♡

@cubuspl42
Copy link
Contributor

Please also merge main

Copy link
Contributor

@cubuspl42 cubuspl42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left one comment, otherwise things look good!

@TMisiukiewicz TMisiukiewicz force-pushed the feat/emojipicker-flashlist-migration branch from a55a640 to 62d795e Compare November 29, 2023 10:41
@TMisiukiewicz
Copy link
Contributor Author

main has been merged ✅

Copy link
Contributor

@cubuspl42 cubuspl42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Contributor

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also please investigate what can be DRYed up between the web and mobile implementations, creating a Base component if necessary

src/components/EmojiPicker/EmojiPickerMenu/index.native.js Outdated Show resolved Hide resolved
src/components/EmojiPicker/EmojiPickerMenu/getItemType.js Outdated Show resolved Hide resolved
src/components/EmojiPicker/EmojiPickerMenu/index.js Outdated Show resolved Hide resolved
src/components/EmojiPicker/EmojiPickerMenu/index.js Outdated Show resolved Hide resolved
src/components/EmojiPicker/EmojiPickerMenu/index.js Outdated Show resolved Hide resolved
@TMisiukiewicz TMisiukiewicz force-pushed the feat/emojipicker-flashlist-migration branch 2 times, most recently from 0a85015 to b482d91 Compare December 1, 2023 09:36
@TMisiukiewicz
Copy link
Contributor Author

@roryabraham thanks for your review - created a Base component to share some parts of it across platforms and also extracted the common functions, where possible. Mind taking a look once again?

@TMisiukiewicz TMisiukiewicz force-pushed the feat/emojipicker-flashlist-migration branch 2 times, most recently from 1b1f5de to 2d96196 Compare December 4, 2023 14:55
@TMisiukiewicz
Copy link
Contributor Author

@roryabraham thanks for your eagle-eye reviews! Really appreciate all the stuff you keep findind and your knowledge of the project. I addressed your comments and fixed the flicker on the initial list render I mentioned on Friday

@adhorodyski adhorodyski mentioned this pull request Dec 18, 2023
46 tasks
Copy link
Contributor

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for all your work on this. It's much better than it was. I do want us to follow-up with a PR to build support for ArrowLeft and ArrowRight in useArrowKeyFocusManager as that will further reduce platform differences between these files, I believe to the point where everything can be recombined into a single component.

@roryabraham
Copy link
Contributor

@cubuspl42 there have been a lot of changes here since your last review. Can you please review and test again before I merge this? I see the reviewer checklist is failing, maybe try again with a fresh checklist?

@TMisiukiewicz
Copy link
Contributor Author

thanks for your review @roryabraham! Can we create an issue for supporting ArrowLeft and ArrowRight in useArrowKeyFocusManager? Christmas break is very close and just want to make sure once we are back from holidays, me or other Callstack folk could pick this up

@cubuspl42
Copy link
Contributor

@TMisiukiewicz Would you merge main? We're >600 commits behind

@TMisiukiewicz
Copy link
Contributor Author

@cubuspl42 whoops that's a pretty big number, updated!

@cubuspl42
Copy link
Contributor

main goes forward fast, it's easy to get >1000

Too big diversion can result in lint issues and other problems, that's why C+ often remind about merging

@cubuspl42
Copy link
Contributor

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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(theme.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 the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • 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
flashlist-web.mp4
Mobile Web - Chrome
flashlist-android-web-compressed.mp4
Mobile Web - Safari
flashlist-ios-web.mp4
Desktop
iOS
flashlist-ios.mp4
Android
flashlist-android-compressed.mp4

Copy link
Contributor

@cubuspl42 cubuspl42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I re-tested, and things still work cross-platform!

@roryabraham roryabraham merged commit e89e466 into Expensify:main Dec 22, 2023
15 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.17-0 🚀

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

Comment on lines +36 to +49
// On windows, flag emojis are not supported
const emojisForOperatingSystem =
getOperatingSystem() === CONST.OS.WINDOWS
? emojis.slice(
0,
emojis.findIndex((emoji) => {
if (!('header' in emoji)) {
return;
}

return emoji.header && emoji.code === 'flags';
}),
)
: emojis;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TMisiukiewicz This was implemented during the time you have worked on this PR but we have added the support for flag emojis on Windows in this issues and pr #31717

There was this issue raised here #33593, if you could comment on it so I can assign you and you could make a follow up to remove this Windows specific code. thanks!

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.17-8 🚀

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


if (item.header) {
return (
<View style={[styles.emojiHeaderContainer, target === 'StickyHeader' ? styles.mh4 : {width: windowWidth}]}>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coming from #33709 (comment)

We had a bug here scroll not working over header.
RCA: emoji header is wrapped in an absolute container and overlaps with scroll bar

// Set scrollPaddingTop to consider sticky headers while scrolling
{scrollPaddingTop: isFiltered ? 0 : CONST.EMOJI_PICKER_ITEM_HEIGHT},
{scrollPaddingTop: isListFiltered ? 0 : CONST.EMOJI_PICKER_ITEM_HEIGHT},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line is applied at the wrong place, which created #36883

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants