Display report preview using new reportAction data source #18423

cristipaval · 2023-05-04T17:34:32Z

Details

Deprecates the old usages of IOUPreview, and introduces the new ReportPreview component. We show this beneath IOUPreviews, and its position changes so that it's always beneath the most recent preview.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/278890

Tests

Note: Please test with new users, as stale data will likely cause bugs

1) Test report creation and new component

Create a new 1:1 chat between userA and userB
Create a Request of any amount from userA to userB
In the ChatReport, both users should see 'UserB owes £1.23' beneath the IOUPreview
A new IOUReport should be created to hold the request, it should appear in the LHN
Within this report, the recipient should see a 'Pay' button beneath the 'User owes...' message

Additional Requests, and descriptions

Back in the chat report, create another request from userA to userB, this time with a description
The new IOUPreview should include the description
The 'owes £1.23' message should only display beneath the most recent IOUPreview only
When userB taps the payButton, it should take them to the IOUDetailsPage

Test settling up

UserB should settle the IOU (use Settled elsewhere as you won't have a bank set up for this new user)
Within the IOUreport, both users should see a 'settled up $153.84 elsewhere' message
The pay button should disappear from the 'Settled up'
Within the ChatReport, the settled up message should show a chevron
When tapped, it should take you back to the IOUReport

Offline tests

Run above test, coming online to send and receive the rerquest/settle updates. We will likely handle any issues here as follow-up issues

QA Steps

Run above tests

PR Author Checklist

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

…-preview

# Conflicts: # src/libs/ReportActionsUtils.js # src/pages/home/report/ReportActionItem.js

No

Gonals · 2023-05-17T10:22:28Z

Note: Please test with new users, as stale data will likely cause bugs

What are we going to do with existing stale data?

Julesssss · 2023-05-17T10:25:55Z

What are we going to do with existing stale data?

We have a BulkCQ ready to go: https://github.com/Expensify/Expensify/issues/282420

Julesssss

Approving @luacmartins's changes

Julesssss

Approving @luacmartins's changes

mountiny · 2023-05-17T10:36:14Z

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 / Chrome
- iOS / native
- iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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(themeColors.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 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

Mobile Web - Chrome

My android chrome is stuck for last couple of days I need to figure out how to clear the stale data there

Mobile Web - Safari

Desktop

iOS

test+preview@test.com

Android

Gonals

This tests pretty well! Besides the chaos that is the LHN, with all the threads, I like it!

s77rt · 2023-05-17T10:52:55Z

@cristipaval Is the testing steps outdated or this is a bug? The IOUPreview is not shown in chat report it's only shown in iou report.

mountiny

Great job everyone, tests well

mountiny · 2023-05-17T11:00:24Z

@s77rt the IOU preview should be only in the IOU report.

The report preview will be in the chat

s77rt · 2023-05-17T11:04:52Z

Can we hold merge for about 1h? I will take a quick look in the code 😁

Julesssss · 2023-05-17T11:21:05Z

Can we hold merge for about 1h? I will take a quick look in the code 😁

@s77rt we're probably going to merge as it's super critical. But please still review, we can create new issues for any follow ups

Display report preview using new reportAction data source (cherry picked from commit 8d650c6)

…-18423 🍒 Cherry pick PR #18423 to staging 🍒

s77rt

Overall code looks code. I have just few minor notes.

s77rt · 2023-05-17T11:14:27Z

src/components/ReportActionItem/ReportPreview.js

Minor: We have an unnecessary mt4

s77rt · 2023-05-17T11:22:22Z

src/libs/actions/IOU.js

+            value: {
+                ...(isNewChatReport ? {[chatCreatedAction.reportActionID]: chatCreatedAction} : {}),
+                [reportPreviewAction.reportActionID]: {
+                    ...(isNewReportPreviewAction ? reportPreviewAction : {created: DateUtils.getDBTime()}),


Hmm, I'm not sure about this. Does it align with the deign docs? We are updating the created value of the action. Can we update another timestamp field?

s77rt · 2023-05-17T11:26:11Z

src/libs/actions/IOU.js

+                [reportPreviewAction.reportActionID]: {
+                    created: reportPreviewAction.created,
+                },


This should be wrapped in a condition if !isNewReportPreviewAction.

s77rt · 2023-05-17T11:33:00Z

src/libs/ReportUtils.js

@@ -1427,6 +1427,29 @@ function buildOptimisticIOUReportAction(type, amount, currency, comment, partici
    };
 }

+function buildOptimisticReportPreview(reportID, iouReportID, payeeAccountID) {


Missing jsdoc. (Why lint is not failing here?)

OSBotify · 2023-05-17T12:50:22Z

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 1.3.15-1 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2023-05-18T06:50:38Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.15-12 🚀

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

OSBotify · 2023-06-15T01:29:21Z

🚀 Cherry-picked to staging by https://github.com/AndrewGable in version: 1.3.28-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2023-06-16T18:47:10Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀

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

burczu · 2023-11-14T12:14:08Z

src/libs/actions/IOU.js

+                      }
+                    : {}),
+                [reportPreviewAction.reportActionID]: {
+                    created: reportPreviewAction.created,


It looks like this caused a regression fixed in this issue: #29954 - the errors property was missing.

cristipaval added 18 commits April 28, 2023 13:23

New report action type in CONST file.

15cf4c5

Create ReportPreview component.

972480e

Utility method to get report preview action.

7b86c61

Utility function which builds optimistic report preview.

ff09d17

Add report preview in optimistic and success data

fb94299

WIP.

4f72a9f

Connect to Onyx in ReportActionsUtils to get the current user email.

8b463a0

Improve message property in optimistic report preview action.

87f0c6b

Build the preview component starting from IOUAction

650389d

Remove the iou preview.

4615b3f

Remove unnecessary props and logic. from the component.

e36b159

Remove unused default props.

3ff969b

Pull iou report from onyx to get the cached iou total

538eb6e

No more IOUQUote reusability in ReportPreview

bc63580

Hardcode translations.

dd26649

Add reportPreviewReportActionID as a param to RequestMoney command

031ffbf

Merge remote-tracking branch 'origin/main' into cristi_display-report…

c75e249

…-preview

Merge remote-tracking branch 'origin/main' into cristi_display-report…

5b053f4

…-preview

cristipaval self-assigned this May 4, 2023

cristipaval changed the title ~~Cristi display report preview~~ Display report preview May 4, 2023

cristipaval and others added 8 commits May 5, 2023 00:02

Improvements.

595cb41

Pay button.

a77f5c6

Add logic for report preview action for split the bill

8ba163e

wip

9387a58

Merge remote-tracking branch 'origin/main' into cristi_display-report…

3582868

…-preview

Merge remote-tracking branch 'origin/main' into cristi_display-report…

372074b

…-preview

Merge branch 'main' into cristi_display-report-preview

d618723

# Conflicts: # src/libs/ReportActionsUtils.js # src/pages/home/report/ReportActionItem.js

apply lint fixes

62ab68f

Julesssss self-assigned this May 11, 2023

Julesssss changed the title ~~Display report preview~~ [DO NOT MERGE] Display report preview May 11, 2023

remove duplicate description field, added in merge conflict resolution

1330745

Gonals self-requested a review May 17, 2023 10:21

Julesssss approved these changes May 17, 2023

View reviewed changes

Gonals approved these changes May 17, 2023

View reviewed changes

mountiny approved these changes May 17, 2023

View reviewed changes

mountiny merged commit 8d650c6 into main May 17, 2023

mountiny deleted the cristi_display-report-preview branch May 17, 2023 11:24

OSBotify mentioned this pull request May 17, 2023

🍒 Cherry pick PR #18423 to staging 🍒 #19112

Merged

OSBotify pushed a commit that referenced this pull request May 17, 2023

Merge pull request #18423 from Expensify/cristi_display-report-preview

71fea06

Display report preview using new reportAction data source (cherry picked from commit 8d650c6)

OSBotify added a commit that referenced this pull request May 17, 2023

Merge pull request #19112 from Expensify/OSBotify-cherry-pick-staging…

ecb06d7

…-18423 🍒 Cherry pick PR #18423 to staging 🍒

OSBotify mentioned this pull request May 17, 2023

Deploy Checklist: New Expensify 2023-05-16 #19088

Closed

71 tasks

s77rt reviewed May 17, 2023

View reviewed changes

tienifr mentioned this pull request May 17, 2023

[$1000] Chat - Request Money is not visible for participant #19018

Closed

6 tasks

OSBotify mentioned this pull request May 18, 2023

Deploy Checklist: New Expensify 2023-05-18 #19175

Closed

39 tasks

OSBotify mentioned this pull request Jun 15, 2023

Deploy Checklist: New Expensify 2023-06-14 #20782

Closed

burczu reviewed Nov 14, 2023

View reviewed changes

burczu mentioned this pull request Nov 14, 2023

[C+ checklist requires completion] [$500] Distance Expense - No red dot in chat (LHN) or expense preview when invalid waypoints are used #29954

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Display report preview using new reportAction data source #18423

Display report preview using new reportAction data source #18423

cristipaval commented May 4, 2023 •

edited by Julesssss

Loading

Gonals commented May 17, 2023

Julesssss commented May 17, 2023

Julesssss left a comment

Julesssss left a comment

mountiny commented May 17, 2023 •

edited

Loading

Gonals left a comment

s77rt commented May 17, 2023

mountiny left a comment

mountiny commented May 17, 2023

s77rt commented May 17, 2023

Julesssss commented May 17, 2023

s77rt left a comment

s77rt May 17, 2023

s77rt May 17, 2023

s77rt May 17, 2023

s77rt May 17, 2023

OSBotify commented May 17, 2023

OSBotify commented May 18, 2023

OSBotify commented Jun 15, 2023

OSBotify commented Jun 16, 2023

burczu Nov 14, 2023

Display report preview using new reportAction data source #18423

Display report preview using new reportAction data source #18423

Conversation

cristipaval commented May 4, 2023 • edited by Julesssss Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Gonals commented May 17, 2023

Julesssss commented May 17, 2023

Julesssss left a comment

Choose a reason for hiding this comment

Julesssss left a comment

Choose a reason for hiding this comment

mountiny commented May 17, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

Gonals left a comment

Choose a reason for hiding this comment

s77rt commented May 17, 2023

mountiny left a comment

Choose a reason for hiding this comment

mountiny commented May 17, 2023

s77rt commented May 17, 2023

Julesssss commented May 17, 2023

s77rt left a comment

Choose a reason for hiding this comment

s77rt May 17, 2023

Choose a reason for hiding this comment

s77rt May 17, 2023

Choose a reason for hiding this comment

s77rt May 17, 2023

Choose a reason for hiding this comment

s77rt May 17, 2023

Choose a reason for hiding this comment

OSBotify commented May 17, 2023

OSBotify commented May 18, 2023

OSBotify commented Jun 15, 2023

OSBotify commented Jun 16, 2023

burczu Nov 14, 2023

Choose a reason for hiding this comment

cristipaval commented May 4, 2023 •

edited by Julesssss

Loading

mountiny commented May 17, 2023 •

edited

Loading