[No QA][Search v1] Create ReportListItem #42410

WojtekBoman · 2024-05-21T09:02:28Z

Details

This PR introduces a new component: ReportListItem. It was implemented according to the description in the design doc: https://docs.google.com/document/d/1ldZ85fyQO4662hLZRNFfm0_IxaP7-PWvaqc8Z33jsLQ/edit#bookmark=kix.oynw4hp8cwx5

Fixed Issues

$ #39878
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Replace a value of the data variable with:

  const data = SearchUtils.getSections(
        {
            personalDetailsList: {
                1: {
                    displayName: 'user',
                }
            },
            report_0: {
                reportID: 0,
                reportName: 'Alice’s Apples owes $110.00',
                total: 1000,
                currency: 'USD',
                action: 'pay',
            },
            transactions_1: {
                reportID: 0,
                merchant: 'test',
                amount: 1000,
                created: '2024-01-01',
                accountID: 1,
                managerID: 1,
                category: 'test',
                tag: 'test',
                taxAmount: 1
            },
            transactions_2: {
                reportID: 0,
                merchant: 'test 2',
                amount: 2000,
                created: '2024-01-02',
                accountID: 1,
                managerID: 1,
                category: 'test',
                tag: 'test',
                taxAmount: 1
            }
        } ?? {},
        type,
    );

in src/components/Search.tsx.
3. Return 'report'; in the getSearchType function in the src/libs/SearchUtils.ts file.
4. Open and log in to the app.
5. Open the Account Settings.
6. Open the Troubleshoot tab.
7. Navigate to the Search Page.
8. Verify that the ReportListItem is displayed correctly.

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

MacOS: Desktop

Kicu

In general the code looks good and it was easy to read. Good job 👍

I left you comments but most of them are minor codestyle comments, and 1 bigger thing to see whether we can use existing Checkbox component.

src/libs/SearchUtils.ts

src/components/SelectionList/ListItemCheckbox.tsx

src/components/SelectionList/TransactionListItemRow.tsx

src/components/SelectionList/TransactionListItem.tsx

src/components/SelectionList/ReportListItem.tsx

Kicu

All the changes look good. Great job 👍

luacmartins · 2024-05-22T16:46:14Z

Is this ready for review?

melvin-bot · 2024-05-22T16:47:23Z

@abdulrahuman5196 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-22T16:48:08Z

Nvm, just went ahead and marked it as ready given that it was already approved by @Kicu and the screenshots looked good. @abdulrahuman5196 please review this once you get a chance

shawnborton · 2024-05-23T09:17:22Z

For the mobile view of a report with lots of expenses:

I wonder if we should add some more space between each expense? Or maybe that will come naturally once we have the receipt thumbnails there, and it will make things feel more spacious:

Either way, in Figma we have everything at 12px gap between items so as long as we have that, we're all good.

shawnborton · 2024-05-23T09:18:29Z

Also I ran a test build but I have a feeling we can't view these styles via a test build because it requires commenting out some code... any other way to easily test?

abdulrahuman5196 · 2024-05-24T11:17:54Z

Hi @luacmartins I already have couple of overdue issues to look at, don't want to cause delay here.
Kindly remove me and add another C+ via pullerbear.

luacmartins

Looking good. Left a few comments though.

src/components/Search.tsx

src/components/SelectionList/Search/ReportListItem.tsx

src/libs/SearchUtils.ts

src/styles/index.ts

trjExpensify · 2024-05-28T12:51:55Z

@DylanDylann are you actively working on reviewing this one as a priority? Thanks!

DylanDylann · 2024-05-28T12:55:24Z

@trjExpensify I am requesting the access to docs #39878 (comment)

luacmartins · 2024-05-28T15:02:18Z

Access granted

luacmartins · 2024-05-28T16:17:20Z

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-05-28T17:48:03Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

DylanDylann · 2024-05-29T07:49:16Z

src/components/Search.tsx

