fix showing NotFound page when offline

[hungvu193]

Details

Fix showing NotFound page when offline

Fixed Issues

$ #30246
PROPOSAL: #30246 (comment)

Tests

1. Log in to any Account.
2. Open any chat and select a Contact to view their details.
3. Select any private notes and copy the link, paste it to the chat.
4. Logout and login again, disable the internet connection, now open the chat and click on the private notes deeplinking.
5. Turn on the internet connection.
6. Notice that it loads the private notes.

• Verify that no errors appear in the JS console

Offline tests

Same as Tests.

QA Steps

1. Log in to any Account.
2. Open any chat and select a Contact to view their details.
3. Select any private notes and copy the link, paste it to the chat.
4. Logout and login again, disable the internet connection, now open the chat and click on the private notes deeplinking.
5. Turn on the internet connection.
6. Notice that it loads the private notes.

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

Screen.Recording.2023-11-13.at.14.13.03.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

Screen.Recording.2023-11-13.at.17.48.44.mov

iOS

Android

[melvin-bot]

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

[hungvu193]

@jjcoffee PR is ready! I had a little trouble with my internet connection, please review the PR I'll complete the screenshot later.

[jjcoffee]

@hungvu193 Are you able to add the rest of the screenshots?

[jjcoffee]

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: mWeb Chrome
  • iOS: Native
  • iOS: mWeb 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(theme.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 the PR modifies the form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label so the design team can review the changes.
• 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

Android: Native

android-native-2023-12-14_17.27.39.mp4

Android: mWeb Chrome

android-chrome-2023-12-14_17.35.26.mp4

iOS: Native

ios-native-2023-12-14_17.49.44.mp4

iOS: mWeb Safari

ios-safari-2023-12-14_17.46.21.mp4

MacOS: Chrome / Safari

desktop-chrome-2023-12-14_17.03.26.mp4

MacOS: Desktop

desktop-app-2023-12-14_17.22.18.mp4

[jjcoffee]

Found a bit of an edge case where the not found error still shows, I think it's if you go offline just as the GetReportPrivateNotes requests starts. Any way to handle it?

desktop-app-2023-11-17_16.20.27.mp4

The screen is then just blank when I come back online:

[hungvu193]

let me take a look. I didn't see it before

Found a bit of an edge case where the not found error still shows, I think it's if you go offline just as the GetReportPrivateNotes requests starts. Any way to handle it?

desktop-app-2023-11-17_16.20.27.mp4

The screen is then just blank when I come back online:

[hungvu193]

I couldn't reproduce it, can you provide the Tests steps? @jjcoffee

[jjcoffee]

@hungvu193 If you go offline whilst the GetReportPrivateNotes is still pending (switching the network to slow 3G helps with this), it happens pretty consistently.

Can you also look into this issue? Thanks!

[hungvu193]

@hungvu193 There's no back button, so no (in-app) way to navigate back on mobile:

android-chrome-2023-11-17_16.03.16.mp4

Since we moved the FullScreenLoadingIndicator to withReportAndPrivateNotesOrNotFound to reuse the logic, I think it's expected (it was added by another PR, so I think it's out of scope in this PR).

[jjcoffee]

@hungvu193 Sorry, but I think we need to implement a correct fix here, regardless of what the other PR has implemented (the way the loading screen displays should have been a regression IMO).

Based on your proposal, we would have shown the loading indicator within the screen, below the header, so I think let's go ahead and implement that here and keep bad UX out of the app 😄

[hungvu193]

@hungvu193 Sorry, but I think we need to implement a correct fix here, regardless of what the other PR has implemented (the way the loading screen displays should have been a regression IMO).

Based on your proposal, we would have shown the loading indicator within the screen, below the header, so I think let's go ahead and implement that here and keep bad UX out of the app 😄

I think that's ok to fix it, however other HOCs also used the same approach by using FullScreenLoadingIndicator inside.
Do you think we really to fix it?
Also if we want to fix it, I think I'll wrap our FullScreenLoadingIndicator inside a View that has Header. How do you think?

[jjcoffee]

@hungvu193 Can you give some examples where other HOCs do the same thing?

[hungvu193]

@hungvu193 Can you give some examples where other HOCs do the same thing?

Yeah

App/src/pages/home/report/withReportOrNotFound.tsx

Lines 50 to 56 in 72e73ae

	if (shouldShowFullScreenLoadingIndicator) {
	return <FullscreenLoadingIndicator />;
	}
	if (shouldShowNotFoundPage) {
	return <NotFoundPage />;
	}

and

