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

Fix Emoji picker's position changes on decreasing the screen size #22792

Merged
merged 7 commits into from
Jul 25, 2023

Conversation

hoangzinh
Copy link
Contributor

@hoangzinh hoangzinh commented Jul 13, 2023

Details

Fixed Issues

$ #17603
PROPOSAL: #17603 (comment)

Tests

On Web/Desktop
Test case 1: Test Emoji button in composer box

  1. Go to any DM chat
  2. Open Chrome dev tool -> Change to touch screen mode
  3. Click open Emoji picker button in the compose box
  4. Decrease the screen size until the open Emoji Picker in the compose box disappear
  5. Verify that the EmojiPicker is disappear

Test case 2: Test Emoji button in context menu

  1. Go to any DM chat
  2. Right click on a chat message to open context menu
  3. Click Add Emoji picker icon in the context menu
  4. Decrease the screen size
  5. Verify that the EmojiPicker is disappear
  • Verify that no errors appear in the JS console

Offline tests

The PR changes is not affected by network

QA Steps

Same as Tests

  • 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
Screen.Recording.2023-07-23.at.22.39.52.-.web.mp4
Mobile Web - Chrome
Screen.Recording.2023-07-23.at.22.49.41.-.android.chrome.mov
Mobile Web - Safari
Screen.Recording.2023-07-23.at.23.03.53.-.ios.safari.mp4
Desktop
Screen.Recording.2023-07-23.at.22.45.33.-.desktop.mp4
iOS
Screen.Recording.2023-07-23.at.23.09.11.-.ios.mov
Android
Screen.Recording.2023-07-23.at.23.11.41.-.android.mp4

@hoangzinh hoangzinh marked this pull request as ready for review July 13, 2023 11:42
@hoangzinh hoangzinh requested a review from a team as a code owner July 13, 2023 11:42
@melvin-bot melvin-bot bot requested review from allroundexperts and removed request for a team July 13, 2023 11:42
@melvin-bot
Copy link

melvin-bot bot commented Jul 13, 2023

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

@hoangzinh
Copy link
Contributor Author

@allroundexperts please hold-on review this PR. I found some regression bug with this implement. I.e: if there are few of report message having reactions, if we're opening a EmojiPicker and one of those report message is deleted, this EmojiPicker will be hide automatically as well

@allroundexperts
Copy link
Contributor

Any update here @hoangzinh?

@hoangzinh
Copy link
Contributor Author

@allroundexperts Sorry for lated updates. I'm still on it. I'm still struggling to find a good solution for this. I will post my explored options soon.

@allroundexperts
Copy link
Contributor

Any update @hoangzinh?

@hoangzinh
Copy link
Contributor Author

Hi @allroundexperts after testing it carefully, I found another bug if we go with unmount approach.

Screen.Recording.2023-07-19.at.18.12.46.mov

In web, when we hover on a message, there are 2 opening EmojiPicker buttons. So if we click on of them, another one will unmount -> it calls EmojiPickerAction.resetEmojiPopoverAnchor -> the emojiPopoverAnchor is null -> when we add a emoji, it doesn't show anything.

So I think about another option that finding a way to check emojiPopoverAnchor.current is null in this handler

const emojiPopoverDimensionListener = Dimensions.addEventListener('change', () => {
calculateAnchorPosition(emojiPopoverAnchor.current).then((value) => {
setEmojiPopoverAnchorPosition(value);
});
});

Take a look at this comment of Ali #17603 (comment)

I think it's correct because we're passing the value of useRef to emojiPopoverAnchor.current. So when the component is unmount, emojiPopoverAnchor.current still reference to value of useRef.current not the useRef. So I think we should pass useRef object instead of useRef.current, it will be nil if the component unmount. Wdyt? I have implemented this idea in this PR https://github.com/Expensify/App/pull/23161/files

@hoangzinh
Copy link
Contributor Author

cc @allroundexperts ^

@allroundexperts
Copy link
Contributor

Hi @hoangzinh!
I'm still testing this out. Expect some update today / tomorrow.

@allroundexperts
Copy link
Contributor

Okay. Quick question @hoangzinh. Why do we even need to worry about the Emoji picker buttons other than the one in composer? Without applying your changes, they seem to work fine.

@allroundexperts
Copy link
Contributor

If my above comment doesn't work, then I think another easier approach would be to update your resetEmojiAnchor function such that it accepts a ref. In the function logic, we can prevent ref clearing if the passed on ref is different from the current ref stored.

@hoangzinh
Copy link
Contributor Author

hoangzinh commented Jul 23, 2023

Okay. Quick question @hoangzinh. Why do we even need to worry about the Emoji picker buttons other than the one in composer? Without applying your changes, they seem to work fine.

Yeah you're right. We don't really need to worry about it. I just revert changes to only affect in composer and context menu. I will try to test every thing again. Will let you know how is it going.

@hoangzinh
Copy link
Contributor Author

@allroundexperts I finished update recording videos with latest PR. Could you help to review this PR again? Thanks

@allroundexperts
Copy link
Contributor

@hoangzinh All of your tests are passing?

@allroundexperts
Copy link
Contributor

allroundexperts commented Jul 24, 2023

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
Screen.Recording.2023-07-24.at.7.57.33.PM.mov
Mobile Web - Chrome
Screen.Recording.2023-07-24.at.8.06.51.PM.mov
Mobile Web - Safari
Screen.Recording.2023-07-24.at.8.05.24.PM.mov
Desktop
Screen.Recording.2023-07-24.at.8.00.16.PM.mov
iOS
Screen.Recording.2023-07-24.at.8.08.08.PM.mov
Android
Screen.Recording.2023-07-24.at.8.08.53.PM.mov

@hoangzinh
Copy link
Contributor Author

@hoangzinh All of your tests are passing?

Sorry for late response. Yeah. I have tested several cases, both adding emoji (to ensure it won't break add emoji) and the main issues we're fixing.

@@ -55,6 +55,7 @@ const defaultProps = {

function AddReactionBubble(props) {
const ref = useRef();
useEffect(() => EmojiPickerAction.resetEmojiPopoverAnchor, []);
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this needed? Didn't we decide to not worry about this component?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I thought we agreed to fix this issue as well #21982

#17603 (comment).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I mean originally, we would like to fix #17603 and #21982 in this PR, won't we?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yep. We do. Apologies for the bump. I lost the context.

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Looks good!

@melvin-bot melvin-bot bot requested a review from Li357 July 24, 2023 23:32
Copy link
Contributor

@Li357 Li357 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for thoroughly testing!

@Li357 Li357 merged commit 8b23658 into Expensify:main Jul 25, 2023
@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/Li357 in version: 1.3.46-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Li357 in version: 1.3.47-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.46-2 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.47-6 🚀

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

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.

4 participants