Fix crash when edit a message after coming back from a child report #21227

bernhardoj · 2023-06-21T16:48:16Z

Details

Editing a message after coming back from a child report will crash the app. It's because the global flatListRef is null.

Fixed Issues

$ #20847
PROPOSAL: #20847 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

As this PR replaces the code from the reaction list PR here #20739, we also need to test it.

NOTE: there is currently a bug with the emoji picker here #21101

Edit message

Open any chat
Send a message
Press "Reply in thread" on the message
Go back
Edit the message
Verify the message enters edit mode and no crash

Reaction list

Open any chat
Send a message
Add an emoji reaction to the message
Press "Reply in thread" on the message
Go back
Long press/right-click the emoji reaction
Verify the reaction list shows

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

edit message

web.edit.mov

reaction list

web.reaction.list.mov

Mobile Web - Chrome

edit message

android.mweb.edit.mov

reaction list

android.mweb.reaction.list.mov

Mobile Web - Safari

edit message

mweb.safari.edit.mov

reaction list

mweb.safari.reaction.list.mov

Desktop

edit message

desktop.edit.mov

reaction list

desktop.reaction.list.mov

iOS

edit message

ios.edit.mov

reaction list

ios.reaction.list.mov

Android

reaction list

android.reaction.list.mov

edit message

android.edit.mov

melvin-bot · 2023-06-21T16:48:20Z

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

bernhardoj · 2023-06-21T16:53:03Z

Here are a few additional recordings to test if other things still work as normally:

Auto-scroll to bottom

web.auto.scroll.mov

ios.auto.scroll.mov

Note that the auto-scroll after doing a money request does not work on a small screen except in iOS native. This also happens in main.

Will not auto-scroll if the message coming from another user

Screen.Recording.2023-06-22.at.00.34.47.mov

Auto-scroll on edit

Screen.Recording.2023-06-22.at.00.52.08.mov

bernhardoj · 2023-06-23T08:57:49Z

@fedirjh please have a look when you have the time

fedirjh

Looks good , left some comments

fedirjh · 2023-06-23T10:07:57Z

src/components/Reactions/ReportActionItemReactions.js

@@ -47,7 +47,7 @@ const defaultProps = {
 };

 function ReportActionItemReactions(props) {
-    const reactionListRef = useContext(ReactionListRefContext);
+    const {reactionListRef} = useContext(ReportScreenContext);


As this is a functional component, why we don't just use useReportScrollManager ? we should export refs from the hooks.

This one is reactionListRef, not the flat list one 😄

But we use the same context ? inside the useReportScrollManager we should export both refs and use each ref accordingly .

I think that would be weird useReportScrollManager exporting reaction list ref. Reaction list does not belong to report scroll manager

fedirjh · 2023-06-23T10:09:09Z

src/hooks/useReportScrollManager/index.js

+        flatListRef.current.scrollToOffset({animated: false, offset: 0});
+    };
+
+    return {scrollToIndex, scrollToBottom};


I think we should export the ref flatListRef so we can use this hook in functional component.

fedirjh · 2023-06-23T10:10:10Z

src/libs/ReportScrollManager/index.js

 * @param {Object} index
 * @param {Boolean} isEditing
 */
