[Search v1] Implement dynamic columns #41672

WojtekBoman · 2024-05-06T13:42:01Z

Details

This PR adds support for dynamic columns on SearchPage.

Fixed Issues

$ #39891
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Log in to New Expensify.
Open the Account Settings.
Go to the Troubleshoot section.
Open the Search Page.
Verify that the Category and Tag columns are visible if there is at least one transaction with defined values for these columns.

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

Screen.Recording.2024-05-07.at.12.43.32.mov

MacOS: Desktop

Screen.Recording.2024-05-07.at.12.41.10.mov

Kicu

Left you some comments that I think you can improve

src/types/onyx/SearchResults.ts

src/libs/SearchUtils.ts

src/components/SelectionList/TransactionListItem.tsx

Kicu · 2024-05-06T14:27:33Z

Hey a general comment @WojtekBoman @luacmartins

Why do we repeat all the fields for search transaction in this file: https://github.com/Expensify/App/blob/main/src/components/SelectionList/types.ts#L131

when we have already defined the object in here: https://github.com/Expensify/App/blob/main/src/types/onyx/SearchResults.ts#L24

That is unnecessary redundancy IMO and makes the types more complex than they should be. The types for the list item should import+consume the types for search to make sure everything in TransactionListItem is the same as in the item returned from api and saved to Onyx.

A side problem is that we are lying in types - we say that type TransactionListItemType = ListItem & { ... } but that is not true. Our TransactionListItem has zero props from ListItem because no piece of code is assigning those.
Right now in our case TransactionListItemType === SearchTransaction because the list items are exactly what gets returned from the getSections function.

luacmartins

Looking good. Left a few comments.

luacmartins · 2024-05-06T18:01:14Z

src/CONST.ts

+    SEARCH_TABLE_OPTIONAL_COLUMNS: {
+        CATEGORY: 'category',
+        TAG: 'tag',
+    },


I think we can remove this and just use the values defined in SEARCH_TABLE_COLUMNS

src/components/SelectionList/TransactionListItem.tsx

src/types/onyx/SearchResults.ts

src/components/SelectionList/TransactionListItem.tsx

Kicu

Good improvements 👍

WojtekBoman · 2024-05-07T15:01:25Z

@luacmartins I haven't added yet a column for taxes, do we have a field for that in data structure that we obtain from the API? I think that we can go ahead with this PR and add this column in another PR once we receive this data from the backend.

melvin-bot · 2024-05-07T15:21:09Z

@akinwale 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 · 2024-05-07T16:01:57Z

@luacmartins I haven't added yet a column for taxes, do we have a field for that in data structure that we obtain from the API? I think that we can go ahead with this PR and add this column in another PR once we receive this data from the backend.

We do send that data from the API already if tax tracking is enabled on the policy, so we should add that here.

luacmartins

Looks good. We just need to add the tax column now

src/CONST.ts

luacmartins

Left a couple of comments. Additionally, there are a few layout issues:

Table headers wrap to new line. They should truncate instead
Users, category and tag cells can overflow into the action button/amount/date area

luacmartins · 2024-05-08T14:32:36Z

src/components/SelectionList/SearchTableHeader.tsx

