Optimistic report previews #21578

cristipaval · 2023-06-26T15:18:44Z

Details

Fixed Issues

$ #19119

Tests

Have userA as an admin of the workspaceA
Have userB as a member of the workspaceA
userB is offline and sends money in the DM chat with userA. The report preview should be optimistically created in the chat
userB is offline and requests money in the DM chat with userA. The report preview should be optimistically created in the chat
userB is offline and requests money in the workspace chat. The report preview should be optimistically created in the chat
userB is now online. userA can see all transactions from above in their account
userA is offline and pays the money request from the DM chat with userB. The report preview should be optimistically updated in the chat
userA is offline and pays the money request from the workspace chat with userB. The report preview should be optimistically updated in the chat

Verify that no errors appear in the JS console

Offline tests

Included above

QA Steps

Same as tests.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Request/Send money flows

wev.-.request.and.send.mov

Pay money request flow

web.-.pay.mov

Mobile Web - Chrome

Request/Send money flows

chrome.mobile.-.send.and.request.mov

Pay money request flow

chrome.mobile.-.pay.mov

Mobile Web - Safari

Request/Send money flows

safari.mobile.-.send.and.request.mov

Pay money request flow

safari.mobile.-.pay.mov

Desktop

Request/Send money flows

desktop.-.send.and.request.mov

Pay money request flow

desktop.-.pay.mov

iOS

Request/Send money flows

ios.-.request.and.send.mov

Pay money request flow

ios.-.pay.mov

Android

Request/Send money flows

android.-.send.and.request.mov

Pay money request flow

android.-.pay.mov

…ort-preview

…ting iou report.

…ort-preview

cristipaval · 2023-06-27T20:42:50Z

Work is ready. Just have to add the tests and do the screen recordings. Will do this tomorrow.

melvin-bot · 2023-06-28T18:54:44Z

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

src/libs/ReportUtils.js

luacmartins · 2023-06-29T16:41:16Z

src/libs/ReportUtils.js

+        iouReport.hasOutstandingIOU && !justPaidOutstandingIOU
+            ? Localize.translateLocal('iou.payerOwesAmount', {payer: payerName, amount: reportAmount})
+            : Localize.translateLocal('iou.payerSettled', {amount: reportAmount});


Can we use ReportUtils.isSettled?

luacmartins · 2023-06-29T16:44:25Z

src/libs/actions/IOU.js

+    let reportPreviewAction = ReportActionsUtils.getReportPreviewAction(chatReport.reportID, iouReport.reportID);
+    const isNewReportPreviewAction = Boolean(!reportPreviewAction);
+    reportPreviewAction = ReportUtils.buildOptimisticReportPreview(chatReport, iouReport, reportPreviewAction);


This looks odd and will likely introduce a bug when you try to rollback data, since you no longer have the original created date anymore. As in my first comment, I think we should build an optimistic action only if we don't have an existing one.

src/libs/actions/IOU.js

luacmartins · 2023-06-29T16:51:33Z

src/libs/actions/IOU.js