-function scrollToIndex(index, isEditing) {
+function scrollToIndex(ref, index, isEditing) {


Let's add safety checks here

if (!ref.current) { return; }

Sorry for this but it could be simplified

if (!ref.current || isEditing) { return; }

Let's add safety checks for all other methods

Updated. Added in the hooks too

fedirjh · 2023-06-23T10:14:39Z

src/pages/home/report/ReportActionsList.js

@@ -78,6 +78,7 @@ function keyExtractor(item) {
 }

 function ReportActionsList(props) {
+    const {flatListRef} = useContext(ReportScreenContext);


Here as well we should use the hook to get the ref.

fedirjh · 2023-06-23T10:16:30Z

src/pages/iou/steps/MoneyRequestConfirmPage.js

+                        onConfirm={createTransaction}
+                        onSendMoney={sendMoney}


Why this change ?

ReportScrollManager.scrollToBottom is removed leaving

onConfirm={(selectedParticipants) => createTransaction(selectedParticipants)}

hmm I was asking about removing ReportScrollManager.scrollToBottom

Ah, that's because we can't have ReportScreenContext inside MoneyRequestConfirmPage. That's why I use Report.notifyNewAction approach to replace it.

Thank you , that make sense

Why it was added in the first place

So, previously all money request page (amount, participants, confirm) is placed inside MoneyRequestModal. What the PR #17964 did is separate each page into its own screen. So, all the logic there is already been there before the PR.

The changes included in this PR will break the rule in this comment, we will not have one source of truth

No, it won't. Whether we receive the event from Pusher, add a new comment from Report.addActions, or create a new money request, all of them use notifyNewAction that will trigger the callback which is our source of truth.

So, all the logic there is already been there before the PR.

Aha , I found the PR that introduced the changes : #15820

I found the same approach you implemented , was suggested before in this proposal , I am not sure why we didn’t go with this approach before 🤔

Huh, so the PR is just a few months ago. I expected it about a year ago 😂.

I am not sure why we didn’t go with this approach before

I guess it's much simpler using ReportScrollManager.scrollToBottom, but this is an interesting find.

I guess it's much #15540 (comment) using ReportScrollManager.scrollToBottom

Yeah that seems the case.

fedirjh · 2023-06-23T16:42:40Z

@bernhardo we have a bug , here is step to reproduce :

Navigate to report
Scroll to top and edit a comment
keep the edit input open
Navigate to LHN
Navigate back to the same report where the edit input is open
Notice that the report scroll to bottom and the keyboard is open

Expected result: it should scroll to the open edit input

Simulator.Screen.Recording.-.iPhone.14.-.2023-06-23.at.17.34.13.mp4

We have this warning as well

bernhardoj · 2023-06-24T04:27:22Z

it should scroll to the open edit input

I think it's related to the ref warning. Btw, is it a new feature to auto-scroll to edit composer? I found it annoying when the message we edit is far at the top which is not mounted on the screen yet. When we scroll up, it will suddenly auto-scroll to the edit composer which distracts the user.

Screen.Recording.2023-06-24.at.12.24.27.mov

We have this warning as well

I forget to export the ref in index.native.js 🤦

fedirjh · 2023-06-24T09:38:55Z

Btw, is it a new feature to auto-scroll to edit composer?

Nope, this is an old feature , It was working like that before this PR.

I found it annoying when the message we edit is far at the top which is not mounted on the screen yet. When we scroll up, it will suddenly auto-scroll to the edit composer which distracts the user.

Maybe we can report that as a new issue. This feature doesn’t not always works , I already raised some concerns about it here #20847 (comment)

fedirjh · 2023-06-24T10:00:58Z

@bernhardoj The reaction picker is not showing after we go back from threads. It doesn’t not work on main as well but since you included that in the tests , we should fix it as well. Steps:

Open any chat
Send a message
Add an emoji reaction to the message
Press "Reply in thread" on the message
Go back
Click the emoji reaction picker
Verify the reaction list shows

Bug.mp4

bernhardoj · 2023-06-24T10:02:51Z

Yes, there is an issue for that here #21101.

The one that I included in the test is the reaction list. (long press this one)

fedirjh · 2023-06-24T10:07:08Z

I think as the fix is simple we can include it in this PR ? for the bounty we can discuss that later on the 2nd issue. I see that there is only one proposal from ~~you~~ oh it's actually from other contributor , ~~so it should be fine to fix it here~~.

fedirjh · 2023-06-24T10:14:34Z

@bernhardoj Let me know if we can cover that bug is this PR.

bernhardoj · 2023-06-24T10:16:25Z

Yep, it's quite simple. I will include it here.

bernhardoj · 2023-06-24T10:39:16Z

UPDATE: turns out it's not that simple 😂.

The context approach for the emoji picker won't work for the context menu

This is because the context menu (PopoverReportActionContextMenu) is placed in Expensify.js which is higher in the tree than ReportScreen.

App/src/Expensify.js

Lines 183 to 189 in 820fa93

    
           return ( 
        
               <DeeplinkWrapper> 
        
                   {shouldInit && ( 
        
                       <> 
        
                           <KeyboardShortcutsModal /> 
        
                           <GrowlNotification ref={Growl.growlRef} /> 
        
                           <PopoverReportActionContextMenu ref={ReportActionContextMenu.contextMenuRef} />

I think the proposal here that moves the emoji picker to Expensify.js is the only way. So, let's handle the emoji picker in that issue.

fedirjh · 2023-06-24T11:11:30Z

UPDATE: turns out it's not that simple 😂.

@bernhardoj Yeah no problem, I had already considered that, which is why I asked for confirmation. 😅

Next step is updating the Reaction list test , Going back from thread is the bug , so we should consider that.

bernhardoj · 2023-06-24T11:16:23Z

Next step is updating the Reaction list test

Emm, what update exactly needs to be done in the test step?

fedirjh · 2023-06-24T12:24:38Z

Emm, what update exactly needs to be done in the test step?

This part

Press "Reply in thread" on the message

Go back

Long press/right-click the emoji reaction

Verify the reaction list shows

This will fail, if we navigate back from thread. I suggest another steps

Press "Reply in thread" on the message
Send another message in thread
Long press/right-click the emoji reaction on the newly created message
Verify the reaction list shows

bernhardoj · 2023-06-24T13:09:22Z

This will fail, if we navigate back from thread.

Sorry, I don't get what you mean by "fail".

Btw, the test step we have is the correct one. The new test step you gave will just work well in prod because it's not the bug. The bug is when you go back from the thread.

fedirjh · 2023-06-24T13:16:48Z

Btw, the test step we have is the correct one.

The test step is confusing me and will confuse the QA , so let's update it and make it clear

Long press/right-click the emoji reaction

which emoji reaction are you referring to ?

bernhardoj · 2023-06-24T13:21:35Z

which emoji reaction are you referring to ?

This (added this image to the test step)

The test step is confusing me

The step is similar to the edit message step

fedirjh · 2023-06-24T13:25:01Z

I think we should include a notice for the QA about the picker bug, it's easy to get confused between emoji reacted list and emoji list (emoji list in the picker)

bernhardoj · 2023-06-24T13:33:12Z

Done.

fedirjh · 2023-06-24T14:59:09Z

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

2-Chrome.mov

Mobile Web - Safari

3-Safari.mov

Desktop

Desktop.mov

iOS

5-IOS.mov

Android

android.mov

fedirjh

Looks good to me and tests well.

🎀 👀 🎀 C+ reviewed

amyevans

Looks good!

OSBotify · 2023-06-26T15:56:42Z

✋ 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 · 2023-06-26T21:06:25Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.33-0 🚀

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

Beamanator

few little questions :D

src/pages/home/ReportScreen.js

OSBotify · 2023-06-28T14:06:49Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.33-4 🚀

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

replace global ref with local ref

4ba3da9

bernhardoj requested a review from a team as a code owner June 21, 2023 16:48

melvin-bot bot removed the request for review from a team June 21, 2023 16:48

melvin-bot bot requested a review from fedirjh June 21, 2023 16:48

bernhardoj added 2 commits June 22, 2023 00:53

prettier

4c0a531

Merge branch 'main' into fix/20847-scroll-manager

217059f

fedirjh suggested changes Jun 23, 2023

View reviewed changes

bernhardoj added 3 commits June 23, 2023 18:33

add null check

fe19af2

export the ref

c6fa8b6

add more null checks

cba1d02

export ref

90dee15

fedirjh approved these changes Jun 25, 2023

View reviewed changes

melvin-bot bot requested a review from amyevans June 25, 2023 14:59

amyevans approved these changes Jun 26, 2023

View reviewed changes

amyevans merged commit c261901 into Expensify:main Jun 26, 2023

OSBotify mentioned this pull request Jun 26, 2023

Deploy Checklist: New Expensify 2023-06-26 #21650

Closed

23 tasks

bernhardoj mentioned this pull request Jun 27, 2023

[HOLD for payment 2023-07-17] [$250] Migrate ReportActionsView.js to function component #16267

Closed

1 task

lanitochka17 mentioned this pull request Jun 27, 2023

[HOLD] [$1000] Chat - Site preview is not updated once link is changed #21729

Closed

6 tasks

Beamanator reviewed Jun 28, 2023

View reviewed changes

src/pages/home/ReportScreen.js Show resolved Hide resolved

src/pages/home/ReportScreen.js Show resolved Hide resolved

melvin-bot bot mentioned this pull request Jun 28, 2023

[HOLD for payment 2023-07-05] [$1000] Chat - App crashes when edit comment clicked for mark down message #20847

Closed

6 tasks

Fix crash when edit a message after coming back from a child report #21227

Fix crash when edit a message after coming back from a child report #21227

Conversation

bernhardoj commented Jun 21, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 21, 2023

bernhardoj commented Jun 21, 2023

bernhardoj commented Jun 23, 2023

fedirjh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fedirjh Jun 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bernhardoj Jun 25, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fedirjh commented Jun 23, 2023

bernhardoj commented Jun 24, 2023

fedirjh commented Jun 24, 2023

fedirjh commented Jun 24, 2023

bernhardoj commented Jun 24, 2023

fedirjh commented Jun 24, 2023 • edited Loading

fedirjh commented Jun 24, 2023

bernhardoj commented Jun 24, 2023

bernhardoj commented Jun 24, 2023

fedirjh commented Jun 24, 2023

bernhardoj commented Jun 24, 2023

fedirjh commented Jun 24, 2023

bernhardoj commented Jun 24, 2023

fedirjh commented Jun 24, 2023

bernhardoj commented Jun 24, 2023

fedirjh commented Jun 24, 2023

bernhardoj commented Jun 24, 2023

fedirjh commented Jun 24, 2023

Reviewer Checklist

Screenshots/Videos

fedirjh left a comment

Choose a reason for hiding this comment

amyevans left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 26, 2023

OSBotify commented Jun 26, 2023

Beamanator left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 28, 2023

bernhardoj commented Jun 21, 2023 •

edited

Loading

fedirjh Jun 23, 2023 •

edited

Loading

bernhardoj Jun 25, 2023 •

edited

Loading

fedirjh commented Jun 24, 2023 •

edited

Loading