[No QA][Search v1] TransactionListItem and SearchTableHeader #41102

WojtekBoman · 2024-04-26T15:21:14Z

Details

Fixed Issues

$ #39876
$ #39877
$ #39880
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

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 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

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

luacmartins · 2024-04-26T15:58:04Z

src/types/onyx/SearchResults.ts

+    from: {displayName: string; avatarURL: string};
+    to: {displayName: string; avatarURL: string};


Just noting that this changed in the doc. We're now passing accountID (from) and managerID (to), so we'll have to get this information from the personalDetailsList returned in the snapshot_<hash>.data.personalDetailsList Onyx key

luacmartins

Looking good! Left a small suggestion so far. The API should be deployed to production today, so we might have real data to work with soon.

luacmartins · 2024-04-29T15:19:59Z

src/libs/ReportUtils.ts

+function shouldShowMerchantColumn(transactions: Transaction[]) {
+    return transactions.some((transaction) => isExpenseReport(allReports?.[transaction.reportID] ?? {}));
+}
+


This might be better suited for the SearchUtils file

and its currently unused so I will ask @WojtekBoman if when we want to start using it and is it needed?

luacmartins · 2024-04-29T23:46:29Z

src/components/SelectionList/TransactionListItem.tsx

+                                    numberOfLines={1}
+                                    style={[styles.flex1, styles.flexGrow1, styles.textStrong]}
+                                >
+                                    {personalDetails[item.managerID]?.displayName}


From should be item.accountID

Suggested change

{personalDetails[item.managerID]?.displayName}

{personalDetails[item.accountID]?.displayName}

luacmartins · 2024-04-29T23:47:16Z

src/components/SelectionList/TransactionListItem.tsx

+                                    numberOfLines={1}
+                                    style={[styles.flex1, styles.flexGrow1, styles.textStrong]}
+                                >
+                                    {personalDetails[item.accountID]?.displayName}


To is the managerID

Suggested change

{personalDetails[item.accountID]?.displayName}

{personalDetails[item.managerID]?.displayName}

luacmartins · 2024-04-29T23:52:17Z

src/components/Search.tsx