+                key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${chatReport.reportID}`,
+                value: {
+                    [reportPreviewAction.reportActionID]: {
+                        created: reportPreviewAction.created,


I think this might not be right since we are overriding the old preview action with a new one in line 389.

parasharrajat · 2023-06-30T19:25:54Z

Nice, a lot of legit change requests above.

Co-authored-by: Carlos Martins <cmartins@expensify.com>

…ort-preview

parasharrajat · 2023-07-07T15:55:02Z

Bump @cristipaval ⬆️ . Please resolve the conflicts as well. As soon as the query is resolved, I will finish the checklist and we can merge the PR.

…ort-preview

parasharrajat · 2023-07-10T16:44:13Z

Thanks for the changes. It is on my review list and I will finish it off asap.

parasharrajat · 2023-07-10T23:00:00Z

Noticed a UI bug. There is no proper gap between the username and the request Preview.

Also, the hover background of the whole message has the same color as the request preview background which hides the preview when the message is hovered.

parasharrajat · 2023-07-10T23:01:39Z

But I think those are not in the scope if this. We are not touching UI here. Let me know if I am wrong about it.

parasharrajat · 2023-07-10T23:04:00Z

Lol! There is no send money option in DM for me.

parasharrajat · 2023-07-10T23:05:39Z

Ok, we disabled Send flow 2 weeks back.

App/src/libs/Permissions.js

Lines 45 to 52 in b053cc9

    
           /** 
        
            * IOU Send feature is temporarily disabled. 
        
            * 
        
            * @returns {Boolean} 
        
            */ 
        
           function canUseIOUSend() { 
        
               return false; 
        
           }

luacmartins · 2023-07-10T23:07:49Z

@parasharrajat we temporarily disabled the Send money option across the App. As for the other UI issues, they most likely came from this PR as this is reproducible on main.

parasharrajat · 2023-07-10T23:10:34Z

Ok. Thanks. Going to report those on Slack and finishing up the checklist.

parasharrajat · 2023-07-10T23:10:39Z

Screenshots

🔲 iOS / native

Screen.Recording.2023-07-11.at.5.25.45.AM.mov

🔲 iOS / Safari

Screen.Recording.2023-07-11.at.4.42.35.AM.mov

🔲 MacOS / Desktop

Screen.Recording.2023-07-11.at.4.38.26.AM.mov

🔲 MacOS / Chrome

Screen.Recording.2023-07-11.at.4.26.14.AM.mov

🔲 Android / Chrome

Screen.Recording.2023-07-11.at.5.21.53.AM.mov

🔲 Android / native

Screen.Recording.2023-07-11.at.5.11.33.AM.mov

parasharrajat

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.

🎀 👀 🎀 C+ reviewed

parasharrajat · 2023-07-11T08:50:56Z

Let's merge this @Julesssss. Scott was assignment accidentally but two of the Eniggners already approved this.

Julesssss · 2023-07-11T09:15:53Z

Sounds good. We've had thorough reviews here.

OSBotify · 2023-07-11T09:20: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.

OSBotify · 2023-07-13T02:00:51Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.3.40-0 🚀

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

OSBotify · 2023-07-14T14:45:47Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.40-5 🚀

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

rushatgabhane · 2023-10-16T06:08:23Z

src/libs/actions/IOU.js

-        reportPreviewAction = ReportUtils.buildOptimisticReportPreview(chatReport.reportID, iouReport.reportID);
+    if (reportPreviewAction) {
+        reportPreviewAction.created = DateUtils.getDBTime();
+        const message = ReportUtils.getReportPreviewMessage(iouReport, reportPreviewAction);


Hi we missed an edge case - 1:1 DM disappears after opening IOU report page when Scan IOU is created offline

More details here

cristipaval added 5 commits June 22, 2023 00:10

Optimistic report preview when sending money.

b70230f

Merge remote-tracking branch 'origin/main' into cristi_optimistic-rep…

623b8a1

…ort-preview

Improve optimistic report preview when requesting money.

7b177a5

Optimistically update report preview when requesting money in an exis…

1685f56

…ting iou report.

Optimistic report preview when pying money requests

62d0420

cristipaval self-assigned this Jun 26, 2023

cristipaval mentioned this pull request Jun 27, 2023

[$1000] Web - Send money - Replies are not displayed on send money message #20099

Closed

6 tasks

cristipaval added 3 commits June 27, 2023 23:06

Merge remote-tracking branch 'origin/main' into cristi_optimistic-rep…

aa3a4b0

…ort-preview

Fix optimistic report preview when sending money.

723a5d6

Fix optimistic report preview when paying money request

50ddd45

cristipaval mentioned this pull request Jun 28, 2023

[HOLD 19119][$1000] Offline - Infinite loading in case of Send a money to the user you have never chatted before #19318

Closed

6 tasks

cristipaval added 2 commits June 28, 2023 15:06

Fix lint.

f5e4f02

run prettier

279732d

cristipaval requested review from Julesssss, luacmartins and mountiny June 28, 2023 18:00

cristipaval marked this pull request as ready for review June 28, 2023 18:54

cristipaval requested a review from a team as a code owner June 28, 2023 18:54

melvin-bot bot requested review from parasharrajat and removed request for a team June 28, 2023 18:54

Julesssss reviewed Jun 29, 2023

View reviewed changes

src/libs/ReportUtils.js Outdated Show resolved Hide resolved

luacmartins requested changes Jun 29, 2023

View reviewed changes

cristipaval and others added 5 commits June 30, 2023 22:53

Update src/libs/ReportUtils.js

769b91b

Co-authored-by: Carlos Martins <cmartins@expensify.com>

Merge remote-tracking branch 'origin/main' into cristi_optimistic-rep…

f3631c1

…ort-preview

Reuse logic to build report preview message.

b4a361e

Merge remote-tracking branch 'origin/main' into cristi_optimistic-rep…

1679480

…ort-preview

Remove unecessary param

daf707f

Merge remote-tracking branch 'origin/main' into cristi_optimistic-rep…

201f426

…ort-preview

cristipaval dismissed stale reviews from mountiny and luacmartins via 201f426 July 8, 2023 17:12

Always update successData

c379a5c

luacmartins approved these changes Jul 10, 2023

View reviewed changes

parasharrajat approved these changes Jul 10, 2023

View reviewed changes

melvin-bot bot requested a review from deetergp July 10, 2023 23:58

Julesssss approved these changes Jul 11, 2023

View reviewed changes

Expensify deleted a comment from melvin-bot bot Jul 11, 2023

Julesssss merged commit 38890e2 into main Jul 11, 2023

Julesssss deleted the cristi_optimistic-report-preview branch July 11, 2023 09:16

cristipaval mentioned this pull request Jul 11, 2023

Reusable function instead of repetitive statements #22649

Merged

58 tasks

OSBotify mentioned this pull request Jul 13, 2023

Deploy Checklist: New Expensify 2023-07-13 #22783

Closed

53 tasks

melvin-bot bot mentioned this pull request Jul 14, 2023

[HOLD for payment 2023-07-21] Report preview action is not added optimistically when sending money #19119

Closed

rushatgabhane reviewed Oct 16, 2023

View reviewed changes

rushatgabhane mentioned this pull request Oct 16, 2023

[HOLD for payment 2023-09-21] [$1000] Scan IOU - 1:1 DM disappears after opening IOU report page when Scan IOU is created offline #25770

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Optimistic report previews #21578

Optimistic report previews #21578

cristipaval commented Jun 26, 2023 •

edited

Loading

cristipaval commented Jun 27, 2023

melvin-bot bot commented Jun 28, 2023

luacmartins Jun 29, 2023

luacmartins Jun 29, 2023

luacmartins Jun 29, 2023

parasharrajat commented Jun 30, 2023

parasharrajat commented Jul 7, 2023

parasharrajat commented Jul 10, 2023

parasharrajat commented Jul 10, 2023 •

edited

Loading

parasharrajat commented Jul 10, 2023

parasharrajat commented Jul 10, 2023 •

edited

Loading

parasharrajat commented Jul 10, 2023

luacmartins commented Jul 10, 2023

parasharrajat commented Jul 10, 2023

parasharrajat commented Jul 10, 2023 •

edited

Loading

parasharrajat left a comment

parasharrajat commented Jul 11, 2023

Julesssss commented Jul 11, 2023

OSBotify commented Jul 11, 2023

OSBotify commented Jul 13, 2023

OSBotify commented Jul 14, 2023

rushatgabhane Oct 16, 2023

Optimistic report previews #21578

Optimistic report previews #21578

Conversation

cristipaval commented Jun 26, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

cristipaval commented Jun 27, 2023

melvin-bot bot commented Jun 28, 2023

luacmartins Jun 29, 2023

Choose a reason for hiding this comment

luacmartins Jun 29, 2023

Choose a reason for hiding this comment

luacmartins Jun 29, 2023

Choose a reason for hiding this comment

parasharrajat commented Jun 30, 2023

parasharrajat commented Jul 7, 2023

parasharrajat commented Jul 10, 2023

parasharrajat commented Jul 10, 2023 • edited Loading

parasharrajat commented Jul 10, 2023

parasharrajat commented Jul 10, 2023 • edited Loading

parasharrajat commented Jul 10, 2023

luacmartins commented Jul 10, 2023

parasharrajat commented Jul 10, 2023

parasharrajat commented Jul 10, 2023 • edited Loading

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

parasharrajat commented Jul 11, 2023

Julesssss commented Jul 11, 2023

OSBotify commented Jul 11, 2023

OSBotify commented Jul 13, 2023

OSBotify commented Jul 14, 2023

rushatgabhane Oct 16, 2023

Choose a reason for hiding this comment

cristipaval commented Jun 26, 2023 •

edited

Loading

parasharrajat commented Jul 10, 2023 •

edited

Loading

parasharrajat commented Jul 10, 2023 •

edited

Loading

parasharrajat commented Jul 10, 2023 •

edited

Loading