Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix loading indicator when the app is loading #56314

Merged
merged 30 commits into from
Mar 5, 2025

Conversation

nkdengineer
Copy link
Contributor

Explanation of Change

fix loading indicator when the app is loading

Fixed Issues

$ #55842
PROPOSAL:

Tests

  1. Open the App and login any account
  2. Force offline and reset cache
  3. Open the inbox
  4. Verify that the loading indicator is the same thickness as the one on the Reports page.
  • Verify that no errors appear in the JS console

Offline tests

Same

QA Steps

  1. Open the App and login any account
  2. Force offline and reset cache
  3. Open the inbox
  4. Verify that the loading indicator is the same thickness as the one on the Reports page.
  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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.ts 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 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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.

Screenshots/Videos

Android: Native
Screen.Recording.2025-02-04.at.17.16.02.mov
Android: mWeb Chrome
Screen.Recording.2025-02-04.at.17.11.02.mov
iOS: Native
Screen.Recording.2025-02-04.at.17.14.03.mov
iOS: mWeb Safari
Screen.Recording.2025-02-04.at.17.12.03.mov
MacOS: Chrome / Safari
Screen.Recording.2025-02-04.at.17.09.03.mov
MacOS: Desktop
Screen.Recording.2025-02-04.at.17.19.11.mov

@nkdengineer nkdengineer marked this pull request as ready for review February 4, 2025 10:27
@nkdengineer nkdengineer requested a review from a team as a code owner February 4, 2025 10:27
@melvin-bot melvin-bot bot requested review from hungvu193 and removed request for a team February 4, 2025 10:27
Copy link

melvin-bot bot commented Feb 4, 2025

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

@nkdengineer
Copy link
Contributor Author

@shawnborton Here is the result

  • Before
Screenshot 2025-02-06 at 16 40 06
  • After
Screenshot 2025-02-06 at 16 41 59

@nkdengineer
Copy link
Contributor Author

Here is the reason I added the mt3 #55842 (comment)

@shawnborton
Copy link
Contributor

I guess that makes sense, but I don't understand why the loading bar isn't using absolute positioning. Either way, @hungvu193 can you please move forward with the review here?

@hungvu193
Copy link
Contributor

hungvu193 commented Feb 6, 2025

I guess that makes sense, but I don't understand why the loading bar isn't using absolute positioning. Either way, @hungvu193 can you please move forward with the review here?

I think @getusha is the correct reviewer here, I can do review if @getusha can't do it.

@shawnborton
Copy link
Contributor

Ah okay either way works for me, let's just try to get this one reviewed soon if we can. Thanks!

@getusha
Copy link
Contributor

getusha commented Feb 6, 2025

will review this. Having trouble building for native.

@getusha
Copy link
Contributor

getusha commented Feb 7, 2025

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 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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.ts 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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
Screen.Recording.2025-02-09.at.12.38.59.in.the.afternoon.mov
Android: mWeb Chrome
Screen.Recording.2025-02-09.at.12.33.01.in.the.afternoon.mov
iOS: Native
Screen.Recording.2025-02-09.at.12.40.38.in.the.afternoon.mov
iOS: mWeb Safari
Screen.Recording.2025-02-09.at.12.30.58.in.the.afternoon.mov
MacOS: Chrome / Safari
Screen.Recording.2025-02-09.at.12.29.59.in.the.afternoon.mov
MacOS: Desktop
Screen.Recording.2025-02-09.at.12.35.18.in.the.afternoon.mov

@getusha
Copy link
Contributor

getusha commented Feb 9, 2025

@Expensify/design the loading bar is too close to the buttons, not sure if we want to change that. thoughts?

@dubielzyk-expensify
Copy link
Contributor

Oh good spotting. We generally have a 12px padding on all content but this seems like an exception. I feel like adding 12px padding between the button and loading bar would make it too big. Part of me wonder if it should be under the Expenses + Filter button and before the pills to make it seem like the button is part of the header, but I'm not sure.

Keen to hear if the designers have any ideas

@nkdengineer nkdengineer requested a review from a team as a code owner February 10, 2025 17:53
@nkdengineer
Copy link
Contributor Author

@getusha Added paddingTop 12px for the search bar in the small screen,

Screen.Recording.2025-02-11.at.00.54.37.mov

@shawnborton
Copy link
Contributor

Hmm I guess the gap between the tabs and the expense rows is quite small. I think I would lean on just adding the 12px gap above the "Expenses" dropdown button for consistency with other pages?

