Prevent crash after interacting with reaction tooltip

[marcaaron]

Details

• Fixes a crash after the user logs out post triggering an emoji tooltip
• There was also some incorrect logic e.g. setting the defaultProps to be the withCurrentUserPersonalDetails
• Added the accountID to the current user personal details HOC as a convenience
• The HOC was also not being used so the proptypes looked to be incorrect as well in the ReactionTooltipContent emoji

Fixed Issues

$ #18034

Tests

1. Create a chat between 2 users
2. As one user leave a reaction
3. Hover over the reaction to reveal the tooltip
4. Log out
5. Verify there is no crash

• Verify that no errors appear in the JS console

NOTE: Tooltips don't exist on native so we can skip tests on all platforms besides web and desktop.

Offline tests

N/A

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

Desktop

[MelvinBot]

@s77rt @hayata-suenaga One of you needs to 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]

[s77rt]

I will review asap. I just noted a bug, on first hover the tooltip looks weird

[marcaaron]

Yeah I saw this on main as well so not going to address it here - but maybe it has been reported already (I'd be surprised if not - but if so free moolah haha)

[s77rt]

@marcaaron I can't reproduce the bug on main. I can only reproduce after applying the changes on this PR. Can you please check again?

BTW, the idea for the fix here is to add a fallback accountID (0) and the rest is polish, is that about right? Do you think we can prevent such components from re-rendering on logout, that should fix the root cause. I think many components will try to re-render due to the change on onyx data, others will not because they get unmounted first (are we in a race condition here?)

[marcaaron]

I did check. Though, what about this PR could be affecting the styles? 🤔

@hayata-suenaga would you maybe like to be a 3rd party and help us test here?

BTW, the idea for the fix here is to add a fallback accountID (0) and the rest is polish, is that about right?

It's the material change that fixes the crash. Though, I might be misunderstanding the comment about "polish". There were several things being done wrong and we fixed them, no?

Do you think we can prevent such components from re-rendering on logout, that should fix the root cause.

Honestly, I'm open to ideas here, but can't really think of what the alternative would be. Let's hear the suggestions if you've got them 😄

I think many components will try to re-render due to the change on onyx data, others will not because they get unmounted first (are we in a race condition here?)

I'm not sure if it's a clearly defined problem. What are these "many components"? Which data is changing? What's the alternative?

[marcaaron]

Maybe it is fixed. I will try merging main.

[marcaaron]

Hmm what's weird is that switching away from the browser and switching back will fix this. 🤷‍♂️ pretty stumped about it.

[s77rt]

It's the material change that fixes the crash

Can you please explain that? I think the crash is happening because on logout the ReactionTooltipContent re-renders due to the use of withPersonalDetails HOC that uses withOnyx that re-render child if personalDetails value change.

[hayata-suenaga]

@marcaaron could you kindly tell me which line of code was causing the crash? I assume somewhere that was trying to access a property of a user information that doesn't exist?

because on logout the ReactionTooltipContent re-renders due to the use of withPersonalDetails HOC that uses withOnyx that re-render child if personalDetails value change.

so before the authentication state from the Onyx SESSION data changes and the screen being display switches here, the user information on Onyx changes first and that causes re-renders of the current child components?

if this is the case, as @s77rt suggested here we might have several components where this same kind problem already exists

[marcaaron]

Can you please explain that?

Sorry, I'm not sure what needs explaining. The cause of the crash is because we were casting an accountID to a string when it was undefined. The material change that fixes it was making sure that the accountID is never undefined.

[marcaaron]

if this is the case, as @s77rt suggested #18037 (comment) we might have several components where this same kind problem already exists

I think the problem is not very complex tbh. We should not be trying to access values that are undefined. This is the same whether you are in a React component or anywhere else. It's up to the developer to use their own common sense and think about whether the value may become undefined and for what reasons when they access it.

WRT Onyx, yeah, we need to use a default value in most cases so I added one here. The value could not exist, it could be removed, etc. We must write code that guards against it somehow.

Anyways, I am open to suggestions. But if we are asking solve a problem that "might exist" then I will ask to first fix the problem that exists right now while we think about the better way.

[s77rt]

@marcaaron Can you please fix the reported bug here #18037 (comment)

[hayata-suenaga]

Anyways, I am open to suggestions. But if we are asking solve a problem that "might exist" then I will ask to first fix the problem that exists right now while we think about the better way.

Yes I agree. Let's fix problems as they arise. I think when we migrate the codebase to Typescript, we can avoid most of this type of bugs.

[marcaaron]

@marcaaron Can you please fix the reported bug here #18037 (comment)

I'm not seeing what would cause it. Do you have any ideas?

[s77rt]

Checking...

[s77rt]

The problem is the swap of withPersonalDetails/withCurrentUserPersonalDetails in ReactionTooltipContent.

1. withCurrentUserPersonalDetails uses withOnyx and this HOC at the very first render returns null.
2. Technically returning null means that the component is rendered.
3. Now ReactionTooltipContent is rendered we measure it's content width, and the result will be 0.

This does not happen with withPersonalDetails since it does not use withOnyx directly. The onyx values are passed through context and the very first render will return the children as is.

[marcaaron]

Ugh! Nice spot @s77rt - I could not see it at all... I think if we just pass the currentUserPersonalDetails down as props it will fix this issue.

[marcaaron]

Updated. Thanks for the push @s77rt !

[s77rt]

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

desktop.mp4

iOS

Android

[s77rt]

Thanks @marcaaron and @hayata-suenaga. Let's get this merged.

[s77rt]

LGTM! 🚀

[hayata-suenaga]

LGTM!

[hayata-suenaga]

there is a merge conflict

[marcaaron]

Updated.

[hayata-suenaga]

LGTM

[s77rt]

Wait a sec

[s77rt]

diff --git a/src/components/Reactions/ReportActionItemReactions.js b/src/components/Reactions/ReportActionItemReactions.js
index 5cb2d5d6ad..948a01d50b 100644
--- a/src/components/Reactions/ReportActionItemReactions.js
+++ b/src/components/Reactions/ReportActionItemReactions.js
@@ -84,7 +84,7 @@ const ReportActionItemReactions = (props) => {
                     props.toggleReaction(emoji);
                 };
                 const onReactionListOpen = (event) => {
-                    const users = PersonalDetailsUtils.getPersonalDetailsByIDs(reactionUsers);
+                    const users = PersonalDetailsUtils.getPersonalDetailsByIDs(reactionUsers, props.currentUserPersonalDetails.accountID);
                     ReactionList.showReactionList(event, popoverReactionListAnchor.current, users, reaction.emoji, emojiCodes, reactionCount, hasUserReacted);
                 };
 

We added another call to PersonalDetailsUtils.getPersonalDetailsByIDs just recently by #15685.

That was a close one 😅

[marcaaron]

PLEASE GODS LET ME MERGE THE PR 🙀 🙏 😂

[s77rt]

Let's merge this 🚀!

[hayata-suenaga]

sorry for the delay!

[OSBotify]

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.13-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.13-5 🚀

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