[Search v1] Create Search widget #40903

Kicu · 2024-04-24T14:37:04Z

Details

this PR implements this part of the doc: https://docs.google.com/document/d/1u6tBxmoKAEc70jvyZHaKykcfyC5iyEaewfgYXUSSbBc/edit#bookmark=kix.ndabi93vuj44
this handles onyx keys + types, data loading logic and empty states logic
it only introduces data-related parts of Search component - the actual list with items will come in a separate PR
unfortunately there is no api yet, so I had to test it with moc data provided in the doc: https://docs.google.com/document/d/1u6tBxmoKAEc70jvyZHaKykcfyC5iyEaewfgYXUSSbBc/edit#bookmark=id.scrttsoo8ugn

Fixed Issues

$ #39879
PROPOSAL:

Tests

to enter new Search page go to Settings > Troubleshoot > New Search Page
by default you should see the "empty" view
since there is no backend yet, in order to see that onyx correctly displays the data you need to copy-paste Onyx.set command (found below) into browser console - 2 element ids should appear
in general I suggest to review code since without data from backend it's hard to fully test how this looks :(

fake data code snippet

// run this code in browser console to insert fake data:
// hash is the hashed param from URL, by default it should be 96673 for string "all"
Onyx.set(`snapshot_${hash}`, {
            search: {
                offset: 0,
                type: 'transaction',
                hasMoreResults: false,
            },
            data: {
                transactions_1234: {
                    receipt: {source: 'http...'},
                    hasEReceipt: false,
                    created: '2024-04-11 00:00:00',
                    amount: 12500,
                    type: 'cash',
                    reportID: '1',
                    transactionThreadReportID: '2',
                    transactionID: '1234',
                },
                transactions_5555: {
                    receipt: {source: 'http...'},
                    hasEReceipt: false,
                    created: '2024-04-11 00:00:00',
                    amount: 12500,
                    type: 'cash', // not present in live data (data outside of snapshot_)
                    reportID: '1',
                    transactionThreadReportID: '2',
                    transactionID: '5555',
                },
            },
        })

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

empty

with temp data

MacOS: Desktop

src/components/SelectionList/TemporaryExpenseListItem.tsx

src/pages/Search/SearchPageBottomTab.tsx

src/components/Search.tsx

melvin-bot · 2024-04-25T15:04:31Z

@dukenv0307 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 · 2024-04-25T15:04:54Z

Ready to review but I have a TS error which I do not yet understand, I will be fixing it tomorrow

src/ONYXKEYS.ts

src/languages/en.ts

src/libs/SearchUtils.ts

src/types/onyx/SearchResults.ts

src/libs/API/types.ts

src/components/SelectionList/TemporaryExpenseListItem.tsx

src/ONYXKEYS.ts

src/components/Search.tsx

luacmartins · 2024-04-25T22:17:59Z

src/components/Search.tsx

- tooltip?: string;
+ useEffect(() => {
+ SearchActions.search(query);
+ }, [query]);


Hmm I found it to be a bit weird that refreshing the page doesn't trigger a call to search, but that's something we could iron out later in a follow up if needed.

I believe the search() gets called, but its the implementation of isNetworkOffline thats breaking it.
I did some logging and in the beginning the NETWORK sets isOffline to true for a split second, and that is when the useEffect triggers. Then a bit later isOffline is correctly set to false but by then effect has already run and no search call was made.

Not sure how to fix this, need some guidance from you. Is that the intended behavior of ONYXKEYS.NETWORK?

I don't think that's a blocker for now. Let's move on and address this as a follow up.

Kicu · 2024-04-26T10:13:47Z

@luacmartins thanks for the comments, I implemented almost all the changes you requested.

There is one thing which I would like to do in a separate PR, and that is the proper implementation of SearchUtils.getListItem()/getSections().
In order to implement them using the mapping object, probably some generic TS types will have to be introduced, because you need to bind them together using an interface. Otherwise if we just return typesMap[type].ListItem this is any/unknown to TS.

However the next issue to do is actually the items list + TransactionLIstItem component, and those will have to be bound via interface, because thats is what SelectionList expects anyway.
See: https://github.com/Expensify/App/blob/main/src/components/SelectionList/index.tsx#L8

So I would prefer to keep this PR as is and fix this in another PR, where I would have to do a common interface anyways. It will be easier to do it then, right now it will require a bit of TS-hacking to achieve this

luacmartins · 2024-04-26T12:53:32Z

That makes sense, let's address the proper implementation of those methods in a follow up then!

luacmartins · 2024-04-26T12:54:06Z

@dukenv0307 could you please prioritize reimbursing this PR when you're online? Thank you!

dukenv0307 · 2024-04-26T14:03:19Z

I'm reviewing...

luacmartins

LGTM and tests well with the API

dukenv0307 · 2024-04-26T14:25:34Z

