-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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
[Search] Add From & To advanced filters #46962
[Search] Add From & To advanced filters #46962
Conversation
@luacmartins Please take a look at the code of
If you search for ☝️ not sure which one is the closest to ours. Questions:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think what you have here is a great start. I think the from
options could be simplified to only users, so no reports, etc. That being said, we can start with the same logic for both filters to get this one out and then adjust later.
The to
option should be the same as we have in MoneyRequestParticipantsSelector
, which is what you implemented here. The only thing that we could leave out is the Recents
and Contacts
section, but I think that'd be more work so let's go with what you have here. I left a suggestion for the options though, so we exclude/include a few more options.
Everything else looks good. One thing that I noticed is that the backend filter will not work with reportIDs right now, so I'll need to update it to handle those as well.
src/pages/Search/SearchAdvancedFiltersPage/SearchFiltersParticipantsSelector.tsx
Outdated
Show resolved
Hide resolved
Answered above, but yes these options should mirror what we have in
I think we can keep the same logic we have in
Yea, this looked correct to me when I tested this PR. |
2143b5b
to
8f5be97
Compare
@rayane-djouah 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] |
@Kicu - We have merge conflicts, Could you please merge main? |
src/pages/Search/SearchAdvancedFiltersPage/SearchFiltersParticipantsSelector.tsx
Outdated
Show resolved
Hide resolved
Bug 1: We're handling persons in "From" and "To" filters but we're not correctly handling workspaces: Screen.Recording.2024-08-09.at.7.29.02.AM.mov |
Hmm, If we set a "To" Screen.Recording.2024-08-09.at.7.34.17.AM.mov |
conflicts with main are solved, I will be looking at review comments soon |
This bug is also partly on the backend, so I'll need to fix that in the API too. |
Yea, I think this is expected for now. I'm not sure if we have a way to tell them apart since the ultimate person that expense was submitted to is also the selected user. |
@luacmartins for Bug 1 what id should be sent for workspace selection? should the list of |
Great questions! I'm trying to figure that out too haha @trjExpensify @JmillsExpensify what is the expected behavior when users select a workspace on the from/to filter? Do we lookup the admin accountIDs for that workspace and include all admins when searching? |
That seems like a workaround haha I spent some time trying to figure out where we filter the current user out, but got lost in the complex logic. Ideally we find out where we're filtering the current user out and add an option to not do so. |
@Kicu so interesting development. The |
Will re-review shortly |
src/pages/Search/SearchAdvancedFiltersPage/SearchFiltersFromPage.tsx
Outdated
Show resolved
Hide resolved
}} | ||
onSelectRow={handleParticipantSelection} | ||
isLoadingNewOptions={!!isSearchingForReports} | ||
/> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
newSections.push({ | ||
title: '', | ||
data: chatOptions.recentReports, | ||
shouldShow: chatOptions.recentReports.length > 0, | ||
}); | ||
|
||
newSections.push({ | ||
title: '', | ||
data: chatOptions.personalDetails, | ||
shouldShow: chatOptions.personalDetails.length > 0, | ||
}); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a delay between displaying the personalDetails
options and the recentReports
options. However, I’m wondering if we even need to include the recentReports
options at all. Shouldn’t we display the personalDetails
options along with the currentUserOption
only?
Screen.Recording.2024-08-13.at.12.36.40.PM.mov
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It totally made sense to me, but it turns out that a lot of the search options is actually coming from recentReports
:/ I don't fully understand how this whole feature of searching works.
I tried removing recent searches in this commit: 68969fe
and the result is that you cannot find almost any option. It seems that most (if not all) results of searching for users is actually stored inside chatOptions.recentReports
and not chatOptions.personalDetails
.
I will bring recent reports back in a separate comment. Feel free to test this yourself by removing/adding the recentReports section.
How this works is quite confusing 😕
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is wild 🤯 I'm also not sure why that'd be the case, but it seems like we need to keep recentReports
for now.
fixed wrong name, fixed "no results" header message missing, and removed recent reports. @rayane-djouah In the video below I'm logging length of options passed to the component. This is logged in rendering rec-web-userlist.mp4 |
setSearchTerm(value); | ||
}} | ||
onSelectRow={handleParticipantSelection} | ||
isLoadingNewOptions={!!isSearchingForReports} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that displaying this screen with a loading screen until we have all the data and pre-select options is a good idea. we are doing this in other selection lists like MoneyRequestParticipantsSelector
isLoadingNewOptions={!!isSearchingForReports} | |
isLoadingNewOptions={!!isSearchingForReports} | |
showLoadingPlaceholder={!didScreenTransitionEnd || !areOptionsInitialized || !initialAccountIDs || !personalDetails} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree. We can show the loading skeleton until the list is fully loaded, like we do for the start chat list
Screen.Recording.2024-08-13.at.10.25.19.AM.mov
const noResultsFound = chatOptions.personalDetails.length === 0 && chatOptions.recentReports.length === 0 && !chatOptions.currentUserOption; | ||
const headerMessage = noResultsFound ? translate('common.noResultsFound') : undefined; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
const noResultsFound = chatOptions.personalDetails.length === 0 && chatOptions.recentReports.length === 0 && !chatOptions.currentUserOption; | |
const headerMessage = noResultsFound ? translate('common.noResultsFound') : undefined; |
Nice, seems like we're really close to getting this merged! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good. Left a small suggestion
Please re-review @rayane-djouah @luacmartins I hope I implemented all the suggestions. rec-web-filters-loading.mp4 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 verified the steps for local testing are in the
- 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 notonIconClick
). - 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
- 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.
- 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 usingAvatar
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. foronClick={this.submit}
the methodthis.submit
should be bound tothis
in the constructor) - Any internal methods bound to
this
are necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);
ifthis.submit
is never passed to a component event handler likeonClick
) - 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 thatAvatar
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 theTest
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-08-14.at.3.06.16.PM.mov
Android: mWeb Chrome
Screen.Recording.2024-08-14.at.3.02.18.PM.mov
iOS: Native
Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-08-14.at.15.09.46.mp4
iOS: mWeb Safari
Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-08-14.at.14.56.38.mp4
MacOS: Chrome / Safari
Screen.Recording.2024-08-14.at.2.49.25.PM.mov
MacOS: Desktop
Screen.Recording.2024-08-14.at.3.01.17.PM.mov
I've found a bug reproducible on all the filters pages: the Save button is hidden behind the keyboard on mWeb Safari (you need to dismiss the keyboard to click on the save button): Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-08-14.at.14.59.08.mp4Do you prefer to address this separately? |
Yea, let's fix that in a follow up. cc @SzymczakJ @Guccio163 since you're working on the next filters. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.21-0 🚀
|
Hi @luacmartins @Kicu, We have a tiny problem here that we can work on as a follow-up: #47537. I will assign the GH to you guys. Thanks. |
Thanks for the ping! We'll work on a fix. |
🚀 Deployed to production by https://github.com/Beamanator in version: 9.0.21-4 🚀
|
🚀 Deployed to production by https://github.com/Beamanator in version: 9.0.21-4 🚀
|
Details
MoneyRequestParticipantsSelector
)accountID
s for both filters and sending them as part of AST queryTwo caveats:
SearchResults
page we display the query to the user and for now we will show just ids:from:<id>,<id2> to:<id>
. This looks bad but is a more general issue, and I suggest this is solved in a separate PR where we agree what we want to show to the user. Related discussion about other filters here: Add keyword advanced filter for Search #46799 (comment)Fixed Issues
$ #46035
PROPOSAL:
Tests
/search/filters
From
filter and test selecting some usersTo
filter and test selecting some usersView Results
the correct query is set in browser URL and correct Network request payload is sent; API might not return correct data yetOffline tests
QA Steps
/search/filters
From
filter and test selecting some usersTo
filter and test selecting some usersView Results
data is correctly filteredPR Author Checklist
### Fixed Issues
section aboveTests
sectionOffline steps
sectionQA steps
sectiontoggleReport
and notonIconClick
)myBool && <MyComponent />
.src/languages/*
files and using the translation methodSTYLE.md
) were followedAvatar
, I verified the components usingAvatar
are working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
)Avatar
is modified, I verified thatAvatar
is working as expected in all cases)Design
label and/or tagged@Expensify/design
so the design team can review the changes.ScrollView
component to make it scrollable when more elements are added to the page.main
branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTest
steps.Screenshots/Videos
Android: Native
rec-andr-participant-filter.mp4
Android: mWeb Chrome
rec-webandr-filters.mp4
iOS: Native
rec-ios-participant-filter.mp4
iOS: mWeb Safari
rec-webios-filters.mp4
MacOS: Chrome / Safari
rec-web-participant-filter.mp4
MacOS: Desktop