Fix a report preview in the comments of one expense report. by wildan-m · Pull Request #44366 · Expensify/App

wildan-m · 2024-06-25T04:02:19Z

@Pujan92 @deetergp

Details

Fix a report preview in the comments of one expense report.

Fixed Issues

$ #43034
PROPOSAL: #43034 (comment) (Alternative)

Tests

Have a HT account as admin
Create a policy with some violation (category required) and leave the submission frequency as instantly
Invite a member A
As a member A create a report with only one expense
Log in as HT admin
Open the report
Verify that expense report preview should not appear in the expense details page

Verify that no errors appear in the JS console

Offline tests

Have a HT account as admin
Create a policy with some violation (category required) and leave the submission frequency as instantly
Invite a member A
As a member A create a report with only one expense
Log in as HT admin
Make network offline
Open the expense report created from 4th step.
The page will be blank without inner expense report preview
Make network online
Verify that expense details showing and expense report preview should not appear in the expense details page

QA Steps

Same as Test

PR Author Checklist

Screenshots/Videos

Android: Native

Kapture.2024-06-25.at.08.06.31.mp4

Android: mWeb Chrome

Kapture.2024-06-25.at.08.11.01.mp4

iOS: Native

Kapture.2024-06-25.at.09.43.27.mp4

iOS: mWeb Safari

Kapture.2024-06-25.at.08.02.23.mp4

MacOS: Chrome / Safari

Kapture.2024-06-25.at.07.50.36.mp4

MacOS: Desktop

Kapture.2024-06-25.at.08.21.51.mp4

…eportActions not loaded

…nThreadReportActions not loaded" This reverts commit 725c3dd.

…eportActions not loaded

…x/43034-keep-filtering-logic-when-thread-not-loaded

melvin-bot · 2024-06-25T04:03:22Z

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

Pujan92 · 2024-06-25T16:40:17Z

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

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-06-26.at.15.53.39.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-06-26.at.16.09.26.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-06-26.at.15.37.58.mov

MacOS: Desktop

Pujan92 · 2024-06-25T17:42:16Z

@wildan-m How about passing an extra param transactionThreadReportID to the function getCombinedReportActions which helps to avoid the calculation of IOU again? With that, we only need to consider transactionThreadReportID to decide which report actions need to return.

transactionThreadReportID is available only for the one transaction thread.

App/src/libs/ReportActionsUtils.ts

