fix: add proper fallback route for private notes pages #28273

BhuvaneshPatil · 2023-09-26T17:27:22Z

Details

When we refresh while on Private Notes Edit page, and try to save the note we are redirected to home page instead of Private Notes View

Fixed Issues

$ #28011
PROPOSAL: #28011 (comment)

Tests

Go to private notes edit page
Refresh the page
Add some notes and click on save button
Verify it takes to Private Notes View Page
GO to Private Notes view page
refresh the page
Click on back button in header
Verify user goes to private notes list page

Verify that no errors appear in the JS console

Offline tests

QA Steps

Open notes edit page for an account
Copy the link to that page
paste the link in separate tab and try to edit the notes
when clicked on save user should be taken to notes view page
paste the link again and open the edit page
when clicked on back button user should be taken to notes view page
Copy the notes view page link page, it looks something like - localhost:8082/r/<reportID>/notes/<accountID>
Paste the link in browser and open
Click on back button in header
User should be take to notes list page

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Web.MacOS.mov

Mobile Web - Chrome

mobile-chrome.mov

Mobile Web - Safari

Mobile.-.Safari.mov

Desktop

Screen.Recording.2023-09-27.at.10.03.15.AM.mov

iOS

IOS.mov

Android

Android.App.mov

melvin-bot · 2023-09-26T17:28:00Z

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

BhuvaneshPatil · 2023-09-26T17:30:22Z

Will post the video in morning.

src/pages/PrivateNotes/PrivateNotesListPage.js

src/pages/PrivateNotes/PrivateNotesEditPage.js

src/pages/PrivateNotes/PrivateNotesViewPage.js

ntdiary · 2023-09-28T06:20:43Z

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 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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

28273-web.mp4

Mobile Web - Chrome

28273-mobile-chrome.mp4

Mobile Web - Safari

28273-mobile-safari.mp4

Desktop

28273-desktop.mp4

iOS

28273-mobile-ios.mp4

Android

28273-mobile-android.mp4

BhuvaneshPatil · 2023-09-28T06:21:47Z

@ntdiary Please have it checked thoroughly I am facing some internet issues here.

ntdiary · 2023-09-28T07:25:21Z

Hi, @BhuvaneshPatil, please update the test steps, complete QA steps and upload Android video. : )

BhuvaneshPatil · 2023-09-28T08:11:58Z

@ntdiary Updated. I have also updated the QA steps let me know if they are correct

ntdiary

LGTM. : )

src/pages/PrivateNotes/PrivateNotesEditPage.js

techievivek · 2023-09-28T23:55:02Z

src/pages/PrivateNotes/PrivateNotesViewPage.js

@@ -66,6 +66,7 @@ function PrivateNotesViewPage({route, personalDetailsList, session, report}) {
            >
                <HeaderWithBackButton
                    title={translate('privateNotes.title')}
+                    onBackButtonPress={() => Navigation.goBack(ROUTES.PRIVATE_NOTES_LIST.getRoute(report.reportID))}


This is tricky because we will conditionally show the list page. I was working on this here #28105 but couldn't prioritize it.

In case a user has a single note that they can access we will take them right away to the view page. So you can't always be sure that view page would go back to list page.

Navigaton flow:
Single note: Private notes button -> view page -> edit page
Multiple notes: Private notes button -> list page -> view page -> edit page

Navigating them back gets even trickier because you need to know which page they came from(it could be the profile page or the report details page). That's why I sort of just relied on the goBack default behaviour to sort that out from the navigation stack.

Oh, great catch! So I think it's okay to revert this change. Just like there are also multiple flows for going back from the notes list page to the report detail page.

Right, so we shall only change the PrivateNotesEditPage as we are sure that user would have came from PrivateNotesViewPage, right?

No no, have a look at the navigation flow I have mentioned here #28273 (comment)

Navigaton flow:
Single note: Private notes button -> view page -> edit page
Multiple notes: Private notes button -> list page -> view page -> edit page

So it is between the private notes button and the view page.

I think you misunderstood me here #28273 (comment)

Aaah, yes sorry, I went with negation. Since you are fixing the navigation behaviour here I would say we also want to fix for the View page, can you look into it to see if we have a way?

I am also sort of confused, why we don't retain the navigation stack when user refreshes the page. Does that happen with all the pages?

Yes, I have seen same behaviour for workspace pages that we have added fallback route.

@techievivek Can you tell me scenarios where I can see multiple private notes. Because currently I can only see one in workspace as well.

@techievivek I would like to use logic that you have used https://github.com/Expensify/App/pull/28105/files#diff-65c096044d5f69b35bcdec14c99c4fda4580759df9b1a7c36650d58eea276f1dR3569 here.

To check number of reports and based on that navigate. Let me know if this sounds right to you

BhuvaneshPatil · 2023-09-29T10:01:53Z

@ntdiary
For private notes view page, shall we follow somethin like -

if there is only one note we use HOME as fallback route, because it may have came from user or report details page
If there are more than one note, we know that it hsa came from list page so we use LIST as fallback route

…d-proper-go-back

ntdiary · 2023-09-29T18:32:45Z

@ntdiary For private notes view page, shall we follow somethin like -

if there is only one note we use HOME as fallback route, because it may have came from user or report details page

If there are more than one note, we know that it hsa came from list page so we use LIST as fallback route

Nice, this logic itself should be feasible. @techievivek, please feel free to let us know if you have different thoughts. : )