Then we should really revisit our header heights like we talked about previously. Even just making everything consistent at 72px tall would be a good place to start (and then this way we don't have the difference between 72 and 80 like we do now)

@dannymcclain
Copy link
Contributor

dannymcclain commented Feb 10, 2025

Yeah I agree—let's go ahead and add the 12px like in the video. And then separately, we should make everything consistent at 72px.

@dubielzyk-expensify
Copy link
Contributor

Great plan. Agree with that 👍

@shawnborton
Copy link
Contributor

Hmm I just noticed this weird case where when the loading indicator is present and you scroll down, part of it gets cut off (see the left side of this screenshot below). Is that something we'll address in this PR?
CleanShot 2025-02-11 at 07 52 59@2x

@nkdengineer
Copy link
Contributor Author

@shawnborton I fixed this bug. cc @getusha

@nkdengineer
Copy link
Contributor Author

nkdengineer commented Feb 20, 2025

@SzymczakJ I see that this component has 112px but the minimalTopBarOffset is only -106, can we update this to -112 or update this to -124 I will remove the paddingTop dynamic logic in my PR here and add paddingTop: 12 to narrowSearchHeaderStyle? Both approaches will also remove the gap.

Screenshot 2025-02-20 at 17 14 55

@SzymczakJ
Copy link
Contributor

Setting minimalTopBarOffset to -106 seems a bug on my side. Both of the solutions seem resonable, so go ahead with them.
Also when you will be changing paddingTop in narrowSearchHeaderStyle can you make sure that Search input is not jumpy when we focus it? I've added a paddingTop: 1 to it to prevent it.

@nkdengineer
Copy link
Contributor Author

Thanks, let me check it.

@nkdengineer
Copy link
Contributor Author

@shawnborton All good now.

Screenshot 2025-02-20 at 22 29 06

Also when you will be changing paddingTop in narrowSearchHeaderStyle can you make sure that Search input is not jumpy when we focus it? I've added a paddingTop: 1 to it to prevent it.

@SzymczakJ It also works well.

@getusha Friendly bump.

@shawnborton
Copy link
Contributor

Nice, yeah let's get this into final review then.

Copy link
Contributor

🚧 @shawnborton has triggered a test build. You can view the workflow run here.

Copy link
Contributor

@dubielzyk-expensify
Copy link
Contributor

It looks good for me on iOS and web. Video with scrolling:

ScreenRecording_02-21-2025.14-31-43_1.mov

@shawnborton
Copy link
Contributor

Amazing, let's get this thing into final review then cc @getusha. Thanks for your patience with our back and forth @nkdengineer

@getusha
Copy link
Contributor

getusha commented Feb 21, 2025

Amazing, let's get this thing into final review then cc @getusha.

On it, will test and approve today

@@ -3753,7 +3753,7 @@ const styles = (theme: ThemeColors) =>
},

narrowSearchHeaderStyle: {
paddingTop: 1,
paddingTop: 12,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why we adjusted this but it's causing this:

Screen.Recording.2025-02-21.at.10.59.16.at.night.mov

Screenshot 2025-02-21 at 11 04 14 at night

Component appears to be cut off.

This is before:

Screenshot 2025-02-21 at 11 05 39 at night

Screenshot 2025-02-21 at 11 06 04 at night

cc @shawnborton if this is something we'd want to fix.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@getusha What is the bug here, the empty state component is scrollable, and when the height is not enough, it will appear like this. Without this padding, you can also see the cut off in the device with small height.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catches on all of that, we want to fix these things for sure.

For the new search input on desktop, maybe we can put the loading bar underneath it in the gap between the search input and the tabs?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or actually I'd be curious to see it at the very very top of the view even, on the top edge of the screen. Let's see what @Expensify/design thinks about that one since we don't have a standard page header on this particular page.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd definitely be down to see it at the very top.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could have sworn we were showing it there for Reports/Search previously though? Otherwise yeah, we only show it in the MCP (lol) on mobile when a chat is loading I think...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like we've gone around a few places here, but I like the video above where it shows only in LHN area 👍

I see what you wanted with the top there Shawn, but I feel like I'd rather then explore one of the first explorations I did where it was always at the top. But then again, I think that's just a completely different thing. Would prefer it to stay in a consistent place as much as possible

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Totally agree, I think keeping the loading bar in the LHN for reports makes sense and I love that it translates well to mobile placement too.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love that it translates well to mobile placement too.

@shawnborton It's worked well, see this comment #56314 (comment).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree! Let's start final reviewing this one cc @getusha

Copy link
Contributor

@getusha getusha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@melvin-bot melvin-bot bot requested a review from srikarparsi March 4, 2025 09:39
Copy link
Contributor

@srikarparsi srikarparsi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code looks good to me, thank you for the explanation of all the changes @nkdengineer, it was very helpful while reviewing. Going to merge 🚀

@srikarparsi srikarparsi merged commit 0002c66 into Expensify:main Mar 5, 2025
17 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Mar 5, 2025

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

Copy link
Contributor

github-actions bot commented Mar 6, 2025

🚀 Deployed to staging by https://github.com/srikarparsi in version: 9.1.10-0 🚀

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

Copy link
Contributor

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

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

@shawnborton
Copy link
Contributor

Did this PR cause this bug? #58284 cc @nkdengineer

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants