Improve goBack function by adamgrzybowski · Pull Request #26498 · Expensify/App

adamgrzybowski · 2023-09-01T16:35:57Z

Details

This PR improves goBack function so the fallback could be used for reports screens. Additionally, it allows to goBack with more than one route for report screens when using a fallback route

Fixed Issues

$ #26569
PROPOSAL:

Tests

Open a chat with somebody
Request money
Open the request money report
Delete request
Go back
Make sure that you are not on the "not found" page

Verify that no errors appear in the JS console

Offline tests

QA Steps

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 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
  - 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
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

iosWeb.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

melvin-bot · 2023-09-04T13:50:57Z

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

mountiny · 2023-09-04T14:08:24Z

@sobitneupane putting it on hold but please continue with a review and testing please thanks!

OSBotify · 2023-09-04T15:00:47Z

🧪🧪 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/26498/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/26498/index.html

desktop 💻	web 🕸️
❌ FAILED ❌	❌ FAILED ❌
The QR code can't be generated, because the Desktop build failed	The QR code can't be generated, because the web build failed

ShogunFire · 2023-09-21T12:06:05Z

Hello, are you close to merging this ?

mountiny · 2023-09-22T03:17:28Z

@adamgrzybowski can you please resolve conflicts on this one?

mountiny · 2023-09-25T03:07:38Z

@adamgrzybowski bump on the conflicts

adamgrzybowski · 2023-09-25T11:29:35Z

@mountiny done! Thanks for the bump 😄 I completely forgot

mountiny · 2023-09-25T15:17:25Z

@adamgrzybowski jest units failing now, maybe we need to merge main again 🤔

adamgrzybowski · 2023-09-25T17:01:47Z

@mountiny merging main and small adjustments in tests helped. Thanks for noticing the problem! 🙇

mountiny · 2023-09-26T02:07:40Z

@sobitneupane can you please do the checklist today?

sobitneupane · 2023-09-26T06:44:24Z

Yes @mountiny. I will review the PR today.

sobitneupane

Screenshots/Videos

Web

Screen.Recording.2023-09-26.at.14.15.00.mov

Mobile Web - Chrome

Screen.Recording.2023-09-26.at.14.19.20.mov

Mobile Web - Safari

Screen.Recording.2023-09-26.at.14.18.39.mov

Desktop

Screen.Recording.2023-09-26.at.14.28.20.mov

iOS

Screen.Recording.2023-09-26.at.15.05.05.mov

Android

Screen.Recording.2023-09-26.at.15.45.18.mov

sobitneupane

@adamgrzybowski Is it expected that we can navigate to the deleted report by clicking 'go forward' in the browser?

If the transaction report is accessed directly through a deep link, the issue can still be reproduced.

mountiny · 2023-11-09T11:13:49Z

Could you please merge main into the branch to hoopefully resolve the reassure tests

mountiny · 2023-11-10T13:47:17Z

@s77rt What is the latest on the bug, what was the resolution on the Pr you ave linked?

@WojtekBoman lets merge main again since the reassure tests has been fixed there

s77rt · 2023-11-10T14:42:46Z

The bug is due to the use of maintainVisibleContentPosition. We had a similar issue #30423 that was fixed by #30461. It seems that we need to adjust the value of maintainVisibleContentPosition.autoScrollToTopThreshold once again but not sure what value should we use. It may be easier to handle this bug separately and merge this PR (and remove the scroll hack)

WojtekBoman · 2023-11-10T15:08:39Z

I removed this hook from ReportActionsList file

mountiny · 2023-11-10T15:10:17Z

@s77rt could you please retest

s77rt · 2023-11-10T15:12:32Z

@mountiny Just did. Still working as expected but the bug on iOS is still present. Should we create a new issue for that bug?

mountiny · 2023-11-10T15:15:01Z

I am partial on this one, the bug seems to be new, it does not happen in such manner in main, right?

