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

Add search input to mobile search page(with fixed performance) #56326

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

Conversation

SzymczakJ
Copy link
Contributor

@SzymczakJ SzymczakJ commented Feb 4, 2025

Explanation of Change

This PR is mainly about redesigning Search Page but I also made a pretty big refactor and improved performance of Search Page mobile header animation.
These are the design changes:

  1. on SearchPage full screen, the SearchRouterInput is always visible, previously the SearchRouterInput was hidden when we were in "canned search" state.
Screenshot 2025-01-23 at 11 56 49
  1. on mobile SearchPage, we remove the button that navigates to SearchRouter
  2. instead of that we put SearchRouterInput in place where SearchTypeMenuNarrow was, focusing this input is making SearchRouterList visible.
Screenshot 2025-01-23 at 11 59 03 Screenshot 2025-01-23 at 11 59 24
  1. on mobile SearchPage user can still open type menu modal by pressing the button next to SearchRouterInput

These are refactor changes:

  1. Refactor of SearchPageBottomTab.tsx so that it has one render for narrow screen and one render for full screen, for better readability.
  2. Delete SearchTypeMenuNarrow.tsx and decuple it's logic from SearchTypeMenu.tsx, now this logic lives in SearchTypeMenuPopover.tsx with the common parts of SearchTypeMenuPopover and SearchTypeMenu put into SearchUIUtils.
  3. Delete SearchSelectionModeHeader.tsx as it added unnecessary layer that was confusing.

Fixed Issues

$ #52317
$ #55828
PROPOSAL:

Tests

  1. On full screen SearchPage make sure that SearchRouterInput displays in every case.
  2. Test if clicking on canned searches and saved searches works as expected.
  3. Test if writing into SearchRouterInput works as expected.
  4. On mobile, test scrolling SearchPage list and SearchRouterList(after focusing SearchRouterInput).
  5. Test SearchRouterList, if it works as expected(if clicking on recent searches items works as expected etc.).
  6. Test if advanced filters button works as expected.
  7. Test if type menu button(next to SearchRouterInput) works as expected and it's possible to go to canned item or saved item.

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

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 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

Copy link

melvin-bot bot commented Feb 4, 2025

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@SzymczakJ SzymczakJ marked this pull request as ready for review February 5, 2025 15:14
@SzymczakJ SzymczakJ requested review from a team as code owners February 5, 2025 15:14
@melvin-bot melvin-bot bot requested a review from sobitneupane February 5, 2025 15:14
Copy link

melvin-bot bot commented Feb 5, 2025

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

@melvin-bot melvin-bot bot removed the request for review from a team February 5, 2025 15:14
Copy link
Contributor

github-actions bot commented Feb 5, 2025

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

This comment has been minimized.

@shawnborton
Copy link
Contributor

Hmm this feels very sluggish to me. It seems like there is quite the delay for the input to animate. And then when you close the input, all of the avatars flash back in as well. Can we try to make this one a bit smoother?

ScreenRecording_02-05-2025.11-04-52_1.MP4

Can you also check and make sure the placeholder text here is using our correct textSupporting color? Thanks!
CleanShot 2025-02-05 at 11 08 58@2x

@luacmartins
Copy link
Contributor

@IuliiaHerets could you please run the test steps from this issue using the builds here. Hopefully that issue is fixed in this build

@sobitneupane
Copy link
Contributor

@ikevin127 All yours as you were reviewer in the previous reverted PR. Please let me know if you won't be available to review the PR.

@ikevin127
Copy link
Contributor

@sobitneupane Thanks, I'll start working on the checklist, making sure to test all issues encountered last time which led to the revert 👍

@ikevin127
Copy link
Contributor

ikevin127 commented Feb 6, 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 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 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
android.webm
Android: mWeb Chrome
android-mweb.webm
iOS: Native
ios.mp4
iOS: mWeb Safari
ios-mweb.mp4
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