@@ -93,7 +100,9 @@ function Search({query, policyIDs}: SearchProps) {
            ListItem={ListItem}
            sections={[{data, isDisabled: false}]}
            onSelectRow={(item) => {
-                openReport(item.transactionThreadReportID);
+                const reportID = isReportListItemType(item) ? item.reportID : item.transactionThreadReportID;
+


Remove this empty line

DylanDylann · 2024-05-29T07:58:11Z

src/components/Search.tsx

@@ -93,7 +100,9 @@ function Search({query, policyIDs}: SearchProps) {
            ListItem={ListItem}
            sections={[{data, isDisabled: false}]}
            onSelectRow={(item) => {
-                openReport(item.transactionThreadReportID);
+                const reportID = isReportListItemType(item) ? item.reportID : item.transactionThreadReportID;


Should we use SearchUtils.getSearchType(searchResults?.search); instead of introducing a new function

This type guard allows to check the type of the item, and then we can use a specific item field to open the report. SearchUtils.getSearchType(searchResults?.search); won't determine an exact type of the item.

DylanDylann · 2024-05-29T08:05:47Z

src/components/SelectionList/Search/ReportListItem.tsx

+
+    const actionCell = (
+        <Button
+            text={translate('common.view')}


We need to add the logic to display the correct button text. Let's see the design, the button text could be "Review", "Submit",...

For now the only option is view, but I agree that we should be getting that from the API results.

I have started to work on this a while ago and was explicitly told to wait, and the task is on HOLD so it should stay View for now.
We can fix buttons in a dedicated PR - I have a WIP draft open

DylanDylann · 2024-05-29T08:13:49Z

src/components/SelectionList/Search/ReportListItem.tsx

+                    <ExpenseItemHeaderNarrow
+                        participantFrom={participantFrom}
+                        participantTo={participantTo}
+                        buttonText={translate('common.view')}


DylanDylann · 2024-05-29T08:33:59Z

src/pages/Search/SearchPage.tsx

@@ -21,8 +21,8 @@ type SearchPageProps = StackScreenProps<CentralPaneNavigatorParamList, typeof SC
 function SearchPage({route}: SearchPageProps) {
    const {translate} = useLocalize();
    const {isSmallScreenWidth} = useWindowDimensions();
-    const currentQuery = route?.params && 'query' in route.params ? route?.params?.query : '';
-    const policyIDs = route?.params && 'policyIDs' in route.params ? route?.params?.policyIDs : undefined;
+    const currentQuery = route?.params?.query;


route?.params?.query ?? ''

DylanDylann · 2024-05-29T08:35:44Z

src/components/SelectionList/Search/ReportListItem.tsx

+
+    const openReportInRHP = (transactionItem: TransactionListItemType) => {
+        const searchParams = getSearchParams();
+        const currentQuery = searchParams && `query` in searchParams ? (searchParams?.query as string) : CONST.TAB_SEARCH.ALL;


We should use optional chaining instead of query in searchParams

I think we should pass query props from src/components/Search.tsx instead of using a new function getSearchParams

getSearchParams has been added to avoid prop drilling, this change would require passing the same value to all items in the list and would introduce many changes.

DylanDylann · 2024-05-29T08:56:34Z

@WojtekBoman There are some comments. Should we address these comments in a new PR?

cc @luacmartins

DylanDylann · 2024-05-29T09:00:15Z

I will complete the checklist in new PR

OSBotify · 2024-05-29T09:44:27Z

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

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

luacmartins · 2024-05-29T13:55:35Z

Thanks @DylanDylann! @WojtekBoman let's address the comments above while we work on #42720. I added links to that issue.

OSBotify · 2024-05-30T21:27:16Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

OSBotify · 2024-05-30T22:39:14Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

WojtekBoman added 10 commits May 16, 2024 14:27

Add template for ReportListItem

08d9b5a

Add template of getReportSections

6b69166

Fix columns alignment

3adf6c6

Merge branch 'main' into search-v1-p2/report-list-item

091b791

Add header for ReportListItem

15c67fe

Create separate components from TransactionListItem

8faa91e

Create TransactionListItemRow

fd497d3

Add isSearchReport type guard

66fa2bc

Handle navigation to the report in RHP

8dc6526

Create reportListItemTitle style

addc73e

Kicu suggested changes May 21, 2024

View reviewed changes

luacmartins self-requested a review May 22, 2024 03:51

WojtekBoman added 2 commits May 22, 2024 10:30

Refactor search components

f8cd746

Replace ListItemCheckbox with Checkbox component

7f3bb52

Kicu approved these changes May 22, 2024

View reviewed changes

Rename ExpenseItemHeader to ExpenseItemHeaderNarrow

efb9d26

luacmartins marked this pull request as ready for review May 22, 2024 16:47

luacmartins requested review from a team as code owners May 22, 2024 16:47

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team May 22, 2024 16:47

WojtekBoman added 3 commits May 23, 2024 07:56

Merge branch 'main' into search-v1-p2/report-list-item

3f24116

Add translations for grouped expenses text

2e1c4c1

Fix lint

6de2ab9

shawnborton added the Ready To Build label May 23, 2024

luacmartins requested review from DylanDylann and removed request for abdulrahuman5196 May 27, 2024 15:02

luacmartins requested changes May 27, 2024

View reviewed changes

luacmartins mentioned this pull request May 27, 2024

Create report list item #42014

Closed

60 tasks

WojtekBoman added 4 commits May 28, 2024 10:26

Merge branch 'main' into search-v1-p2/report-list-item

7a5b63f

Hide checkbox

66fc34c

Refactor styles

8f12ccd

Add getSearchParams function

c673051

Kicu mentioned this pull request May 28, 2024

[Search v1] Add sorting #42248

Merged

49 tasks

Remove todo comments

4e2942b

luacmartins approved these changes May 28, 2024

View reviewed changes

luacmartins changed the title ~~[Search v1] Create ReportListItem~~ [No QA][Search v1] Create ReportListItem May 28, 2024

luacmartins merged commit f5d28de into Expensify:main May 28, 2024
17 checks passed

luacmartins mentioned this pull request May 28, 2024

[HOLD for payment 2024-06-20] [Search v1] Improve performance of ReportListItem #42720

Closed

6 tasks

DylanDylann reviewed May 29, 2024

View reviewed changes

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

Deploy Checklist: New Expensify 2024-05-29 #42741

Closed

melvin-bot bot mentioned this pull request May 30, 2024

[HOLD for payment 2024-06-06] [$250] [Search v1] Create ReportListItem #39878

Closed

WojtekBoman mentioned this pull request Jun 5, 2024

[Search v1] Improve performance of ReportListItem #43092

Merged

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA][Search v1] Create ReportListItem #42410

[No QA][Search v1] Create ReportListItem #42410

WojtekBoman commented May 21, 2024 •

edited by luacmartins

Loading

Kicu left a comment •

edited

Loading

Kicu left a comment

luacmartins commented May 22, 2024

melvin-bot bot commented May 22, 2024

luacmartins commented May 22, 2024

shawnborton commented May 23, 2024

shawnborton commented May 23, 2024

abdulrahuman5196 commented May 24, 2024

luacmartins left a comment

trjExpensify commented May 28, 2024

DylanDylann commented May 28, 2024

luacmartins commented May 28, 2024

luacmartins commented May 28, 2024 •

edited

Loading

OSBotify commented May 28, 2024

DylanDylann May 29, 2024

DylanDylann May 29, 2024

WojtekBoman Jun 3, 2024

DylanDylann May 29, 2024

luacmartins May 29, 2024

Kicu May 29, 2024 •

edited

Loading

DylanDylann May 29, 2024

DylanDylann May 29, 2024

DylanDylann May 29, 2024

DylanDylann May 29, 2024

WojtekBoman Jun 3, 2024

DylanDylann commented May 29, 2024

DylanDylann commented May 29, 2024

OSBotify commented May 29, 2024

luacmartins commented May 29, 2024 •

edited

Loading

OSBotify commented May 30, 2024

OSBotify commented May 30, 2024

[No QA][Search v1] Create ReportListItem #42410

[No QA][Search v1] Create ReportListItem #42410

Conversation

WojtekBoman commented May 21, 2024 • edited by luacmartins Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Kicu left a comment • edited Loading

Choose a reason for hiding this comment

Kicu left a comment

Choose a reason for hiding this comment

luacmartins commented May 22, 2024

melvin-bot bot commented May 22, 2024

luacmartins commented May 22, 2024

shawnborton commented May 23, 2024

shawnborton commented May 23, 2024

abdulrahuman5196 commented May 24, 2024

luacmartins left a comment

Choose a reason for hiding this comment

trjExpensify commented May 28, 2024

DylanDylann commented May 28, 2024

luacmartins commented May 28, 2024

luacmartins commented May 28, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented May 28, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kicu May 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DylanDylann commented May 29, 2024

DylanDylann commented May 29, 2024

OSBotify commented May 29, 2024

luacmartins commented May 29, 2024 • edited Loading

OSBotify commented May 30, 2024

OSBotify commented May 30, 2024

WojtekBoman commented May 21, 2024 •

edited by luacmartins

Loading

Kicu left a comment •

edited

Loading

luacmartins commented May 28, 2024 •

edited

Loading

Kicu May 29, 2024 •

edited

Loading

luacmartins commented May 29, 2024 •

edited

Loading