Make optimistic reportActions appear last

[roryabraham]

Details

#13250 (comment)

Fixed Issues

$ #13250

Tests

1. Go offline.
2. Send 5 messages: 1,2,3,4,5
3. Come back online.
4. Verify that the messages do not reshuffle.
5. Verify that the last message you sent appears on the report in the LHN and does not reshuffle.
6. Click out of the chat and back into it.
7. Verify that your own chats are not appearing as unread.
8. Delete the last reportAction.
9. **Verify that the LHN shows 4 as the message preview for this report.

• Verify that no errors appear in the JS console

Offline tests

All the tests are offline tests 😉

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

web.mov

Mobile Web - Chrome

AndroidWeb.mov

Mobile Web - Safari

RPReplay_Final1678801099.MP4

Desktop

Desktop.mov

iOS

RPReplay_Final1678827873.MP4

Android

Android.mov

[MelvinBot]

@Santhosh-Sellavel @cristipaval 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]

[Santhosh-Sellavel]

Messages do not reshuffle, but I noticed the following bugs

• LHN showed a wrong recent message for a few seconds (Check between the 18th - 21st second in the below video)
• New indicator is shown for our own messages (Check between the 21st - 25th second in the below video)

Screen.Recording.2023-03-15.at.6.17.50.PM.mov

[roryabraham]

Thanks for testing @Santhosh-Sellavel, those bugs should be fixed now. Updated the test & QA steps accordingly.

[mountiny]

Looks good, left one question. @Santhosh-Sellavel would you be able to re-test again?

[Santhosh-Sellavel]

Yes will do today

[Santhosh-Sellavel]

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

Screen.Recording.2023-03-24.at.12.38.16.AM.mov

Mobile Web - Chrome

Screen_Recording_20230324_010359_Chrome.mp4

Mobile Web - Safari

RPReplay_Final1679600290.MP4

Desktop

Screen.Recording.2023-03-24.at.12.57.25.AM.mov

iOS

Unable to test this

Android

Android_Screen.mp4

[Santhosh-Sellavel]

Can someone anyone of you test this one on iOS Native alone on a real device cc: @cristipaval or @mountiny

I tested on other platforms it works well!

[mountiny]

Tested in the emulator, which was not great for the reshuffling but we can assume that works fine across platforms, however, when I deleted the last reportAction, the new unread message marker appeared above 2.

I am not sure if this is a regression from this PR tho, could you reproduce this on @Santhosh-Sellavel ?

Screen.Recording.2023-03-24.at.17.37.23.mp4

[Santhosh-Sellavel]

@mountiny Force offline is useless here, actions are executed data is sent to server only fetch is pending.

[mountiny]

@mountiny Force offline is useless here, actions are executed data is sent to server only fetch is pending.

Gotcha, I unfortunatelly dont have this running on my device, lets try the Ready to build label 🤓

[roryabraham]

@mountiny just FYI you need to add the Ready to Build label then go manually trigger the test build in the GitHub Actions console. We could change that if we wanted to, but haven't yet.

[mountiny]

just FYI you need to add the Ready to Build label then go manually trigger the test build in the GitHub Actions console. We could change that if we wanted to, but haven't yet.

I was just wondering whats going on, there there is this SO for anyone internal https://stackoverflowteams.com/c/expensify/questions/15195/15196#15196 comes across

[OSBotify]

🧪🧪 Use the links below to test this build in android and iOS. Happy testing! 🧪🧪

android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/15942/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/15942/index.html
desktop 💻	web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/15942/NewExpensify.dmg	https://15942.pr-testing.expensify.com

[mountiny]

@Santhosh-Sellavel Can you test now if you have physical iPhone?

[cristipaval]

Tested with my iPhone and it works.

RPReplay_Final1679692996.MP4

[roryabraham]

Soooo, let's merge this then? 🙂

[MelvinBot]

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

[mountiny]

All tests have passed, not an emergency

[OSBotify]

🚀 Deployed to staging by https://github.com/mountiny in version: 1.2.90-4 🚀

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

[Santhosh-Sellavel]

@mountiny My checklist was not completed that's why an emergency was added

[Santhosh-Sellavel]

@mountiny @roryabraham

I investigated this further.

As we know you tested the above with forceOffline, were actions are executed data is sent to the server only fetch is pending, it's pretty much online case/

So I just the tested this PR for online case, I see shuffling of messages

Screen.Recording.2023-03-27.at.7.26.47.PM.mov

[Santhosh-Sellavel]

The above doesn't happen on staging, it would cause a regression. We should handle this before deploying @roryabraham

Screen.Recording.2023-03-27.at.7.34.15.PM.mov

[mountiny]

@roryabraham I think we should revert this one, there is couple of regressions:

• https://expensify.slack.com/archives/C049HHMV9SM/p1679918995450319

Also sending a message in a new workspace admins chats puts the messages above the CREATED report action.

[Santhosh-Sellavel]

@roryabraham please tag me for review in the new PR thanks!

[OSBotify]

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.90-7 🚀

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

[roryabraham]

Will do!