20354 money request participants selector skeleton fix

[lukemorawski]

Details

A quick fix to Skeleton issues on MoneyRequestParticipantsList components. Debouncing searching.

Fixed Issues

$ #32692 (comment)
PROPOSAL:

Tests

• Verify that no errors appear in the JS console

Offline tests

QA Steps

• make a money request
• observe the skeleton showing up when the screen shows up
• observe the skeleton showing up the searching for contact
• 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 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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[melvin-bot]

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

[rlinoz]

Hey @lukemorawski can you help me understand why we need to check for the transition state?

[lukemorawski]

This waits for all the interactions/animations to end so in this case mostly the screen transition. Only after that the section data will be rendered, but until this happens the skeleton element is shown.

[youssef-lr]

I think you're planning to reuse BaseSelectionsList in different other parent components right? Such as the SearchPage and NewChatPage, in this case, can we code this debouncing logic in the BaseSelectionsList itself instead of having to duplicate in each parent componenent?

[youssef-lr]

I'm still seeing a flicker, here it is compared to the search page

Screen.Recording.2024-01-12.at.22.34.45.mov

[lukemorawski]

I think you're planning to reuse BaseSelectionsList in different other parent components right? Such as the SearchPage and NewChatPage, in this case, can we code this debouncing logic in the BaseSelectionsList itself instead of having to duplicate in each parent componenent?

I actually wouldn't advice adding debouning to the list component. for simplicity and separation of concerns sake. The list is only to display things. Yes it has some convenient things added to it, but still they are "list related".
Let's say we added debouncing to textInputValue and suddenly we have a use-case where we actually don't need it because all the data is local and we just need to quickly filter them. We would then need to add yet another param to turn off debouncing. Also another param to manage to debouncing time. This exactly what happened to the previous list element (which we are removing right now) - it got bloated over time with features that we don't use 99% of time. By keeping debouncing outside of the scope of the list we keep things modular and easier to refactor in the future.

[lukemorawski]

I'm still seeing a flicker, here it is compared to the search page

OK, it's because the new SelectionList doesn't have a param that the old one had, which is a flag that was showing a loading indicator in input field. Instead I reverted to showing a skeleton while searching and that creates that unpleasant effect. I'll just add that old param to the new list component - this should solve the issue.

[brunovjk]

@lukemorawski Im working in this skeleton transition here #32665

Although you are still in the middle of refactoring, we need to control the getOptions call. Like you did in here.

Also,

param that the old one had, which is a flag that was showing a loading indicator in input field

• I adjusted the 'SelectionList' props #commit, I think it works fine now, but any feedback is welcome.
• We also need a fill={theme.icon} in the MoneyRequestReferralProgramCTA.tsx

I went ahead and resolved this in my PR as well. What do you think?

We need to make the same adjustments to NewChatPage and SearchPage.

[lukemorawski]

@lukemorawski Im working in this skeleton transition here #32665

Although you are still in the middle of refactoring, we need to control the getOptions call. Like you did in here.

Also,

param that the old one had, which is a flag that was showing a loading indicator in input field

• I adjusted the 'SelectionList' props #commit, I think it works fine now, but any feedback is welcome.
• We also need a fill={theme.icon} in the MoneyRequestReferralProgramCTA.tsx

I went ahead and resolved this in my PR as well. What do you think?

We need to make the same adjustments to NewChatPage and SearchPage.

OK, I see we are basically working on mostly the same things here. There is no point of making two PRs with code changes addressing the same issues. I could close my PR if you could add some some extra things my PR have and your doesn't. That way we won't duplicate. If you're cool with that then here's a quick list:

1. debounce text input value. You can use the same way I used in this PR using useDebouncedState hook and useEffect to run Report.searchInServer on debounced value change.
2. applying all the same changes in src/pages/iou/steps/MoneyRequstParticipantsPage/MoneyRequestParticipantsSelector.js as it's basically the same component but used elsewhere.

And I could prepare another PR where fix the icon thing.

[brunovjk]

OK, I see we are basically working on mostly the same things here

Yes 😂

I could close my PR if you could add some some extra things my PR have and your doesn't.

Absolutely, I will work on these changes immediately.

And I could prepare another PR where fix the icon thing.

I completed the fill property in MoneyRequestReferralProgramCTA in my PR #commit, can I leave it? I believe we can create a ReferralProgramCTA to be used in all others, SerachPage and NewPage for example. I don't know if it already exists.

[brunovjk]

@lukemorawski, One more thing, about #20354, I believe we will have more work, I can see some places that use OptionSelector that I believe can be replaced by SelectionList, I don't know. But in any case, I'm at your disposal if you need help with the next steps of it.

[lukemorawski]

@lukemorawski, One more thing, about #20354, I believe we will have more work, I can see some places that use OptionSelector that I believe can be replaced by SelectionList, I don't know. But in any case, I'm at your disposal if you need help with the next steps of it.

Thanks for that! I'm doing those refactorings one by one, so it's not a huge unreadable PR.

[lukemorawski]

OK, I see we are basically working on mostly the same things here

Yes 😂

I could close my PR if you could add some some extra things my PR have and your doesn't.

Absolutely, I will work on these changes immediately.

And I could prepare another PR where fix the icon thing.

I completed the fill property in MoneyRequestReferralProgramCTA in my PR #commit, can I leave it? I believe we can create a ReferralProgramCTA to be used in all others, SerachPage and NewPage for example. I don't know if it already exists.

Awesome. Leave your change please and I'll address the rest. I have already created one common ReferralProgramCTA. I'll just refer it in all those pages.

[lukemorawski]

Closing this PR because the work here has been largely doubled in #32665.
Please see this comment #34443 (comment)

[brunovjk]

@lukemorawski The PR is ready for Review.

I made the changes you mentioned:

1. debounce text input value. You can use the same way I used in this PR using useDebouncedState hook and useEffect to run Report.searchInServer on debounced value change.
2. applying all the same changes in src/pages/iou/steps/MoneyRequstParticipantsPage/MoneyRequestParticipantsSelector.js as it's basically the same component but used elsewhere.

Can you verify please? #32665/files
Thank you :D