Use 'isSearchingForReports' to control green circular loading

[brunovjk]

Details

Make sure the Green Loading Indicator works same everywhere we would expect.

Fixed Issues

$ #37144
PROPOSAL: #37144 (comment)

Tests

1. Launch New Expensify app.
2. Follow the Steps to access the 'Search Field' below (Conclude the test for each page)
3. Type something on the Search Field.
4. Verify that a Green Circular Loading indicator appears when we search for a contact and disappears when the search is complete.

Steps to access the 'Search Field' of each Page:

• Request money (Manual):

1. Click Global FAB
2. Press Request money
3. Select Manual
4. Fill the amount and press Next
5. Click on the Search Field

• Request money (Scan):

1. Click Global FAB
2. Press Request money
3. Select Scan
4. Upload a receipt
5. Click on the Search Field

• Request money (Distance):

1. Click Global FAB
2. Press Request money
3. Select Distance
4. Select 2 different waypoints and press Next
5. Click on the Search Field

• Send money:

1. Click Global FAB
2. Press Send money
3. Fill the amount and press Next
4. Click on the Search Field

• Room Invite Page:

1. Click Global FAB
2. Press Start chat
3. Select Room
4. Fill the name, workspace and create a room
5. Go to the room
6. Open room details
7. Press Members
8. Press Invite
9. Click on the Search Field

• Share Log List Page:

1. Go to Profile -> Troubleshoot
2. Enable Client side logging if disabled
3. Click View debug console
4. Click Share log
5. Click on the Search Field

• Assign task:

1. Click Global FAB
2. Press Assign task
3. Fill the Title and press Next
4. Press Assignee
5. Click on the Search Field

• Assign task - share somewhere:

1. Click Global FAB
2. Press Assign task
3. Fill the Title and press Next
4. Press Share somewhere
5. Click on the Search Field

• Invite to workspace:

1. Go to Profile -> Workspaces
2. Create a new workspace or join one where you can add members.
3. Go to Members
4. Press Invite member
5. Click on the Search Field

• Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as Tests

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

iOS: Native

MacOS.-.iOS.Native.mp4

iOS: mWeb Safari

MacOS.-.iOS.mWeb.mp4

MacOS: Chrome / Safari

MacOS.-.Chorme.mp4

MacOS: Desktop

MacOS.-.Desktop.mp4

[melvin-bot]

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

[brunovjk]

@lakchote, @mollfpr what do you think about use useOnyx instead of withOnyx here? In all pages

[mollfpr]

@brunovjk I think the hook one is preferable and the property we need seems simple enough.

[lakchote]

@brunovjk I think the hook one is preferable and the property we need seems simple enough.

I concur with what has been said.

It'd be great if we can use useOnyx instead for performance reasons.

It's usage will likely be enforced in the future (see here).

@brunovjk can you do it?

[brunovjk]

I'm seeing a performance test error on the ChatFinder page (extra render) – any ideas what might be causing it, given the changes seem similar to other working pages?

I retested and updated the PR videos/screenshots. Everything looks fine to me, except the perf test.

@mollfpr, @lakchote

[mollfpr]

• [ChatFinderPage] should interact when text input changes [render]: 28.7 ms → 33.1 ms (+4.4 ms, +15.3%) 🔴 | 6 → 7 (+1, +16.7%) 🔴

The mean count is increased by 1, but I tried the perf test locally with baseline as the latest main output is also 7. So I didn't get the error on the reassure test this PR.

Edit: I try checkout to themain branch and apply the changes of the PR locally showing the error perf-test. The useOnyx might be the case here. I think there are two things we can do here:

1. Move the key betas to use useOnyx too and remove the HOC, then ignore the perf-test error
2. Keep the isSearchingForReports in the HOC and the perf-test is passed

[brunovjk]

Reverted ChatFinderPage, only made a boolean standardization, since the "Green Loading" it was working before. Later we can come back to remove withOnyx to useOnyx and fix the perf test on ChatFinderPage, how does that sound? The rest LGTM.

@mollfpr @lakchote

[mollfpr]

@brunovjk Looks good to me too!

[lakchote]

LGTM to me too.

[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 production by https://github.com/marcaaron in version: 1.4.71-6 🚀

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