+                        <Text style={[styles.mutedNormalTextLabel]}>{translate('common.tag')}</Text>
+                    </View>
+                )}
+                {!shouldShowTaxColumn && (


Suggested change

{!shouldShowTaxColumn && (

{shouldShowTaxColumn && (

luacmartins · 2024-05-08T14:46:23Z

src/components/SelectionList/TransactionListItem.tsx

@@ -61,6 +62,7 @@ function TransactionListItem<TItem extends ListItem>({
    const isFromExpenseReport = transactionItem.reportType === CONST.REPORT.TYPE.EXPENSE;
    const date = TransactionUtils.getCreated(transactionItem as OnyxEntry<Transaction>, CONST.DATE.MONTH_DAY_ABBR_FORMAT);
    const amount = TransactionUtils.getAmount(transactionItem as OnyxEntry<Transaction>, isFromExpenseReport);
+    const taxAmount = TransactionUtils.getAmount(transactionItem as OnyxEntry<Transaction>);


This is not correct as it'll get the full transaction amount, we should use getTaxAmount

Suggested change

const taxAmount = TransactionUtils.getAmount(transactionItem as OnyxEntry<Transaction>);

const taxAmount = TransactionUtils.getTaxAmount(transactionItem as OnyxEntry<Transaction>);

luacmartins

Looking good. I noticed another small style issue now, the category and tag should be left aligned. We can probably follow the same logic we have for the users.

luacmartins

LGTM. @akinwale all yours. Let's get this merged soon.

akinwale · 2024-05-13T11:16:28Z

I'll review later today.

akinwale · 2024-05-13T13:30:21Z

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

41672-android-native.mp4

Android: mWeb Chrome

41672-android-chrome.mp4

iOS: Native

41672-ios-native.mp4

iOS: mWeb Safari

41672-ios-safari.mp4

MacOS: Chrome / Safari

41672-web.mp4

MacOS: Desktop

41672-desktop.mp4

akinwale · 2024-05-13T13:37:56Z

@WojtekBoman The tax amount is not displayed on small screen widths, both mWeb and native.

luacmartins · 2024-05-13T23:07:05Z

That's expected. I don't think the current design displays tax amount on narrow screens

akinwale

LGTM.

OSBotify · 2024-05-14T06:30:02Z

✋ 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-15T10:14:06Z

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

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

OSBotify · 2024-05-22T23:59:06Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.4.74-6 🚀

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

WojtekBoman added 2 commits May 6, 2024 13:46

Add dynamic columns

3ffa907

Handle displaying Tag and Category on small screens

666f58e

Kicu suggested changes May 6, 2024

View reviewed changes

WojtekBoman changed the title ~~Search v1 p2/dynamic columns~~ [Search v1] Implement dynamic columns May 6, 2024

luacmartins requested changes May 6, 2024

View reviewed changes

luacmartins mentioned this pull request May 6, 2024

[Search v1] Implement remaining columns #41630

Closed

WojtekBoman added 3 commits May 7, 2024 10:29

Add TextWithIconCell

392bf3c

Remove CONST.SEARCH_TABLE_OPTIONAL_COLUMNS

22a00fa

Refactor TransactionListItemType

72e75b5

Kicu approved these changes May 7, 2024

View reviewed changes

Add docs for SearchTransaction

ac96c83

WojtekBoman marked this pull request as ready for review May 7, 2024 15:21

WojtekBoman requested review from a team as code owners May 7, 2024 15:21

melvin-bot bot requested review from akinwale and removed request for a team May 7, 2024 15:21

luacmartins self-requested a review May 7, 2024 16:02

luacmartins requested changes May 7, 2024

View reviewed changes

src/CONST.ts Show resolved Hide resolved

Add tax column

bbbd786

luacmartins requested changes May 8, 2024

View reviewed changes

WojtekBoman added 4 commits May 9, 2024 09:18

Merge branch 'main' into search-v1-p2/dynamic-columns

91aa8c7

Add SearchTableHeaderColumn

ee24845

Fix displaying users in TransactionListItem

74d3a88

Fix displaying category and tag cells in TransactionListItem

ed74c1a

luacmartins self-requested a review May 9, 2024 17:04

luacmartins reviewed May 9, 2024

View reviewed changes

Add style fixes to TransactionListItem

2fe5f20

luacmartins previously approved these changes May 10, 2024

View reviewed changes

Merge branch 'main' into search-v1-p2/dynamic-columns

f803748

WojtekBoman dismissed luacmartins’s stale review via f803748 May 13, 2024 07:32

luacmartins approved these changes May 13, 2024

View reviewed changes

akinwale approved these changes May 14, 2024

View reviewed changes

melvin-bot bot requested a review from luacmartins May 14, 2024 06:16

luacmartins approved these changes May 14, 2024

View reviewed changes

luacmartins merged commit 084d8cd into Expensify:main May 14, 2024
18 checks passed

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

Deploy Checklist: New Expensify 2024-05-15 #42185

Closed

izarutskaya mentioned this pull request May 16, 2024

[HOLD for payment 2024-06-11] [Held PR #42248] [Search v1] Date and Merchant value text isn't line with each other in the row #42269

Closed

6 tasks

luacmartins mentioned this pull request May 29, 2024

[HOLD for payment 2024-05-29][Search v1] Implement dynamic columns #39891

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Search v1] Implement dynamic columns #41672

[Search v1] Implement dynamic columns #41672

WojtekBoman commented May 6, 2024 •

edited

Loading

Kicu left a comment

Kicu commented May 6, 2024

luacmartins left a comment

luacmartins May 6, 2024

Kicu left a comment

WojtekBoman commented May 7, 2024

melvin-bot bot commented May 7, 2024

luacmartins commented May 7, 2024

luacmartins left a comment

luacmartins left a comment

luacmartins May 8, 2024

luacmartins May 8, 2024

luacmartins left a comment

luacmartins left a comment

akinwale commented May 13, 2024

akinwale commented May 13, 2024

akinwale commented May 13, 2024

luacmartins commented May 13, 2024

akinwale left a comment

OSBotify commented May 14, 2024

OSBotify commented May 15, 2024

OSBotify commented May 22, 2024

	const taxAmount = TransactionUtils.getAmount(transactionItem as OnyxEntry<Transaction>);
	const taxAmount = TransactionUtils.getTaxAmount(transactionItem as OnyxEntry<Transaction>);

[Search v1] Implement dynamic columns #41672

[Search v1] Implement dynamic columns #41672

Conversation

WojtekBoman commented May 6, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Kicu left a comment

Choose a reason for hiding this comment

Kicu commented May 6, 2024

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins May 6, 2024

Choose a reason for hiding this comment

Kicu left a comment

Choose a reason for hiding this comment

WojtekBoman commented May 7, 2024

melvin-bot bot commented May 7, 2024

luacmartins commented May 7, 2024

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins May 8, 2024

Choose a reason for hiding this comment

luacmartins May 8, 2024

Choose a reason for hiding this comment

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins left a comment

Choose a reason for hiding this comment

akinwale commented May 13, 2024

akinwale commented May 13, 2024

Reviewer Checklist

Screenshots/Videos

akinwale commented May 13, 2024

luacmartins commented May 13, 2024

akinwale left a comment

Choose a reason for hiding this comment

OSBotify commented May 14, 2024

OSBotify commented May 15, 2024

OSBotify commented May 22, 2024

WojtekBoman commented May 6, 2024 •

edited

Loading