s77rt · 2023-11-10T15:35:01Z

After checking further more I think we can adjust the value in this PR and fix the bug.

maintainVisibleContentPosition.autoscrollToTopThreshold sets the threshold that if the user scrolls beyond that position the auto scroll won't work. Currently it's 64px (variables.listItemHeightNormal) which means if user scrolls or if the height is changed by anything over 64px then the auto scroll won't work. In our case we delete the IOU preview which is 123px in height.

I don't know how we ended up choosing 64px (cc @roryabraham) but it seems too low. Let's create a new variable and set it to 128px. That should do it.

s77rt · 2023-11-13T08:09:43Z

@WojtekBoman Thanks! This is looking good for me

s77rt · 2023-11-13T08:09:54Z

@mountiny Let's merge this 🚀

mountiny

Thanks, I am approving but i would love to see @roryabraham opinion on this before merging

roryabraham

Currently [maintainVisibleContentPosition.autoScrollToTopThreshold is] 64px ...

This was chosen as it's the normal height of a ReportActionItemSingle. When it was added there was a bug when Uploading attachment... was replaced by the image thumbnail. 64px was just enough to fix that bug, and there wasn't any bug with sending IOU requests as far as I remember.

Increasing the autoScrollToTopThreshold to a higher value seems fine to me. But it's not really a perfect solution. ReportActionItem components have non-deterministic height, so if you choose any value, I can write you a message that's taller and if you delete it the same bug will be reproducible. So maybe we could look for a better solution. You don't want to autoScrollToTop if the reportAction in question (at the bottom) is not even visible on the screen. So maybe a reasonable value for autoScrollToTopThreshold is the height of the screen?

mountiny · 2023-11-13T16:05:54Z

Thank you!

So maybe a reasonable value for autoScrollToTopThreshold is the height of the screen?

Given the explanation I think this makes sense, this would have to be dynamic then. @s77rt @WojtekBoman Lets try this out and test if there are any regressions from it. I hink that can be handled in a separate PR though, do you guys agree?

s77rt · 2023-11-13T16:28:43Z

Handling this in a separate PR sounds good

mountiny · 2023-11-13T16:46:04Z

@s77rt ddi you retest after the latest change?

s77rt · 2023-11-13T16:53:07Z

@mountiny Yes (the 128px change - not the height-screen change)

mountiny

Thanks guys! Lets be on a look out for any regressions in the go back logic

OSBotify · 2023-11-13T17:01:18Z

✋ 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-11-14T22:10:16Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.99-0 🚀

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

OSBotify · 2023-11-15T20:53:31Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.99-0 🚀

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

OSBotify · 2023-11-15T21:08:57Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.0-0 🚀

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

shubham1206agra · 2024-01-03T16:15:28Z

src/components/InvertedFlatList/BaseInvertedFlatList.js

 import * as CollectionUtils from '@libs/CollectionUtils';
-import variables from '@styles/variables';
+
+const AUTOSCROLL_TO_TOP_THRESHOLD = 128;


This PR forgot to cover an extra case. More details here #30726

improve goBack function

f747ae9

mountiny assigned adamgrzybowski Sep 1, 2023

mountiny self-requested a review September 1, 2023 17:00

ShogunFire mentioned this pull request Sep 1, 2023

