Only debounce saving draft when user is typing #11552

youssef-lr · 2022-10-03T21:32:43Z

Details

We were debouncing the call to Report.saveReportComment even when the change in comment is not coming from the user typing. This caused a race condition between these two calls:

componentDidUpdate calls debounced Report.saveReportComment (through updateComment) with previous Onyx state which contains the draft.
submitForm calls debounced Report.saveReportComment (through updateComment) with new empty comment to clear the composer.

Fixed Issues

$ #11526

Tests

Test 1

Open a blank conversation with no past messages.
Type in something, hit send.
Verify the text sent does not reappear in the composer.

Test 2

Open any conversation.
Type something in the composer but do not hit send, refresh the page (On mobile, close and then re-open the app).
Hit send.
Verify the text sent does not reappear in the composer.

PR Review Checklist

Contributor (PR Author) Checklist

PR Reviewer Checklist

The Contributor+ will copy/paste it into a new comment and complete it after the author checklist is completed

QA Steps

Test 1

Open a blank conversation with no past messages.
Type in something, hit send.
Verify the text sent does not reappear in the composer.

Test 2

Open any conversation.
Type something in the composer but do not hit send, refresh the page (On mobile, close and then re-open the app).
Hit send.
Verify the text sent does not reappear in the composer.

Screenshots

Web

SR.-.Web.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

github-actions · 2022-10-03T21:33:05Z

⚠️ ⚠️ Heads up! This pull request has the CP Staging label. ⚠️ ⚠️
Merging it will cause it to be immediately deployed to staging, even if the open StagingDeployCash deploy checklist is locked.

tgolen

This looks OK, but I've got this nagging feeling that I don't know that componentDidUpdate() should be calling updateComment() directly. It feels like there is a lot of logic in updateComment() that is unnecessary in that context, but maybe I am wrong. Same thing goes for componentDidMount() and all the other methods calling updateComment(). It's like updateComment() is just a catch-all for a bunch of different things, and I think race conditions like this are a good indication that this is a bad pattern.

tgolen · 2022-10-03T22:00:19Z

Can you please add videos from the different platforms to the description?

tgolen · 2022-10-03T22:01:05Z

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 verified tests pass on all platforms & I tested again on:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 */
- Any functional components have the displayName property
- 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

tgolen · 2022-10-03T22:18:31Z

BUG - WEB: While doing test 1, I can still reproduce the problem.

Type a new comment
Press enter or send very quickly after finished typing

Actually happening: Draft message disappears, but then reappears after a couple of seconds

Expected to happen: Draft message disappear forever

BUG: - WEB: While doing test 2, when I refresh the page, the draft message is no longer in the composer, it is blank, so the test cannot be performed.

Type a new comment
Refresh the page

Actually happening: Draft message disappears

Expected to happen: Draft message is still there

youssef-lr · 2022-10-03T22:39:01Z

BUG - WEB: While doing test 1, I can still reproduce the problem.

Type a new comment
Press enter or send very quickly after finished typing
Actually happening: Draft message disappears, but then reappears after a couple of seconds

Good catch, I just pushed a fix for this. Basically when you type something and then quickly press enter, a few ms later the debounced saveReportComment will save to Onyx what you were typing. So I went with cancelling it right before we submit the form.

BUG: - WEB: While doing test 2, when I refresh the page, the draft message is no longer in the composer, it is blank, so the test cannot be performed.

Sorry should have been more clear, but you need to wait a second or two for Onyx state to be saved before refreshing. If you refresh right away the state won't be saved as it's debounced.

Adding recordings shortly. Let me know if the last commit fixes the issues!

deetergp

Code looks good to me and test well on desktop, web, & mobile web. I'm assuming this can't be tested in native mobile since the testing steps require a refresh?

youssef-lr · 2022-10-03T23:01:19Z

I'm assuming this can't be tested in native mobile since the testing steps require a refresh?

Good catch. For mobile native we can close/reopen the app to simulate the same scenario. Will update the tests in the issue.

deetergp · 2022-10-03T23:15:50Z

Confirmed tests pass on both native mobile platforms 👍

youssef-lr · 2022-10-04T09:12:52Z

It feels like there is a lot of logic in updateComment() that is unnecessary in that context, but maybe I am wrong. Same thing goes for componentDidMount() and all the other methods calling updateComment(). It's like updateComment() is just a catch-all for a bunch of different things, and I think race conditions like this are a good indication that this is a bad pattern.

@tgolen I totally agree. I think we may need to rethink how we're using updateComment in that file and potentially refactor it to be more predictable. I'll create a separate issue for this.

tgolen · 2022-10-04T21:49:48Z

OK, I've completed testing and the checklist, so I will merge this.

melvin-bot · 2022-10-04T21:50:02Z

@tgolen looks like this was merged without passing tests. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

youssef-lr · 2022-10-04T21:52:37Z

Tests passed Melvin.

mallenexpensify · 2022-10-05T17:15:27Z

What's status on this? I see the CP Staging label, should this be fixed on staging now?

tgolen · 2022-10-05T21:00:47Z