I am also sort of confused, why we don't retain the navigation stack when user refreshes the page. Does that happen with all the pages?

Additionally, regarding the navigation stack, if we directly access the view page via deep link (rather than going through a series of operations to access then refreshing), I believe there would not be a navigation stack. So the navigation stack may also be of no help to this issue.

BhuvaneshPatil · 2023-10-02T03:47:20Z

@techievivek Please have a look at comments and let us know what you think.

…d-proper-go-back

techievivek · 2023-10-02T06:05:29Z

(rather than going through a series of operations to access then refreshing), I believe there would not be a navigation stack.

IIRC, we do build up the navigation stack for deep-links but I like the above approach that @BhuvaneshPatil has shared. So this is good for now IMO.

techievivek

Looks good, thanks for the changes.

techievivek · 2023-10-02T06:10:09Z

src/pages/PrivateNotes/PrivateNotesViewPage.js

+        if (_.keys(privateNotes).length === 1) {
+            return ROUTES.HOME;
+        }
+


NAB: It would have been nice to include some comments for this method.

OSBotify · 2023-10-02T06:17:38Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

BhuvaneshPatil · 2023-10-02T06:56:33Z

@techievivek Will this be considered eligible for Urgency Bonus? because changes were made before the deadline. It got delayed while merging.

OSBotify · 2023-10-02T17:46:52Z

🚀 Deployed to staging by https://github.com/techievivek in version: 1.3.76-0 🚀

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

OSBotify · 2023-10-03T15:47:49Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.76-6 🚀

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

OSBotify · 2023-10-03T16:12:12Z

🚀 Deployed to staging by https://github.com/techievivek in version: 1.3.77-0 🚀

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

OSBotify · 2023-10-05T00:19:03Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.77-7 🚀

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

chiragsalian · 2023-11-01T17:41:53Z

src/pages/PrivateNotes/PrivateNotesEditPage.js

