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

[web/desktop] feat: tooltip reaction senders #15671

Merged

Conversation

hannojg
Copy link
Contributor

@hannojg hannojg commented Mar 5, 2023

Details

This implements a tooltip on web / desktop when hovering a reaction.

Screen.Recording.2023-03-05.at.19.50.10.mov

Fixed Issues

$ #15127
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

  • Verify that no errors appear in the JS console
  • Add a reaction to a message
    • Hover over the reaction
    • Verify that the tooltip with the reaction content displays correctly

Offline tests

Same as test steps

QA Steps

Same as test steps

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 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 correct English and 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
    • 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 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-03-06.at.12.42.16.mov
Mobile Web - Chrome

N/A

Mobile Web - Safari

N/A

Desktop
Screen.Recording.2023-03-05.at.19.50.10.mov
iOS

N/A

Android

N/A

…com:margelo/expensify-app-fork into hanno/feat-tolltip-reaction-senders
@hannojg hannojg requested a review from a team as a code owner March 5, 2023 18:52
@hannojg hannojg marked this pull request as draft March 5, 2023 18:52
@melvin-bot melvin-bot bot requested review from bondydaa and removed request for a team March 5, 2023 18:53
@MelvinBot
Copy link

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

@hannojg hannojg changed the title feat: tooltip reaction senders [web/desktop] feat: tooltip reaction senders Mar 6, 2023
@hannojg hannojg marked this pull request as ready for review March 6, 2023 11:43
@hannojg hannojg mentioned this pull request Mar 6, 2023
56 tasks
@luacmartins luacmartins self-requested a review March 8, 2023 12:40
@luacmartins
Copy link
Contributor

@hannojg is this ready for a review?

@stitesExpensify stitesExpensify self-requested a review March 8, 2023 13:57
@hannojg
Copy link
Contributor Author

hannojg commented Mar 8, 2023

Yes, it is now!

@stitesExpensify
Copy link
Contributor

stitesExpensify commented Mar 8, 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 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 correct English and 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 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
2023-03-10_09-46-22.mp4
Mobile Web - Chrome image
Mobile Web - Safari image
Desktop
2023-03-10_09-46-22.mp4
iOS image
Android image

@bondydaa
Copy link
Contributor

bondydaa commented Mar 8, 2023

From the reviewer checklist

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)

Should we add test steps to that ensure a name is removed from the tooltip if the reaction is removed? Maybe like:

  1. Send a message in a public room or group DM
  2. Have 2 different users react with the same reaction to that message
  3. Ensure both users show in the tooltip
  4. Remove the reaction from 1 user
  5. Ensure only 1 user shows in the tooltip when you hover again

@bondydaa
Copy link
Contributor

bondydaa commented Mar 8, 2023

just to give ya'll an idea of when I'll get through the testing, it might not be til friday. I'm WFBoat right now and it's taking forever to try and fetch the branch 😭 , I'll be OOO most of the day tomorrow traveling back to CO so if I can't get it tested today then I'll get it tested Friday and finish off the checklist then.

Copy link
Contributor

@stitesExpensify stitesExpensify left a comment

Choose a reason for hiding this comment

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

Looking good! Excited to see this go out! Just some minor changes

src/libs/getPersonalDetailsByIDs.js Outdated Show resolved Hide resolved
src/components/Reactions/ReactionTooltipContent.js Outdated Show resolved Hide resolved
@stitesExpensify
Copy link
Contributor

just to give ya'll an idea of when I'll get through the testing, it might not be til friday

I can do the testing so that we can get this out a little earlier :)

bondydaa
bondydaa previously approved these changes Mar 13, 2023
@hannojg hannojg dismissed stale reviews from bondydaa and stitesExpensify via e207e9e March 13, 2023 15:54
bondydaa
bondydaa previously approved these changes Mar 13, 2023
luacmartins
luacmartins previously approved these changes Mar 13, 2023
@stitesExpensify
Copy link
Contributor

There is a bug here where the calculated tooltip size is sometimes not correct

@stitesExpensify
Copy link
Contributor

2023-03-13_17-00-23

Copy link
Contributor

@stitesExpensify stitesExpensify left a comment

Choose a reason for hiding this comment

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

Requesting changes so that this doesn't accidentally get merged

@hannojg hannojg dismissed stale reviews from luacmartins and bondydaa via af656ec March 14, 2023 15:56
Copy link
Contributor

@stitesExpensify stitesExpensify left a comment

Choose a reason for hiding this comment

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

Thoughts on this change? I think it makes sense that the default functionality is to get all of the details normally, and then we replace the user only when necessary

src/libs/PersonalDetailsUtils.js Outdated Show resolved Hide resolved
src/libs/PersonalDetailsUtils.js Outdated Show resolved Hide resolved
src/components/Reactions/ReactionTooltipContent.js Outdated Show resolved Hide resolved
src/libs/PersonalDetailsUtils.js Outdated Show resolved Hide resolved
hannojg and others added 5 commits March 14, 2023 12:02
Co-authored-by: Brandon Stites <42391420+stitesExpensify@users.noreply.github.com>
Co-authored-by: Brandon Stites <42391420+stitesExpensify@users.noreply.github.com>
Co-authored-by: Brandon Stites <42391420+stitesExpensify@users.noreply.github.com>
Copy link
Contributor

@stitesExpensify stitesExpensify left a comment

Choose a reason for hiding this comment

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

Looking awesome! Only one more change (maybe)

Copy link
Contributor

@stitesExpensify stitesExpensify left a comment

Choose a reason for hiding this comment

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

Looks great, excited for this!

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM and tests well.

@luacmartins luacmartins merged commit ad1e244 into Expensify:main Mar 14, 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/luacmartins in version: 1.2.85-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 1.2.85-1 🚀

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

@Santhosh-Sellavel
Copy link
Collaborator

This PR caused a regression here, check this Proposal for more details.

@stitesExpensify
Copy link
Contributor

Oops. Not great that we released it with a bug, but it is a pretty hilarious bug to add haha

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.

7 participants