It should be... but it looks like it wasn't CPed for some reason. @AndrewGable are you seeing issues with the CP staging at all this week?

OSBotify · 2022-10-06T00:45:32Z

🚀 Deployed to staging by @tgolen in version: 1.2.12-0 🚀

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

OSBotify · 2022-10-11T23:14:59Z

🚀 Deployed to production by @AndrewGable in version: 1.2.12-4 🚀

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

…_reappearing Only debounce saving draft when user is typing

Only debounce saving draft when user is typing

585fa43

youssef-lr self-assigned this Oct 3, 2022

youssef-lr requested a review from a team as a code owner October 3, 2022 21:32

youssef-lr added the CP Staging label Oct 3, 2022

melvin-bot bot requested review from techievivek and removed request for a team October 3, 2022 21:33

youssef-lr requested a review from a team October 3, 2022 21:33

melvin-bot bot requested review from deetergp and removed request for a team October 3, 2022 21:33

tgolen previously approved these changes Oct 3, 2022

View reviewed changes

Cancel debounced saving of draft when we submit the form

4a9d112

youssef-lr dismissed tgolen’s stale review via 4a9d112 October 3, 2022 22:36

deetergp previously approved these changes Oct 3, 2022

View reviewed changes

Cancel saving draft before resetting composer

84e9841

youssef-lr dismissed deetergp’s stale review via 84e9841 October 4, 2022 02:12

srikarparsi self-requested a review October 4, 2022 06:53

deetergp approved these changes Oct 4, 2022

View reviewed changes

tgolen merged commit 1a42cf8 into main Oct 4, 2022

tgolen deleted the youssef_fix_message_reappearing branch October 4, 2022 21:49

melvin-bot bot added the Emergency label Oct 4, 2022

youssef-lr removed the Emergency label Oct 4, 2022

AndrewGable mentioned this pull request Oct 5, 2022

Chat - When sending a message to a new user, it is repeated and remains in the compose box #11526

Closed

OSBotify mentioned this pull request Oct 5, 2022

Deploy Checklist: New Expensify 2022-10-05 #11623

Closed

48 tasks

smrutiparida pushed a commit to autosave-app/App that referenced this pull request Oct 13, 2022

Merge pull request Expensify#11552 from Expensify/youssef_fix_message…

47a04cc

…_reappearing Only debounce saving draft when user is typing

parasharrajat mentioned this pull request Apr 17, 2023

[HOLD for payment 2023-04-24] [$1000] When sending an attachment, along with text, if you hit enter twice quickly the text message is duplicated. #15954

Closed

6 tasks

parasharrajat mentioned this pull request Aug 11, 2023

[HOLD] [$1000] The send button doesn't being activated immediately #22667

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Only debounce saving draft when user is typing #11552

Only debounce saving draft when user is typing #11552

youssef-lr commented Oct 3, 2022 •

edited

Loading

github-actions bot commented Oct 3, 2022

tgolen left a comment

tgolen commented Oct 3, 2022

tgolen commented Oct 3, 2022 •

edited

Loading

tgolen commented Oct 3, 2022 •

edited

Loading

youssef-lr commented Oct 3, 2022 •

edited

Loading

deetergp left a comment

youssef-lr commented Oct 3, 2022

deetergp commented Oct 3, 2022

youssef-lr commented Oct 4, 2022 •

edited

Loading

tgolen commented Oct 4, 2022

melvin-bot bot commented Oct 4, 2022

youssef-lr commented Oct 4, 2022

mallenexpensify commented Oct 5, 2022

tgolen commented Oct 5, 2022

OSBotify commented Oct 6, 2022

OSBotify commented Oct 11, 2022

Only debounce saving draft when user is typing #11552

Only debounce saving draft when user is typing #11552

Conversation

youssef-lr commented Oct 3, 2022 • edited Loading

Details

Fixed Issues

Tests

Test 1

Test 2

PR Review Checklist

Contributor (PR Author) Checklist

PR Reviewer Checklist

QA Steps

Test 1

Test 2

Screenshots

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

github-actions bot commented Oct 3, 2022

tgolen left a comment

Choose a reason for hiding this comment

tgolen commented Oct 3, 2022

tgolen commented Oct 3, 2022 • edited Loading

tgolen commented Oct 3, 2022 • edited Loading

youssef-lr commented Oct 3, 2022 • edited Loading

deetergp left a comment

Choose a reason for hiding this comment

youssef-lr commented Oct 3, 2022

deetergp commented Oct 3, 2022

youssef-lr commented Oct 4, 2022 • edited Loading

tgolen commented Oct 4, 2022

melvin-bot bot commented Oct 4, 2022

youssef-lr commented Oct 4, 2022

mallenexpensify commented Oct 5, 2022

tgolen commented Oct 5, 2022

OSBotify commented Oct 6, 2022

OSBotify commented Oct 11, 2022

youssef-lr commented Oct 3, 2022 •

edited

Loading

tgolen commented Oct 3, 2022 •

edited

Loading

tgolen commented Oct 3, 2022 •

edited

Loading

youssef-lr commented Oct 3, 2022 •

edited

Loading

youssef-lr commented Oct 4, 2022 •

edited

Loading