[HOLD for #26498][$1000] Chat - It's not here" displayed when click on back bin after all request money was deleted #24490

Closed

6 tasks

adamgrzybowski mentioned this pull request Sep 4, 2023

[HOLD for payment 2023-11-22] Deleting a request report correctly takes you back to the workspace chat but doesn’t clear the navigation history #26569

Closed

adamgrzybowski marked this pull request as ready for review September 4, 2023 13:50

adamgrzybowski requested a review from a team as a code owner September 4, 2023 13:50

melvin-bot bot removed the request for review from a team September 4, 2023 13:50

melvin-bot bot requested a review from sobitneupane September 4, 2023 13:50

mountiny changed the title ~~Improve goBack function~~ [HOLD freeze] Improve goBack function Sep 4, 2023

mountiny added the Ready To Build label Sep 4, 2023

rojiphil mentioned this pull request Sep 19, 2023

[HOLD 26590] [$500] Web - After deleting IOUTransaction, clicking on back button in IOUReport does not navigate to chatReport #27436

Closed

6 tasks

mountiny changed the title ~~[HOLD freeze] Improve goBack function~~ Improve goBack function Sep 22, 2023

Merge branch 'main' into @swm/improve-goBack-with-fallback-route

0644669

fix typo

881dc84

adamgrzybowski added 2 commits September 25, 2023 18:51

Merge branch 'main' into @swm/improve-goBack-with-fallback-route

3fb6f8e

fix tests

59c3cdc

sobitneupane reviewed Sep 26, 2023

View reviewed changes

Merge branch 'main' into @swm/improve-goBack-with-fallback-route

e1ca40f

WojtekBoman added 2 commits November 10, 2023 15:43

Merge branch 'main' into @swm/improve-goBack-with-fallback-route

f1ba1c7

Remove the useFocusEffect hook from ReportActionsList

aec50d8

Add AUTOSCROLL_TO_TOP_THRESHOLD const

057f055

mountiny approved these changes Nov 13, 2023

View reviewed changes

roryabraham reviewed Nov 13, 2023

View reviewed changes

mountiny approved these changes Nov 13, 2023

View reviewed changes

mountiny merged commit 2033420 into Expensify:main Nov 13, 2023

shubham1206agra mentioned this pull request Nov 14, 2023

[HOLD for payment 2024-01-04] [$500] IOS - A blank spot appears after deleting a money request #30726

Closed

6 tasks

OSBotify mentioned this pull request Nov 14, 2023

Deploy Checklist: New Expensify 2023-11-14 #31324

Closed

OSBotify mentioned this pull request Nov 15, 2023

Deploy Checklist: New Expensify 2023-11-15 #31404

Closed

37 tasks

shubham1206agra reviewed Jan 3, 2024

View reviewed changes

Conversation

adamgrzybowski commented Sep 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Sep 4, 2023

Uh oh!

mountiny commented Sep 4, 2023

Uh oh!

OSBotify commented Sep 4, 2023

Uh oh!

ShogunFire commented Sep 21, 2023

Uh oh!

mountiny commented Sep 22, 2023

Uh oh!

mountiny commented Sep 25, 2023

Uh oh!

adamgrzybowski commented Sep 25, 2023

Uh oh!

mountiny commented Sep 25, 2023

Uh oh!

adamgrzybowski commented Sep 25, 2023

Uh oh!

mountiny commented Sep 26, 2023

Uh oh!

sobitneupane commented Sep 26, 2023

Uh oh!

sobitneupane left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Screenshots/Videos

Uh oh!

sobitneupane left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny commented Nov 9, 2023

Uh oh!

mountiny commented Nov 10, 2023

Uh oh!

s77rt commented Nov 10, 2023

Uh oh!

WojtekBoman commented Nov 10, 2023

Uh oh!

mountiny commented Nov 10, 2023

Uh oh!

s77rt commented Nov 10, 2023

Uh oh!

mountiny commented Nov 10, 2023

Uh oh!

s77rt commented Nov 10, 2023

Uh oh!

s77rt commented Nov 13, 2023

Uh oh!

s77rt commented Nov 13, 2023

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

roryabraham left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny commented Nov 13, 2023

Uh oh!

s77rt commented Nov 13, 2023

Uh oh!

mountiny commented Nov 13, 2023

Uh oh!

s77rt commented Nov 13, 2023

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Nov 13, 2023

Uh oh!

adamgrzybowski commented Sep 1, 2023 •

edited

Loading

sobitneupane left a comment •

edited

Loading