Copy link
Member

@Kicu Kicu left a comment

Choose a reason for hiding this comment

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

Went over the PR, it gets quite complicated with all the changes of components :/ but in general great work on this

flex: 1,
},

typePopoverButtonStyle: {
Copy link
Member

Choose a reason for hiding this comment

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

I know that we have a preference to use style props/consts but I think if it's just a class for 1 line of styles, then maybe it's better to just inline theme.sidebarHover in the component that it's used?

@@ -76,6 +76,7 @@ function BaseTextInput(
contentWidth,
loadingSpinnerStyle,
uncontrolled = false,
placeholderTextColor,
Copy link
Member

Choose a reason for hiding this comment

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

another prop 😭 😭 😭

@@ -98,7 +98,7 @@ function isCardHiddenFromSearch(card: Card) {
return !card?.nameValuePairs?.isVirtual && CONST.EXPENSIFY_CARD.HIDDEN_FROM_SEARCH_STATES.includes(card.state ?? 0);
}

function mergeCardListWithWorkspaceFeeds(workspaceFeeds: Record<string, WorkspaceCardsList | undefined>, cardList = allCards, shouldExcludeCardHiddenFromSearch = false) {
function mergeCardListWithWorkspaceFeeds(workspaceFeeds: Record<string, WorkspaceCardsList | undefined> | undefined, cardList = allCards, shouldExcludeCardHiddenFromSearch = false) {
Copy link
Member

Choose a reason for hiding this comment

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

IMO it looks bad when the first argument can be undefined but there are other arguments after it. It is technically "correct" from the perspective of JS/TS but bad function design.

Can we revert the change? did you do it just to avoid creating empty objects in other places in Search code?

},
});
}
typeMenuItems.push({
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
typeMenuItems.push({
typeMenuItems.push({

Copy link
Member

Choose a reason for hiding this comment

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

add ENTER

return;
}
textInputRef.current.blur();
// eslint-disable-next-line react-compiler/react-compiler
// eslint-disable-next-line react-hooks/exhaustive-deps
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
// eslint-disable-next-line react-hooks/exhaustive-deps
// eslint-disable-next-line react-compiler/react-compiler react-hooks/exhaustive-deps

1 line less ;)

@@ -63,12 +61,12 @@ function TopBar({breadcrumbLabel, activeWorkspaceID, shouldDisplaySearch = true,
</View>
</View>
{displaySignIn && <SignInButton />}
{shouldDisplayCancelSearch && (
{shouldDisplayCancel && (
Copy link
Member

Choose a reason for hiding this comment

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

NAB - reminder for me to discuss 1 thing about using shouldDisplayCancel + callback

@IuliiaHerets
Copy link

@luacmartins Tester cannot repro the issue using mentioned builds

Screen_Recording_20250206_214923_New.Expensify.AdHoc.mp4

@SzymczakJ
Copy link
Contributor Author

I've improved performance of the TextInput animation, tell me what do you think @shawnborton.
I've sqeezed as much as I could from it, but when we improve the overall performance of Reports page in future iterations, the animation will also become smoother. At the moment the animation might lag, when we focus the input right after navigating to Reports, just because rendering Reports page is so heavy and JS thread is busy for couple of seconds

Copy link
Contributor

github-actions bot commented Feb 6, 2025

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

@luacmartins
Copy link
Contributor

I've kicked off an adhoc build

@luacmartins
Copy link
Contributor

@luacmartins Tester cannot repro the issue using mentioned #56326 (comment)

Thanks @IuliiaHerets

@dannymcclain
Copy link
Contributor

😕 I'm kinda with you, it really doesn't feel great.

@dubielzyk-expensify
Copy link
Contributor

What's our easing on this animation? I wonder if it's jank or just animation timing weirdness?

@ikevin127
Copy link
Contributor

🚀 LGTM - Completed PR Reviewer Checklist ✅

Beside the tests mentioned in OP, I tested the following issues from last (reverted) PR:

  • Android & iOS - Reports - Reports page is not opened instantly

    iOS: Native
    ios.mp4

    Note: Minimal animation delay when focusing the input, expected as mentioned in #56326 (comment).

  • ⚠️ Previous PR tutorial popover placement issue

    This was fixed in the other PR but I noticed that on narrow layout devices the "Customize your search here!" popover. This happens on both mWeb and Native (iOS/Android), here's a video compared to current staging which proves that the issue is only present on this PR:

    See videos
    Android: mWeb (PR / Staging) iOS: mWeb (PR / Staging)
    issue-mweb-ba.webm
    issue-mweb-b-a.mp4

@luacmartins Let me know whether the above issue should be addressed and depending on your response I'll 🟢 Approve right away or await the fix and retest then Approve.

@SzymczakJ
Copy link
Contributor Author

I've used other approach to our TextInput animation, right now we let the animation go first and after it's complete we change the state, that should make it smoother. Can you guys check it out @shawnborton @dubielzyk-expensify @dannymcclain?
On my end it runs with better performance.

@shawnborton
Copy link
Contributor

I will run another test build for us.

Copy link
Contributor

github-actions bot commented Feb 7, 2025

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

Copy link
Contributor

github-actions bot commented Feb 7, 2025

🧪🧪 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/56326/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/56326/NewExpensify.dmg https://56326.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@shawnborton
Copy link
Contributor

Hmm no iOS... maybe we need to merge main?

@SzymczakJ
Copy link
Contributor Author

SzymczakJ commented Feb 10, 2025

Merged main, can you try running build again? @shawnborton

Copy link
Contributor

🚧 @dannymcclain 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/56326/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/56326/NewExpensify.dmg https://56326.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@SzymczakJ
Copy link
Contributor Author

SzymczakJ commented Feb 10, 2025

I think something is broken with adhoc build workflow, because all of adhoc builds are failing since Friday. I've written about this on open-source.

@shawnborton
Copy link
Contributor

Sounds good, keep us posted when you think we can run another test build so we can see how mobile feels.

@luacmartins
Copy link
Contributor

@SzymczakJ we're running into some failing tests, e.g.

Error: src/components/Search/SearchAutocompleteInput.tsx(132,17): error TS2590: Expression produces a union type that is too complex to represent.
/home/runner/work/App/App/src/components/Search/SearchPageHeader/SearchPageHeaderInput.tsx
Error:   6:[19](https://github.com/Expensify/App/actions/runs/13245788569/job/36971853810?pr=56326#step:4:20)  error  'runOnJS' is defined but never used           @typescript-eslint/no-unused-vars
Error:   6:28  error  'useAnimatedStyle' is defined but never used  @typescript-eslint/no-unused-vars
Error:   6:46  error  'useSharedValue' is defined but never used    @typescript-eslint/no-unused-vars
Error:   6:62  error  'withTiming' is defined but never used        @typescript-eslint/no-unused-vars

Let's fix those too.

I'll look into the failing iOS build

@luacmartins
Copy link
Contributor

Hmm the build is succeeding locally. I'll try to delete caches and run it again.

Copy link
Contributor

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

@luacmartins
Copy link
Contributor

That didn't work. Asked here since that PR is sus

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/56326/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/56326/NewExpensify.dmg https://56326.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@SzymczakJ
Copy link
Contributor Author

I think the adhoc builds are working now, can you try to build and retest it? The mobile animation should be ready to test, I've just noticed a small bug on mWeb and I'm working on it.

@luacmartins
Copy link
Contributor

Started a new build

Copy link
Contributor

🚧 @luacmartins 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/56326/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/56326/NewExpensify.dmg https://56326.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@luacmartins
Copy link
Contributor

@SzymczakJ can you merge main? Maybe we need some changes from main to get adhoc builds working again

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