@@ -114,6 +114,7 @@ function PrivateNotesEditPage({route, personalDetailsList, session, report}) {
                <HeaderWithBackButton
                    title={translate('privateNotes.title')}
                    subtitle={translate('privateNotes.myNote')}
+                    onBackButtonPress={() => Navigation.goBack(ROUTES.PRIVATE_NOTES_VIEW.getRoute(report.repotID, route.params.accountID))}


repotID lol 😅
we're fixing it here

fix: add proper fallback routes for private notes pages

501e003

BhuvaneshPatil requested a review from a team as a code owner September 26, 2023 17:27

melvin-bot bot requested review from NikkiWines and removed request for a team September 26, 2023 17:27

ntdiary reviewed Sep 27, 2023

View reviewed changes

src/pages/PrivateNotes/PrivateNotesListPage.js Outdated Show resolved Hide resolved

revert changes for list page

ba36c13

ntdiary reviewed Sep 27, 2023

View reviewed changes

src/pages/PrivateNotes/PrivateNotesEditPage.js Outdated Show resolved Hide resolved

src/pages/PrivateNotes/PrivateNotesViewPage.js Outdated Show resolved Hide resolved

nit: remove lodash usage and get property values directly

78a6926

ntdiary approved these changes Sep 28, 2023

View reviewed changes

melvin-bot bot requested a review from techievivek September 28, 2023 10:26

techievivek reviewed Sep 28, 2023

View reviewed changes

src/pages/PrivateNotes/PrivateNotesEditPage.js Show resolved Hide resolved

techievivek reviewed Sep 28, 2023

View reviewed changes

BhuvaneshPatil added 2 commits September 29, 2023 18:31

add fallback route to view page

b5a7437

Merge branch 'main' of https://github.com/Expensify/App into 28011-ad…

0a36072

…d-proper-go-back

Merge branch 'main' of https://github.com/Expensify/App into 28011-ad…

7077466

…d-proper-go-back

techievivek approved these changes Oct 2, 2023

View reviewed changes

techievivek reviewed Oct 2, 2023

View reviewed changes

techievivek merged commit b5dda00 into Expensify:main Oct 2, 2023
12 checks passed

OSBotify mentioned this pull request Oct 2, 2023

Deploy Checklist: New Expensify 2023-10-02 #28635

Closed

melvin-bot bot mentioned this pull request Oct 3, 2023

[HOLD for payment 2023-10-10] Web - Private note - Private notes closed when clicking save button after refreshing the page #28011

Closed

6 tasks

OSBotify mentioned this pull request Oct 3, 2023

Deploy Checklist: New Expensify 2023-10-03 #28727

Closed

chiragsalian reviewed Nov 1, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: add proper fallback route for private notes pages #28273

fix: add proper fallback route for private notes pages #28273

BhuvaneshPatil commented Sep 26, 2023 •

edited

Loading

melvin-bot bot commented Sep 26, 2023

BhuvaneshPatil commented Sep 26, 2023

ntdiary commented Sep 28, 2023 •

edited

Loading

BhuvaneshPatil commented Sep 28, 2023

ntdiary commented Sep 28, 2023

BhuvaneshPatil commented Sep 28, 2023

ntdiary left a comment

techievivek Sep 28, 2023

techievivek Sep 29, 2023

ntdiary Sep 29, 2023

BhuvaneshPatil Sep 29, 2023

techievivek Sep 29, 2023

techievivek Sep 29, 2023

techievivek Sep 29, 2023

BhuvaneshPatil Sep 29, 2023

BhuvaneshPatil Sep 29, 2023

BhuvaneshPatil Sep 29, 2023

BhuvaneshPatil commented Sep 29, 2023

ntdiary commented Sep 29, 2023

BhuvaneshPatil commented Oct 2, 2023

techievivek commented Oct 2, 2023

techievivek left a comment

techievivek Oct 2, 2023

OSBotify commented Oct 2, 2023

BhuvaneshPatil commented Oct 2, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 3, 2023

OSBotify commented Oct 3, 2023

OSBotify commented Oct 5, 2023

chiragsalian Nov 1, 2023

fix: add proper fallback route for private notes pages #28273

fix: add proper fallback route for private notes pages #28273

Conversation

BhuvaneshPatil commented Sep 26, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 26, 2023

BhuvaneshPatil commented Sep 26, 2023

ntdiary commented Sep 28, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

BhuvaneshPatil commented Sep 28, 2023

ntdiary commented Sep 28, 2023

BhuvaneshPatil commented Sep 28, 2023

ntdiary 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BhuvaneshPatil commented Sep 29, 2023

ntdiary commented Sep 29, 2023

BhuvaneshPatil commented Oct 2, 2023

techievivek commented Oct 2, 2023

techievivek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Oct 2, 2023

BhuvaneshPatil commented Oct 2, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 3, 2023

OSBotify commented Oct 3, 2023

OSBotify commented Oct 5, 2023

Choose a reason for hiding this comment

BhuvaneshPatil commented Sep 26, 2023 •

edited

Loading

ntdiary commented Sep 28, 2023 •

edited

Loading