src/pages/Search/SearchFilters.tsx

 return (
 <SearchFiltersNarrow
 filterItems={filterItems}
- activeItemLabel={activeItemLabel}
+ activeItemLabel={String(query)}


Suggested change

activeItemLabel={String(query)}

activeItemLabel={query}

Let's not block on this. We can address this in a follow up @Kicu @WojtekBoman

dukenv0307 · 2024-04-26T14:30:46Z

@Kicu @luacmartins just have one minor comment. Otherwise it looks good

dukenv0307 · 2024-04-26T14:31:44Z

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

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

luacmartins · 2024-04-26T14:31:47Z

Nice! Let's not block on that comment. I can post the screenshots since I have access to the API internally. Unless @dukenv0307 has them already :)

dukenv0307 · 2024-04-26T14:34:30Z

@luacmartins I'm doing the screenshots and videos. But I just use the mock data provided by @Kicu

luacmartins · 2024-04-26T14:35:36Z

Sounds good! Thank you!

dukenv0307 · 2024-04-26T14:49:42Z

Tests well, @luacmartins we're good to merge

OSBotify · 2024-04-26T15:02:17Z

✋ 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 · 2024-04-26T23:21:53Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.67-0 🚀

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

OSBotify · 2024-04-29T23:13:40Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.67-7 🚀

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

OSBotify · 2024-04-30T00:41:09Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.67-7 🚀

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

Kicu force-pushed the kicu/search-v1/search-widget branch from 5e147de to 6563edd Compare April 25, 2024 13:24

WojtekBoman reviewed Apr 25, 2024

View reviewed changes

src/components/SelectionList/TemporaryExpenseListItem.tsx Outdated Show resolved Hide resolved

src/pages/Search/SearchPageBottomTab.tsx Outdated Show resolved Hide resolved

Kicu commented Apr 25, 2024

View reviewed changes

src/components/Search.tsx Outdated Show resolved Hide resolved

Kicu added 2 commits April 25, 2024 16:37

Add initial version of SearchWidget

8ebee6a

Add SearchWidget handling basic search data logic

9980f66

Kicu force-pushed the kicu/search-v1/search-widget branch from 747ea2b to 07c73f2 Compare April 25, 2024 14:48

luacmartins self-requested a review April 25, 2024 14:53

Improve SearchWidget layout and behavior

bb4195b

Kicu force-pushed the kicu/search-v1/search-widget branch from 07c73f2 to bb4195b Compare April 25, 2024 15:03

Kicu marked this pull request as ready for review April 25, 2024 15:04

Kicu requested a review from a team as a code owner April 25, 2024 15:04

melvin-bot bot requested review from dukenv0307 and removed request for a team April 25, 2024 15:04

luacmartins requested changes Apr 25, 2024

View reviewed changes

luacmartins changed the title ~~[WIP] [Search v1] Create Search widget~~ [Search v1] Create Search widget Apr 25, 2024

luacmartins reviewed Apr 25, 2024

View reviewed changes

src/components/Search.tsx Outdated Show resolved Hide resolved

luacmartins reviewed Apr 25, 2024

View reviewed changes

Add fixes to Search widget after review

6665e29

luacmartins approved these changes Apr 26, 2024

View reviewed changes

dukenv0307 reviewed Apr 26, 2024

View reviewed changes

dukenv0307 approved these changes Apr 26, 2024

View reviewed changes

melvin-bot bot requested a review from luacmartins April 26, 2024 14:49

luacmartins approved these changes Apr 26, 2024

View reviewed changes

luacmartins merged commit c50de77 into Expensify:main Apr 26, 2024
16 of 20 checks passed

github-actions bot mentioned this pull request Apr 26, 2024

Deploy Checklist: New Expensify 2024-04-26 #41122

Closed

63 tasks

melvin-bot bot mentioned this pull request Apr 29, 2024

[HOLD for payment 2024-05-06] [$250] [Search v1] Create Search widget #39879

Closed

Kicu deleted the kicu/search-v1/search-widget branch June 10, 2024 13:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Search v1] Create Search widget #40903

[Search v1] Create Search widget #40903

Kicu commented Apr 24, 2024 •

edited

Loading

melvin-bot bot commented Apr 25, 2024

Kicu commented Apr 25, 2024

luacmartins Apr 25, 2024

Kicu Apr 26, 2024

luacmartins Apr 26, 2024

Kicu commented Apr 26, 2024 •

edited

Loading

luacmartins commented Apr 26, 2024

luacmartins commented Apr 26, 2024

dukenv0307 commented Apr 26, 2024

luacmartins left a comment

dukenv0307 Apr 26, 2024

luacmartins Apr 26, 2024

dukenv0307 commented Apr 26, 2024

dukenv0307 commented Apr 26, 2024 •

edited

Loading

luacmartins commented Apr 26, 2024 •

edited

Loading

dukenv0307 commented Apr 26, 2024

luacmartins commented Apr 26, 2024

dukenv0307 commented Apr 26, 2024

OSBotify commented Apr 26, 2024

OSBotify commented Apr 26, 2024

OSBotify commented Apr 29, 2024

OSBotify commented Apr 30, 2024

[Search v1] Create Search widget #40903

[Search v1] Create Search widget #40903

Conversation

Kicu commented Apr 24, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

empty

with temp data

melvin-bot bot commented Apr 25, 2024

Kicu commented Apr 25, 2024

luacmartins Apr 25, 2024

Choose a reason for hiding this comment

Kicu Apr 26, 2024

Choose a reason for hiding this comment

luacmartins Apr 26, 2024

Choose a reason for hiding this comment

Kicu commented Apr 26, 2024 • edited Loading

luacmartins commented Apr 26, 2024

luacmartins commented Apr 26, 2024

dukenv0307 commented Apr 26, 2024

luacmartins left a comment

Choose a reason for hiding this comment

dukenv0307 Apr 26, 2024

Choose a reason for hiding this comment

luacmartins Apr 26, 2024

Choose a reason for hiding this comment

dukenv0307 commented Apr 26, 2024

dukenv0307 commented Apr 26, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

luacmartins commented Apr 26, 2024 • edited Loading

dukenv0307 commented Apr 26, 2024

luacmartins commented Apr 26, 2024

dukenv0307 commented Apr 26, 2024

OSBotify commented Apr 26, 2024

OSBotify commented Apr 26, 2024

OSBotify commented Apr 29, 2024

OSBotify commented Apr 30, 2024

Kicu commented Apr 24, 2024 •

edited

Loading

Kicu commented Apr 26, 2024 •

edited

Loading

dukenv0307 commented Apr 26, 2024 •

edited

Loading

luacmartins commented Apr 26, 2024 •

edited

Loading