+            ListItem={ListItem}
+            sections={[{data: mockData, isDisabled: false}]}
+            onSelectRow={(item) => {
+                openReport(item.reportID);


Suggested change

openReport(item.reportID);

openReport(item.transactionThreadReportID);

Kicu · 2024-04-30T06:29:12Z

Fixed 3 small comments from @luacmartins

Kicu · 2024-04-30T07:59:29Z

@luacmartins I think there might be some confusion on our end in how the api is supposed to work and return data (or perhaps I misunderstand how Onyx is consuming the data)

Why is personalDetailsList returned inside snapshot_<hash>.data....?
We thought it would be a top level key and get merged to the global personalDetailsList which would make it easier to use. Right now TransactionListItem connects to onyx using usePersonalDetails() hook, but the data is not there.
Can this be changed? or should we somehow pass personalDetails to every list item? this would require some extra data mapping inside SearchUtils.getTransactionsSections.
Is there a bug in the search response, where onyx key in response is snapshot_ and not snapshot_<hash>? because of that all the data gets saved under snapshot_ in onyx store and is harder to read.

luacmartins · 2024-04-30T12:52:53Z

@Kicu

We need to send the personalDetails inside the snapshot key because it's possible users wouldn't have the data locally already since in the future they'd be able to search for data users have access to, but are not getting updated on, eg threads or rooms they can view but haven't joined yet. So we'll need to get the personal details from snapshot_
There was a bug with the initial API but the fix has just been deployed to production. Could clear your storage and try again please?

melvin-bot · 2024-04-30T15:36:38Z

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

luacmartins

SWM is going ooo due to bank holidays in Poland for the rest of the week and given how this is part of a May 1st release and this functionality is still not available to users, I'm gonna merge the PR as is and will continue working on it myself, so we can keep pushing it during the rest of the week.

luacmartins · 2024-04-30T15:46:58Z

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

OSBotify · 2024-04-30T15:59:47Z

✋ 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-05-01T03:02:16Z

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

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

OSBotify · 2024-05-02T13:05:51Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.69-2 🚀

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

bernhardoj · 2024-06-15T02:12:35Z

src/components/SelectionList/TransactionListItem.tsx

+                        <View style={[styles.flex1, styles.justifyContentCenter, styles.alignItemsStretch]}>
+                            <TextWithTooltip
+                                shouldShowTooltip={showTooltip}
+                                text={item?.tag ?? ''}


A colon : in a tag name will be escaped to \:. We need to unescape them before showing the tag name. This is fixed in #43392

WojtekBoman added 7 commits April 23, 2024 15:56

Add template of SearchTableHeader

d25bcdf

Add template of ExpenseListItem

c423cb8

Merge branch 'main' into search-v1/search-table-header

6235eb1

Merge branch 'search-v1/search-table-header' into search-v1/search-list

a948542

Add test data to SearchPage

ff30cb5

Rename ExpenseListItem to TransactionListItem

13273b6

Modify TransactionListItem

0ec7b8a

luacmartins self-requested a review April 26, 2024 15:24

luacmartins reviewed Apr 26, 2024

View reviewed changes

WojtekBoman and others added 6 commits April 29, 2024 09:52

Merge branch 'main' into search-v1/search-list

c598002

Refactor SearchUtils

dcad06e

add styles for narrow screens for TransactionListItem

c2c2203

Add SearchTransactionType

26a354f

handle clicking on TransactionListItem

1969563

Add flex1 to views with text

19c976e

luacmartins self-requested a review April 29, 2024 15:16

luacmartins reviewed Apr 29, 2024

View reviewed changes

improve TransactionListItem on narrow screens

cda5777

luacmartins reviewed Apr 29, 2024

View reviewed changes

Kicu added 2 commits April 30, 2024 08:23

add small fixes to TransactionListItem after review

6ff87da

Merge branch 'main' into search-v1/search-list

c7925fb

add using actual api results

71d1b58

WojtekBoman and others added 2 commits April 30, 2024 10:13

Handle opening search page with invalid queries

29d2fa5

improve TransactionListItem layout on narrow screens

596c997

Kicu force-pushed the search-v1/search-list branch from e8161c7 to 596c997 Compare April 30, 2024 10:50

add more small fixes to TransactionListItem

aa625fa

WojtekBoman added 2 commits April 30, 2024 17:14

Add fixes to Search

7995911

Fix lint

241b602

WojtekBoman marked this pull request as ready for review April 30, 2024 15:36

WojtekBoman requested review from a team as code owners April 30, 2024 15:36

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

luacmartins changed the title ~~[WIP][Search v1] TransactionListItem and SearchTableHeader~~ [Search v1] TransactionListItem and SearchTableHeader Apr 30, 2024

luacmartins approved these changes Apr 30, 2024

View reviewed changes

luacmartins changed the title ~~[Search v1] TransactionListItem and SearchTableHeader~~ [No QA][Search v1] TransactionListItem and SearchTableHeader Apr 30, 2024

luacmartins merged commit 05793d1 into Expensify:main Apr 30, 2024
16 of 19 checks passed

github-actions bot mentioned this pull request May 1, 2024

Deploy Checklist: New Expensify 2024-05-01 #41376

Closed

59 tasks

This was referenced May 2, 2024

[HOLD for payment 2024-05-09] [$250] [Search v1] Create SearchTableHeader #39876

Closed

[HOLD for payment 2024-05-09] [$250][Search v1] Create TransactionListItem #39877

Closed

luacmartins mentioned this pull request May 10, 2024

[HOLD for payment 2024-05-22] [$250] [Search v1] Create SearchPage #39880

Closed

bernhardoj reviewed Jun 15, 2024

View reviewed changes

bernhardoj mentioned this pull request Jun 15, 2024

[$250] [HOLD for payment 2024-06-20] [HOLD for payment 2024-06-18] [Search v1] Expense with tag in Parent: Child formay shows Parent\: Child in the list #43364

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA][Search v1] TransactionListItem and SearchTableHeader #41102

[No QA][Search v1] TransactionListItem and SearchTableHeader #41102

WojtekBoman commented Apr 26, 2024 •

edited by luacmartins

Loading

luacmartins Apr 26, 2024 •

edited

Loading

luacmartins left a comment

luacmartins Apr 29, 2024

Kicu Apr 30, 2024

luacmartins Apr 29, 2024

luacmartins Apr 29, 2024

luacmartins Apr 29, 2024

Kicu commented Apr 30, 2024

Kicu commented Apr 30, 2024 •

edited

Loading

luacmartins commented Apr 30, 2024

melvin-bot bot commented Apr 30, 2024

luacmartins left a comment •

edited

Loading

luacmartins commented Apr 30, 2024 •

edited

Loading

OSBotify commented Apr 30, 2024

OSBotify commented May 1, 2024

OSBotify commented May 2, 2024

bernhardoj Jun 15, 2024

		from: {displayName: string; avatarURL: string};
		to: {displayName: string; avatarURL: string};

	{personalDetails[item.managerID]?.displayName}
	{personalDetails[item.accountID]?.displayName}

	openReport(item.reportID);
	openReport(item.transactionThreadReportID);

[No QA][Search v1] TransactionListItem and SearchTableHeader #41102

[No QA][Search v1] TransactionListItem and SearchTableHeader #41102

Conversation

WojtekBoman commented Apr 26, 2024 • edited by luacmartins Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

luacmartins Apr 26, 2024 • edited Loading

Choose a reason for hiding this comment

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins Apr 29, 2024

Choose a reason for hiding this comment

Kicu Apr 30, 2024

Choose a reason for hiding this comment

luacmartins Apr 29, 2024

Choose a reason for hiding this comment

luacmartins Apr 29, 2024

Choose a reason for hiding this comment

luacmartins Apr 29, 2024

Choose a reason for hiding this comment

Kicu commented Apr 30, 2024

Kicu commented Apr 30, 2024 • edited Loading

luacmartins commented Apr 30, 2024

melvin-bot bot commented Apr 30, 2024

luacmartins left a comment • edited Loading

Choose a reason for hiding this comment

luacmartins commented Apr 30, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Apr 30, 2024

OSBotify commented May 1, 2024

OSBotify commented May 2, 2024

bernhardoj Jun 15, 2024

Choose a reason for hiding this comment

WojtekBoman commented Apr 26, 2024 •

edited by luacmartins

Loading

luacmartins Apr 26, 2024 •

edited

Loading

Kicu commented Apr 30, 2024 •

edited

Loading

luacmartins left a comment •

edited

Loading

luacmartins commented Apr 30, 2024 •

edited

Loading