App/src/pages/home/report/withReportAndReportActionOrNotFound.js

Lines 109 to 117 in 72e73ae

	if ((isLoadingReport || isLoadingReportAction) && !shouldHideReport) {
	return <FullscreenLoadingIndicator />;
	}
	// Perform the access/not found checks
	if (shouldHideReport || _.isEmpty(reportAction)) {
	return <NotFoundPage />;
	}

[jjcoffee]

Are there some steps to get one of these to show? I'm curious where this pattern actually shows up on the FE.

[jjcoffee]

Also any thoughts on the issue when going offline?

[jjcoffee]

@hungvu193 Friendly bump on the above.

[hungvu193]

@hungvu193 Friendly bump on the above.

Oops sorry, I've been so busy on my jobs. I'll give you a solution tomorrow

[jjcoffee]

@hungvu193 Any update on this?

[jjcoffee]

@hungvu193 Can you let us know if you're able to complete the work on this? No worries at all if not, it's just good to know!

[hungvu193]

Oh sorry! I've been out sick last couple of weeks and can't be available next few days. Do you have any suggesstion for the solutions? I'll take a look when I feel better.

[hungvu193]

@jjcoffee I updated the code!
The idea here is that we will show the loading even the api request was failed if that's our private notes and it's empty.

[jjcoffee]

That makes sense, thanks!

So then I think the final thing to deal with here is the issue I mentioned previously, here's a video demonstrating it:

issue-2023-12-14_14.44.06.mp4

The key is to go offline before the GetReportPrivateNote request completes. Using a throttled connection helps with that.

[hungvu193]

That makes sense, thanks!

So then I think the final thing to deal with here is the issue I mentioned previously, here's a video demonstrating it:

issue-2023-12-14_14.44.06.mp4

The key is to go offline before the GetReportPrivateNote request completes. Using a throttled connection helps with that.

I see 😮‍💨 . Seems some logics were added in the meantime that will navigate the screen to edit note page if our notes are failed to load. Let me take a look.
Also can you reproduce this case on main? If that we can consider it a regression of the current implementation logic.

[jjcoffee]

On main I get a not found page under the same circumstance, so I think it's within scope to fix.

[hungvu193]

On main I get a not found page under the same circumstance, so I think it's within scope to fix.

Thanks for testing it. I'm on it 🫡

[hungvu193]

@jjcoffee I believe these lines were added weeks ago caused the issue you mentioned.

App/src/libs/ReportUtils.ts

Lines 4310 to 4314 in 78ad3f9

	const currentUserPrivateNote = report.privateNotes?.[session.accountID]?.note ?? '';
	if (isEmpty(currentUserPrivateNote)) {
	Navigation.navigate(ROUTES.PRIVATE_NOTES_EDIT.getRoute(report.reportID, session.accountID));
	return;
	}

It's checking if the note is empty then navigating to edit note page. So I think it's kind of out of scope for this PR.

You can try to remove these lines and test again, here's the result:

Screen.Recording.2023-12-14.at.22.38.36.mov

[jjcoffee]

Tests well and LGTM!

[jjcoffee]

Reported the issue when the request doesn't complete here.

[hungvu193]

Friendly bump @puneetlath

[puneetlath]

Sorry to be so late on this. Can you explain why we are creating a new loading page instead of using the FullPageNotFoundView? I couldn't find that in the proposal.

[hungvu193]

Sorry to be so late on this. Can you explain why we are creating a new loading page instead of using the FullPageNotFoundView? I couldn't find that in the proposal.

@puneetlath I think you mean FullpageLoadingIndicator, it will display fullscreen page without Header, so we create a new one, similar to FullpageNotFoundView so we can see the Header.

[jjcoffee]

@puneetlath There's a bit more context here - it's mainly useful to have the header display on mobile as otherwise there's no way to navigate back from the loading screen.

[puneetlath]

One small comment. Otherwise seems good to me.

[puneetlath]

Why is this needed?

[hungvu193]

I see. It seems redundant. Updated!

[puneetlath]

@jjcoffee the reviewer checklist check is also failing.

[jjcoffee]

Checklist updated to the latest version!

[puneetlath]

Ok great. Just one outstanding question for you then @hungvu193.

[hungvu193]

Ok great. Just one outstanding question for you then @hungvu193.

Cool. I've just updated the code.

[OSBotify]

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

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.4.24-0 🚀

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

[stitesExpensify]

👋 I think this PR may have caused this deploy blocker #34270. Would you mind taking a look @jjcoffee @puneetlath ?

[OSBotify]

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.24-3 🚀

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