Add ReportHeaderSkeletonView to ReportScreen #30367

adamgrzybowski · 2023-10-25T17:22:37Z

Details

This PR fixes a regression described here https://expensify.slack.com/archives/C049HHMV9SM/p1698096936186419.

It's quite simple, so I'm only including screenshots for the web. Tag me if you think we need more.

Fixed Issues

$
PROPOSAL:

Tests

Open the desktop web version of the app.
Log out.
Log in.
Look if after logging in when the report screen has a skeleton view for a moment the header also has skeleton view.

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2023-10-25T17:23:14Z

@hayata-suenaga 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]

hayata-suenaga · 2023-10-26T15:38:50Z

@adamgrzybowski can you add the test steps please?

adamgrzybowski · 2023-10-26T16:00:44Z

@hayata-suenaga done!

situchan · 2023-10-26T16:24:45Z

src/pages/home/ReportScreen.js

@@ -214,6 +215,10 @@ function ReportScreen({
        );
    }

+    if (reportID === '') {


I don't think this condition is enough. While report data is loading, skeleton should also be displayed.

Please check this video:

Screen.Recording.2023-10-26.at.10.23.06.PM.mov

i think it's fine. we're showing old state while the report is being fetched

@rushatgabhane as you see, there's a brief moment when header is empty but report shows skeleton
(around 00:06s)

good point @situchan

@adamgrzybowski maybe we can add a check isLoading

hayata-suenaga · 2023-10-27T17:51:03Z

I gonna review this after @situchan's comment is addressed

adamgrzybowski · 2023-10-30T12:07:38Z

Hey, thanks for the suggestion 🙇 It should work now
cc: @hayata-suenaga

situchan · 2023-10-30T19:28:51Z

@hayata-suenaga shall I continue review?

hayata-suenaga · 2023-10-31T17:23:58Z

@situchan yes please 🙇

situchan · 2023-11-03T16:39:31Z

@adamgrzybowski I am still seeing this case

To easily reproduce, please logout and login on bad/slow network or HT account

WojtekBoman · 2023-11-08T14:40:26Z

Comment for the assignment

hayata-suenaga · 2023-11-08T21:40:12Z

@WojtekBoman I apparently cannot assign you as a reviewer. Can you start reviewing on your part?

WojtekBoman · 2023-11-13T09:18:17Z

@adamgrzybowski I am still seeing this case
To easily reproduce, please logout and login on bad/slow network or HT account

@situchan Could you recheck it? Today I merged this branch with main and this bug didn't occur

situchan · 2023-11-13T11:02:42Z

@WojtekBoman this is easily reproducible. please join any public room

bug2.mov

WojtekBoman · 2023-11-13T15:23:27Z

@situchan Could you check it with the last fix?

hayata-suenaga · 2023-11-13T16:15:37Z

I gonna review this after @situchan reviews it

situchan

yes, I like this solution to put loading logic into HeaderView since there's no case of showing MoneyRequestHeader or MoneyReportHeader when report doesn't exist.
Let's clean up code.

situchan · 2023-11-15T18:10:54Z

src/pages/home/HeaderView.js

@@ -172,12 +173,14 @@ function HeaderView(props) {
    const shouldShowBorderBottom = !isTaskReport || !props.isSmallScreenWidth;
    const shouldDisableDetailPage = ReportUtils.shouldDisableDetailPage(props.report);

+    const isLoading = !(props.report && title);


Suggested change

const isLoading = !(props.report && title);

const isLoading = !props.report || !title;

Actually, there's no case of !props.report. !title should be enough condition

situchan · 2023-11-16T09:41:02Z

src/components/ReportHeaderSkeletonView.js

@@ -26,7 +26,7 @@ const defaultProps = {

 function ReportHeaderSkeletonView(props) {
    return (
-        <View style={[styles.appContentHeader]}>
+        <View style={[styles.appContentHeader, styles.borderBottom]}>


Suggested change

<View style={[styles.appContentHeader, styles.borderBottom]}>

<View style={[styles.appContentHeader]}>

situchan · 2023-11-16T09:42:31Z

src/pages/home/HeaderView.js

    return (
        <View
            style={[styles.appContentHeader, shouldShowBorderBottom && styles.borderBottom]}
            dataSet={{dragArea: true}}
        >
-            <View style={[styles.appContentHeaderTitle, !props.isSmallScreenWidth && styles.pl5]}>
+            <View style={[styles.appContentHeaderTitle, !props.isSmallScreenWidth && !isLoading && styles.pl5]}>
                {props.isSmallScreenWidth && (


Suggested change

{props.isSmallScreenWidth && (

{!isLoading && props.isSmallScreenWidth && (

situchan · 2023-11-16T09:45:27Z

@hayata-suenaga I'd like to confirm that it's expected to do nothing when click back button inside skeleton header on mobile. That's original logic here:

App/src/components/ReportHeaderSkeletonView.js

Lines 31 to 40 in 2b4909d

    
           {props.isSmallScreenWidth && ( 
        
               <PressableWithFeedback 
        
                   onPress={() => {}} 
        
                   style={[styles.LHNToggle]} 
        
                   role={CONST.ACCESSIBILITY_ROLE.BUTTON} 
        
                   accessibilityLabel={props.translate('common.back')} 
        
               > 
        
                   <Icon src={Expensicons.BackArrow} /> 
        
               </PressableWithFeedback> 
        
           )}

As seen above, onPress callback does nothing

situchan · 2023-11-16T12:27:44Z

src/pages/home/HeaderView.js

@@ -175,96 +176,102 @@ function HeaderView(props) {
    const shouldShowBorderBottom = !isTaskReport || !props.isSmallScreenWidth;
    const shouldDisableDetailPage = ReportUtils.shouldDisableDetailPage(props.report);

+    const isLoading = !props.report || !title;
+
    return (
        <View
            style={[styles.appContentHeader, shouldShowBorderBottom && styles.borderBottom]}
            dataSet={{dragArea: true}}
        >
            <View style={[styles.appContentHeaderTitle, !props.isSmallScreenWidth && styles.pl5]}>


Please retest after changes have been made

Suggested change

<View style={[styles.appContentHeaderTitle, !props.isSmallScreenWidth && styles.pl5]}>

<View style={[styles.appContentHeaderTitle, !isLoading && !props.isSmallScreenWidth && styles.pl5]}>

situchan · 2023-11-17T21:16:39Z

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

Android: Native

android.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

situchan

melvin-bot · 2023-11-17T21:17:01Z

🎯 @situchan, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #31504.

situchan · 2023-11-17T21:18:39Z

@hayata-suenaga all yours!
Also, please remove old reviewer checklist - #30367 (comment)

hayata-suenaga

looks good to me 👍

OSBotify · 2023-11-17T22:12:10Z

✋ 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-22T00:49:15Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.1-13 🚀

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

s77rt · 2024-02-02T20:59:21Z

src/pages/home/HeaderView.js

@@ -175,96 +176,102 @@ function HeaderView(props) {
    const shouldShowBorderBottom = !isTaskReport || !props.isSmallScreenWidth;
    const shouldDisableDetailPage = ReportUtils.shouldDisableDetailPage(props.report);

+    const isLoading = !props.report || !title;


We should have checked for report id as well since the report id is used in ReportScreen. Not doing so made the report content show a skeleton view while the header not.

Another reason is that when a user leave a thread we will only clear the report id. We should show the skeleton view in this case. Otherwise the header will show unwanted UI components (Coming from #34820)

add ReportHeaderSkeletonView to ReportScreen

59b7e17

adamgrzybowski requested a review from a team as a code owner October 25, 2023 17:22

melvin-bot bot requested review from hayata-suenaga and removed request for a team October 25, 2023 17:23

situchan reviewed Oct 26, 2023

View reviewed changes

hayata-suenaga requested a review from stitesExpensify October 27, 2023 17:50

adamgrzybowski added 2 commits October 30, 2023 12:36

Merge branch 'main' into @swm/fix-report-header-skeleton-view

4e59669

add isLoading to condition for skeleton header

ac217d0

Merge branch 'main' into @swm/fix-report-header-skeleton-view

f2af3c3

Merge branch 'main' into @swm/fix-report-header-skeleton-view

3df60a1

Add isLoading to HeaderView

c4219a3

situchan suggested changes Nov 15, 2023

View reviewed changes

WojtekBoman added 2 commits November 16, 2023 09:50

Refactor isLoading in HeaderView

e82fd1b

Lint fixes

84ea486

situchan suggested changes Nov 16, 2023

View reviewed changes

WojtekBoman added 4 commits November 16, 2023 11:53

Fix showing a back button when header is loading

df17568

Merge branch 'main' into @swm/fix-report-header-skeleton-view

f5a7217

Merge branch 'main' into @swm/fix-report-header-skeleton-view

0a3e85b

Refactor ReportHeaderSkeletonView

3886c84

situchan reviewed Nov 16, 2023

View reviewed changes

Fix HeaderView styles

175aa5c

situchan approved these changes Nov 17, 2023

View reviewed changes

melvin-bot bot mentioned this pull request Nov 17, 2023

Payment issue for E/App PR#30367 #31504

Closed

Expensify deleted a comment from rushatgabhane Nov 17, 2023

hayata-suenaga approved these changes Nov 17, 2023

View reviewed changes

hayata-suenaga merged commit ae83639 into Expensify:main Nov 17, 2023
15 of 16 checks passed

os-botify bot mentioned this pull request Nov 20, 2023

Deploy Checklist: New Expensify 2023-11-20 #31556

Closed

90 tasks

s77rt reviewed Feb 2, 2024

View reviewed changes

s77rt mentioned this pull request Feb 2, 2024

[HOLD for payment 2024-02-07] [$500] Thread - "Join" button appear when user Leave thread #34820

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ReportHeaderSkeletonView to ReportScreen #30367

Add ReportHeaderSkeletonView to ReportScreen #30367

adamgrzybowski commented Oct 25, 2023 •

edited by github-actions bot

Loading

melvin-bot bot commented Oct 25, 2023

hayata-suenaga commented Oct 26, 2023

adamgrzybowski commented Oct 26, 2023

situchan Oct 26, 2023

rushatgabhane Oct 26, 2023

situchan Oct 26, 2023

rushatgabhane Oct 26, 2023 •

edited

Loading

hayata-suenaga commented Oct 27, 2023

adamgrzybowski commented Oct 30, 2023

situchan commented Oct 30, 2023

hayata-suenaga commented Oct 31, 2023

situchan commented Nov 3, 2023

WojtekBoman commented Nov 8, 2023

hayata-suenaga commented Nov 8, 2023

WojtekBoman commented Nov 13, 2023 •

edited

Loading

situchan commented Nov 13, 2023

WojtekBoman commented Nov 13, 2023

hayata-suenaga commented Nov 13, 2023

situchan left a comment

situchan Nov 15, 2023

situchan Nov 16, 2023

situchan Nov 16, 2023

situchan commented Nov 16, 2023

situchan Nov 16, 2023

situchan commented Nov 17, 2023

situchan left a comment

melvin-bot bot commented Nov 17, 2023

situchan commented Nov 17, 2023

hayata-suenaga left a comment

OSBotify commented Nov 17, 2023

OSBotify commented Nov 22, 2023

s77rt Feb 2, 2024

	const isLoading = !(props.report && title);
	const isLoading = !props.report \|\| !title;

	<View style={[styles.appContentHeader, styles.borderBottom]}>
	<View style={[styles.appContentHeader]}>

	{props.isSmallScreenWidth && (
	{!isLoading && props.isSmallScreenWidth && (

	<View style={[styles.appContentHeaderTitle, !props.isSmallScreenWidth && styles.pl5]}>
	<View style={[styles.appContentHeaderTitle, !isLoading && !props.isSmallScreenWidth && styles.pl5]}>

Add ReportHeaderSkeletonView to ReportScreen #30367

Add ReportHeaderSkeletonView to ReportScreen #30367

Conversation

adamgrzybowski commented Oct 25, 2023 • edited by github-actions bot Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 25, 2023

hayata-suenaga commented Oct 26, 2023

adamgrzybowski commented Oct 26, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rushatgabhane Oct 26, 2023 • edited Loading

Choose a reason for hiding this comment

hayata-suenaga commented Oct 27, 2023

adamgrzybowski commented Oct 30, 2023

situchan commented Oct 30, 2023

hayata-suenaga commented Oct 31, 2023

situchan commented Nov 3, 2023

WojtekBoman commented Nov 8, 2023

hayata-suenaga commented Nov 8, 2023

WojtekBoman commented Nov 13, 2023 • edited Loading

situchan commented Nov 13, 2023

WojtekBoman commented Nov 13, 2023

hayata-suenaga commented Nov 13, 2023

situchan 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

situchan commented Nov 16, 2023

Choose a reason for hiding this comment

situchan commented Nov 17, 2023

Reviewer Checklist

Screenshots/Videos

situchan left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Nov 17, 2023

situchan commented Nov 17, 2023

hayata-suenaga left a comment

Choose a reason for hiding this comment

OSBotify commented Nov 17, 2023

OSBotify commented Nov 22, 2023

Choose a reason for hiding this comment

adamgrzybowski commented Oct 25, 2023 •

edited by github-actions bot

Loading

rushatgabhane Oct 26, 2023 •

edited

Loading

WojtekBoman commented Nov 13, 2023 •

edited

Loading