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

feature: Add loading indicator when ReconnectApp is running #52272

Open
wants to merge 36 commits into
base: main
Choose a base branch
from

Conversation

nkdengineer
Copy link
Contributor

Details

Fixed Issues

$ #46611
PROPOSAL: #46611 (comment)

Tests

  1. Login to app
  2. Go to offline mode
  3. Back to online mode
  4. Verify that: loading indicator is displayed
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Login to app
  2. Go to offline mode
  3. Back to online mode
  4. Verify that: loading indicator is displayed
  • 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 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.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 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.
  • 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
android.mov
Android: mWeb Chrome
android-mweb.mov
iOS: Native
ios.mov
iOS: mWeb Safari
ios-mweb.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@nkdengineer nkdengineer marked this pull request as ready for review November 12, 2024 15:48
@nkdengineer nkdengineer requested review from a team as code owners November 12, 2024 15:48
@melvin-bot melvin-bot bot requested review from getusha and removed request for a team November 12, 2024 15:49
Copy link

melvin-bot bot commented Nov 12, 2024

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

src/styles/index.ts Outdated Show resolved Hide resolved
@getusha
Copy link
Contributor

getusha commented Nov 12, 2024

@nkdengineer what did we change here? what was the issue?

@nkdengineer
Copy link
Contributor Author

  • Using runOnJS to change isVisible within the animation may cause additional re-renders and other unintended effects.
  • I updated to remove isVisible and runOnJS and use opacity.value instead of isVisible.

@nkdengineer
Copy link
Contributor Author

@getusha friendly bump

@getusha
Copy link
Contributor

getusha commented Nov 25, 2024

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.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 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.
  • 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.2024-11-25.at.2.28.59.in.the.afternoon.mov
Android: mWeb Chrome
Screen.Recording.2024-11-25.at.2.15.33.in.the.afternoon.mov
iOS: Native
Screen.Recording.2024-11-26.at.10.25.05.at.night.mov
iOS: mWeb Safari
Screen.Recording.2024-11-25.at.2.18.00.in.the.afternoon.mov
MacOS: Chrome / Safari
Screen.Recording.2024-11-25.at.2.12.46.in.the.afternoon.mov
MacOS: Desktop
Screen.Recording.2024-11-25.at.2.21.44.in.the.afternoon.mov

@srikarparsi
Copy link
Contributor

Hi @getusha, how is this coming along? Do you think we can get this merged today or tomorrow?

@getusha
Copy link
Contributor

getusha commented Nov 26, 2024

I'll try to wrap this up today 🙇

@getusha
Copy link
Contributor

getusha commented Nov 26, 2024

@nkdengineer
The indicator isn't animated following this step

  1. Troubleshoot > Force offline > Clear cache and restart
  2. Navigate to Inbox
  3. Navigate to search
  4. Navigate back to Inbox
Screen.Recording.2024-11-26.at.10.20.12.at.night.mov

@nkdengineer
Copy link
Contributor Author

@getusha Fixed this bug.

@nkdengineer
Copy link
Contributor Author

@getusha Friendly bump.

@nkdengineer
Copy link
Contributor Author

But on the second video, we're still getting that little 1px jump. Why is that?

@shawnborton In large screen, the offline indicator in ReportScreen is used here and we pass chatItemComposeSecondaryRow style that fix the height of offline indicator to 15px.

{!shouldUseNarrowLayout && <OfflineIndicator containerStyles={[styles.chatItemComposeSecondaryRow]} />}

Screenshot 2025-01-15 at 14 50 56

In the small screen, the offline indicator is rendered in ScreenWrapper and it has a default height 16px.

Screenshot 2025-01-15 at 14 51 19

So the screen jump 1px because normally, the bottom in ReportScreen has height 15px.

Screenshot 2025-01-15 at 14 57 54

@shawnborton
Copy link
Contributor

Got it, thanks for explaining. Can you adjust so that it always uses 16px for its height?

@nkdengineer
Copy link
Contributor Author

@shawnborton Normally, if we don't have the offline indicator, the bottom in ReportScreen has height is 15px then if we always change the offline indicator to 16 the jump appear when the indicator appear and disappear.

Screenshot 2025-01-15 at 15 43 05

@shawnborton
Copy link
Contributor

Normally, if we don't have the offline indicator, the bottom in ReportScreen has height is 15px then if we always change the offline indicator to 16 the jump appear when the indicator appear and disappear.

Weird, I have no idea when or how it got that way but maybe we can just solve that in a follow up. It looks like it's 15px but it has vertical margin of 5px...
CleanShot 2025-01-15 at 09 49 39@2x

...so 15+5+5=25px, which is not what we want. In Figma, we save 24px of gap below the composer.
CleanShot 2025-01-15 at 09 51 04@2x

Anyways, we can file a follow up for that one.

@nkdengineer
Copy link
Contributor Author

@shawnborton Got it, please help to see on the loading bar again if it has any other problem then we can be good to process.

@shawnborton
Copy link
Contributor

I think the loaders themselves are in a good spot. Let's get this into final review @getusha @srikarparsi . I'll also spin up a test build. Thanks!

Copy link
Contributor

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

Copy link
Contributor

@shawnborton
Copy link
Contributor

Okay last piece of feedback here for the @Expensify/design to review... right now, it looks like the loader is vertically higher up than where the bottom edge of the top bar areas are:
CleanShot 2025-01-15 at 10 24 37@2x

CleanShot 2025-01-15 at 10 25 40@2x

I think I would expect the loader to be shifted down by at least 1px, this way it looks like it goes overtop of the bottom edge of those areas. Thoughts?

@dannymcclain
Copy link
Contributor

I agree with that Shawn. Not the biggest deal in the world, but we might as well get this perfect now so we don't have to revisit it.

@dubielzyk-expensify
Copy link
Contributor

I think I would expect the loader to be shifted down by at least 1px, this way it looks like it goes overtop of the bottom edge of those areas. Thoughts?

Yeah 1px down would be perfect 😇

@nkdengineer
Copy link
Contributor Author

@shawnborton Here is what we want, right?

Screen.Recording.2025-01-16.at.17.07.00.mov
Screen.Recording.2025-01-16.at.17.06.39.mov

@dubielzyk-expensify
Copy link
Contributor

That looks right to me 👍

@nkdengineer
Copy link
Contributor Author

I updated the PR with the result above.

@shawnborton
Copy link
Contributor

Yup, same!

@dannymcclain
Copy link
Contributor

Looks good! Can't wait for this to be in the product again. It helps so much haha.

@nkdengineer
Copy link
Contributor Author

@srikarparsi It's ready for your final review.

@srikarparsi
Copy link
Contributor

Taking a look. @getusha, can you do a quick review as well since there have been some changes since the last review. I'm generating an Ad Hoc build.

Copy link
Contributor

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

Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/52272/index.html ❌ FAILED ❌
Android The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/52272/NewExpensify.dmg https://52272.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@srikarparsi
Copy link
Contributor

Hey @nkdengineer, looks like jest job 2 is failing. Also, is there a problem with the iOS build. I see it worked in a different PR around the same time.

@nkdengineer
Copy link
Contributor Author

@srikarparsi The test is passed now.

@nkdengineer
Copy link
Contributor Author

Yesterday the test was canceled.

Screenshot 2025-01-17 at 12 26 27

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.

6 participants