[Search v1] Add small followups for sorting in search

[Kicu]

Details

• a very small PR that addresses possibly missing from or to inside transactionItem
• adjusts the sizes of 2 columns to make them a little smaller

Fixed Issues

$ #42856
PROPOSAL:

Tests

• go to Search page via Settings > Troubleshoot > New Search Page
• click on headers to trigger sorting, make sure that everything works
• the new columns popping in and out are not yet solved in this PR, ignore them

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

[Kicu]

Will this be proper name or will we revert back to singular? @luacmartins

[luacmartins]

Yes, the correct value is transaction

[Kicu]

@luacmartins
About columns (this comment): #42248 (review) I'm not sure what is the best way to follow up.

In general the issue of getting new records with bigger/longer values is inevitable. This will happen both when changing sort (as we put sorting params inside hash key) and also when lazy loading new results.
Also these are the 3 columns that are shown conditionally: https://github.com/Expensify/App/blob/main/src/libs/SearchUtils.ts#L59-L61

So they might pop-in and pop-out based on records. I believe that was your (?) decision to code them like this? We can always change that.

As for showing a loader: when doing this issue I decided the UX was bad with constant loading flicker and so I added keeping track of previous results which made the table feel more smooth.
I recorded a video showing you how it would look with loader - IMO doesn't look nice:

rec-web-sortingloader.mp4

You will get the flicker every time new data loads.

I tried to make tax and cat columns a bit smaller, check here:

I will need some more comments from you on how to move forward.

[luacmartins]

@Expensify/design I'd love your thoughts on this issue. I'm not really sure how to solve it yet for the reasons @Kicu laid out here.

[shawnborton]

Hmm it seems like the columns are not set up the way we have them designed in Figma. In Figma, we just have the columns using a width: fill, so whether or not the column has a long string wouldn't change the size of the column itself. Then we override that by giving certain columns a specific width. But if the column doesn't have an explicit width set, the idea is that it just fills as much space as it can, and all columns that do that will do so evenly amongst each other.

How do you have the column widths working right now?

[luacmartins]

@shawnborton you can see the column styles defined here. So we have:

1. Receipt - fixed width of 36px
2. Date - fixed width of 44px
3. Merchant, From, To, Category, Tax - flex1 (it fills the space)
4. Amount, total - fixed width 96px
5. Type - fixed width 44px
6. Action - fixed width 80px

[shawnborton]

Ah, that does seem right. Then why is the bug in the video happening exactly?

[luacmartins]

I think because we add/remove columns. In the video, we the Tag and Tax columns are added based on how the data is sorted. I think we might be able to get around this by returning which columns should be shown from the backend, so we always show the same columns no matter the sort order.

[shawnborton]

Got it, I think that one makes the most sense to me.

[dannymcclain]

so we always show the same columns no matter the sort order

This makes the most sense to me too. I don't think we want columns popping in and out of existence based on sort order.

[Kicu]

I don't think we want columns popping in and out of existence based on sort order.

Yeah I also agree with that, looking as a user of visual interfaces the constant jumping of columns is quite confusing.
However for now this was technically hard to avoid since so we kinda "guessed" which columns to show based on current data.

---

So how do you wanna return this from backend @luacmartins - a new field in onyx response for /search?
Won't the issue persist because you don't know in advance how many results to query? I mean: if you would query first 100-150 items for a specific search then there might be none with tax but once you query 500 then tax appears. Or is this scenario impossible?

Also a temp solution might be to hardcode this in web before June 12th, since we do have capacity in here to deliver something in web quite fast I think.

[luacmartins]

We agreed to use policy settings to determine the columns that should be shown, e.g. if the user has a policy with taxes enabled, we show the taxes column, otherwise we hide it. I'll have to work on the backend part of it and will most likely send a flag in snapshot_.search.columnsToShow or something like that. I think for now we do nothing in the frontend.

[melvin-bot]

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

[Kicu]

@luacmartins Sounds good 👍

So may I suggest we merge this PR? it has a very small fix for undefined from/to and also extracts a bit of common code to a function and makes 2 of the columns a bit smaller - which shouldn't be a problem IMO.
And once you have columnsToShow ready on backend we can open a fresh task for this, what do you think?

It will be easier to create this as a separate PR instead of continually updating this PR

[luacmartins]

@Kicu could you also disable sorting on the report views please? e.g. Shared, Drafts, Finished we won't support that for now.

[luacmartins]

We need to disable sorting on the hybrid report views, e.g. Shared, Drafts, Finished

[Kicu]

@luacmartins Changes done, we now have a list of what is sortable:
const sortableSearchTabs: SearchQuery[] = [CONST.TAB_SEARCH.ALL]

I also added small code tweaks, but did not change any logic, just moved stuff around.
Since my Shared tab is empty I tested this on All tab:

sorting allowed

sorting disallowed

[Kicu]

@luacmartins added new commit:

• type column is now not sortable by
• amount value saved in url & Api requests when sorting by total

[shawnborton]

The action column seems like it has extra padding or spacing - any idea what's going on there?

[dannymcclain]

The action column seems like it has extra padding or spacing - any idea what's going on there?

Hmm yeah, also I thought those buttons/that column was supposed to have a fixed width around 80px so that all the buttons would end up being the same width, regardless of what action it was? (Even if they're all View I would still expect us to account for different buttons widths to future-proof this a bit, right?)

[shawnborton]

Yup - that's my exact understanding as well.

[luacmartins]

Cool, I can fix the action button width in a follow up since that's not specific to this PR. Also, I've noticed that sorting by tax amount is still not implemented in the backend so we need to disable that too. I'll address that in the same follow up though

[luacmartins]

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

web.mov

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[OSBotify]

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

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.81-11 🚀

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