Lines 953 to 956 in a272c4b

    
            * Gets the reportID for the transaction thread associated with a report by iterating over the reportActions and identifying the IOU report actions. 
        
            * Returns a reportID if there is exactly one transaction thread for the report, and null otherwise. 
        
            */ 
        
           function getOneTransactionThreadReportID(reportID: string, reportActions: OnyxEntry<ReportActions> | ReportAction[], isOffline: boolean | undefined = undefined): string | undefined {

wildan-m · 2024-06-25T20:54:36Z

@Pujan92 I think that's a good idea. Something like this, right? I'll try to test it.

function getCombinedReportActions(reportActions: ReportAction[], transactionThreadReportActions: ReportAction[], reportID?: string, transactionThreadReportID?: string): ReportAction[] {
    // There is a chance that transactionThreadReportActions is not loaded yet.
    // We only check for emptiness when there are multiple IOUs,
    // this will prevent the sub-report preview from being displayed when there is only one IOU.
    if (isEmptyObject(transactionThreadReportActions) && _.isEmpty(transactionThreadReportID)) {
        return reportActions;
    }

…x/43034-keep-filtering-logic-when-thread-not-loaded

wildan-m · 2024-06-25T21:40:39Z

@Pujan92 the PR has been updated

Pujan92

Thanks @wildan-m , suggested some minor changes.

src/libs/ReportActionsUtils.ts

Pujan92 · 2024-06-26T03:31:03Z

src/libs/ReportActionsUtils.ts

+): ReportAction[] {
+    // There is a chance that transactionThreadReportActions is not loaded yet.
+    // We only check for emptiness when there are multiple IOUs,
+    // this will prevent the sub-report preview from being displayed when there is only one IOU.


Do you think we don't need this comment now?

@Pujan92 I believe the comment is helpful as it provides a rationale for the necessity of checking for an empty transactionThreadReportID. Perhaps we could consider rephrasing it for clarity, any suggestion?

// There is a chance that transactionThreadReportActions is not loaded yet.

I thought now that we have the transactionThreadReportID, we don't need to rely on transactionThreadReportActions for that condition(ref). If we go with that then we can omit this comment bcoz the function description is enough to convey. WDYT?

src/pages/home/report/ReportActionsView.tsx

Co-authored-by: Pujan Shah <shahpujan1992@gmail.com>

Pujan92 · 2024-06-26T06:34:42Z

src/pages/home/report/ReportActionsView.tsx

    const combinedReportActions = useMemo(
-        () => ReportActionsUtils.getCombinedReportActions(allReportActions, transactionThreadReportActions),
-        [allReportActions, transactionThreadReportActions],
+        () => ReportActionsUtils.getCombinedReportActions(allReportActions, transactionThreadReportID ?? null, transactionThreadReportActions, reportID),


Suggested change

() => ReportActionsUtils.getCombinedReportActions(allReportActions, transactionThreadReportID ?? null, transactionThreadReportActions, reportID),

() => ReportActionsUtils.getCombinedReportActions(allReportActions, transactionThreadReportID ?? null, transactionThreadReportActions),

Let's avoid passing optional parameter reportID like the way how it was earlier

@Pujan92 on the submitter side, not supplying report ID will create duplicate parent report previews when we create multiple IOUs.

@Pujan92 reportID has been removed, I can't reproduce the duplicate issue with recent merging, seems the issue come from somewhere else

Pujan92 · 2024-06-26T06:39:33Z

src/libs/ReportActionsUtils.ts

+    // There is a chance that transactionThreadReportActions is not loaded yet.
+    // We only check for emptiness when there are multiple IOUs,
+    // this will prevent the sub-report preview from being displayed when there is only one IOU.
+    if (isEmptyObject(transactionThreadReportActions) && _.isEmpty(transactionThreadReportID)) {


Suggested change

if (isEmptyObject(transactionThreadReportActions) && _.isEmpty(transactionThreadReportID)) {

if (_.isEmpty(transactionThreadReportID)) {

@Pujan92, could you provide further clarification on this suggestion?

Please check this comment once. I am trying to say transactionThreadReportID is enough to decide whether it is one expense report or not.

I understand, I think that makes sense. The PR has been updated.

Pujan92

LGTM, Thanks! :)

Pujan92 · 2024-06-26T11:15:14Z

@deetergp Just to inform you, We found that transactionThreadReportID(which is specifically created to identify one expense report) is enough to decide the report actions, so we implemented this straightforward solution instead of doing any more filtration.

deetergp

Code looks good and tests well 👍

OSBotify · 2024-06-26T20:26:30Z

✋ 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-07-03T19:41:19Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.3-7 🚀

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

OSBotify · 2024-07-10T11:00:38Z

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.5-13 🚀

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

wildan-m added 9 commits June 22, 2024 08:51

getCombinedReportActions keep filtering logic when transactionThreadR…

725c3dd

…eportActions not loaded

Revert "getCombinedReportActions keep filtering logic when transactio…

2e2730a

…nThreadReportActions not loaded" This reverts commit 725c3dd.

getCombinedReportActions keep filtering logic when transactionThreadR…

4c6d350

…eportActions not loaded

Merge branch 'main' of https://github.com/wildan-m/App into wildan/fi…

fc655a5

…x/43034-keep-filtering-logic-when-thread-not-loaded

fix issue with multiple IOU

f09121f

Merge branch 'main' of https://github.com/wildan-m/App into wildan/fi…

bf11ad4

…x/43034-keep-filtering-logic-when-thread-not-loaded

Use IOU count to show sub-report preview

6ce37c7

Merge branch 'main' of https://github.com/wildan-m/App into wildan/fi…

d47b5fd

…x/43034-keep-filtering-logic-when-thread-not-loaded

Revert unnecessary change

b08e4aa

wildan-m marked this pull request as ready for review June 25, 2024 04:03

wildan-m requested a review from a team as a code owner June 25, 2024 04:03

melvin-bot bot removed the request for review from a team June 25, 2024 04:03

melvin-bot bot requested a review from Pujan92 June 25, 2024 04:03

wildan-m mentioned this pull request Jun 25, 2024

[HOLD for payment 2024-07-10] [$500] [One expense reports] The expense details are shown at the top, and then a report preview in the comments #43034

Closed

6 tasks

wildan-m added 2 commits June 26, 2024 04:22

Merge branch 'main' of https://github.com/wildan-m/App into wildan/fi…

e07a41f

…x/43034-keep-filtering-logic-when-thread-not-loaded

Use transactionThreadReportID instead of recounting IOU

fac07ed

missing dependency

8fc1831

Pujan92 suggested changes Jun 26, 2024

View reviewed changes

wildan-m and others added 4 commits June 26, 2024 11:04

Update src/pages/home/report/ReportActionsView.tsx

778b3e3

Co-authored-by: Pujan Shah <shahpujan1992@gmail.com>

Update src/libs/ReportActionsUtils.ts

b316c2a

Co-authored-by: Pujan Shah <shahpujan1992@gmail.com>

Add transactionThreadReportID to getCombinedReportActions

8381d0b

change transactionThreadReportID to mandatory

9a247c3

Pujan92 reviewed Jun 26, 2024

View reviewed changes

remove reportID in ReportActionViews' getCombinedReportActions

23507b9

wildan-m added 2 commits June 26, 2024 14:02

remove unnecessary dependency

8a89228

remove unnecessarcy check

6778162

Pujan92 approved these changes Jun 26, 2024

View reviewed changes

melvin-bot bot requested a review from deetergp June 26, 2024 10:11

deetergp approved these changes Jun 26, 2024

View reviewed changes

deetergp merged commit d53df45 into Expensify:main Jun 26, 2024

github-actions bot mentioned this pull request Jun 27, 2024

Deploy Checklist: New Expensify 2024-06-27 #44575

Closed

85 tasks

	() => ReportActionsUtils.getCombinedReportActions(allReportActions, transactionThreadReportID ?? null, transactionThreadReportActions, reportID),
	() => ReportActionsUtils.getCombinedReportActions(allReportActions, transactionThreadReportID ?? null, transactionThreadReportActions),

	if (isEmptyObject(transactionThreadReportActions) && _.isEmpty(transactionThreadReportID)) {
	if (_.isEmpty(transactionThreadReportID)) {

Conversation

wildan-m commented Jun 25, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Jun 25, 2024

Uh oh!

Pujan92 commented Jun 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

Pujan92 commented Jun 25, 2024

Uh oh!

wildan-m commented Jun 25, 2024

Uh oh!

wildan-m commented Jun 25, 2024

Uh oh!

Pujan92 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Pujan92 Jun 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Pujan92 Jun 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Pujan92 left a comment

Choose a reason for hiding this comment

Uh oh!

Pujan92 commented Jun 26, 2024

Uh oh!

deetergp left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Jun 26, 2024

Uh oh!

OSBotify commented Jul 3, 2024

Uh oh!

OSBotify commented Jul 10, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Pujan92 commented Jun 25, 2024 •

edited

Loading

Pujan92 Jun 26, 2024 •

edited

Loading

Pujan92 Jun 26, 2024 •

edited

Loading