Improve creating expenses on Collect with Instant Submit #36388

youssef-lr · 2024-02-13T00:06:10Z

Details

~~Held on https://github.com/Expensify/Auth/pull/9916~~

cc @Beamanator

Fixed Issues

$ #34955

Tests

Verify that no errors appear in the JS console

Create a Collect policy in OldDot, verify it has the autoReportingFrequency set to instant, if it doesn't, run the following in the policy page as the admin: const p = Policy.getCurrent(); p.policy.autoReportingFrequency = 'instant'; p.save();
Invite a member to the workspace [email protected].
Invite another member [email protected] to the workspace, set it as the default approver.
Log in as the submitter in NewDot, and create your first expense report in the workspace chat.
Create another request and make sure it goes to the same report preview.
Click on the report preview to navigate to the expense report.
Click on the '+' and make sure you see Request Money, click on it and make sure the request gets added to the current report.
Approve the report as the approver.
Create another request, and make sure this time it goes to a new report.
Repeat these steps using the Request Money Scan tab, Manual Split, Scan Split, & Distance.

Offline tests

The same steps as above, except, go offline before requesting money, then go back online. Make sure everything looks right as described in the s

QA Steps

Verify that no errors appear in the JS console

Create a Collect policy in OldDot, verify it has the autoReportingFrequency set to instant, if it doesn't, run the following in the policy page as the admin: const p = Policy.getCurrent(); p.policy.autoReportingFrequency = 'instant'; p.save();
Invite a member to the workspace [email protected].
Invite another member [email protected] to the workspace, set it as the default approver.
Log in as the submitter in NewDot, and create your first expense report in the workspace chat.
Create another request and make sure it goes to the same report preview.
Click on the report preview to navigate to the expense report.
Click on the '+' and make sure you see Request Money, click on it and make sure the request gets added to the current report.
Approve the report as the approver.
Create another request, and make sure this time it goes to a new report.
Repeat these steps using the Request Money Scan tab, Manual Split, Scan Split, & Distance.

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-02-23.at.03.06.39.mov

MacOS: Desktop

…t Submit enabled

melvin-bot · 2024-02-13T00:06:15Z

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

…eady

melvin-bot · 2024-02-23T03:10:52Z

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

hoangzinh · 2024-02-23T11:12:56Z

src/libs/actions/IOU.ts

@@ -1728,7 +1735,7 @@ function createSplitsAndOnyxData(
        // For Control policy expense chats, if the report is already approved, create a new expense report
        let oneOnOneIOUReport: OneOnOneIOUReport = oneOnOneChatReport.iouReportID ? allReports?.[`${ONYXKEYS.COLLECTION.REPORT}${oneOnOneChatReport.iouReportID}`] : null;
        const shouldCreateNewOneOnOneIOUReport =
-            !oneOnOneIOUReport || (isOwnPolicyExpenseChat && ReportUtils.isControlPolicyExpenseReport(oneOnOneIOUReport) && ReportUtils.isReportApproved(oneOnOneIOUReport));
+            !oneOnOneIOUReport || (isOwnPolicyExpenseChat && ReportUtils.isPaidGroupPolicy(oneOnOneIOUReport) && ReportUtils.isReportApproved(oneOnOneIOUReport));


Just wanna double check whether we should use ReportUtils.isPaidGroupPolicyExpenseReport instead of ReportUtils.isPaidGroupPolicy here.

Just wanna double check whether we should use ReportUtils.isPaidGroupPolicyExpenseReport instead of ReportUtils.isPaidGroupPolicy here.

It doesn't really matter, both should work fine.

hoangzinh · 2024-02-23T11:23:02Z

src/libs/ReportUtils.ts

@@ -4255,7 +4255,7 @@ function canRequestMoney(report: OnyxEntry<Report>, policy: OnyxEntry<Policy>, o
    if (isMoneyRequestReport(report)) {
        const isOwnExpenseReport = isExpenseReport(report) && isOwnPolicyExpenseChat;
        if (isOwnExpenseReport && PolicyUtils.isPaidGroupPolicy(policy)) {
-            return isDraftExpenseReport(report);
+            return isDraftExpenseReport(report) || (PolicyUtils.isInstantSubmitEnabled(policy) && isProcessingReport(report));


Hi @youssef-lr is there any doc that helps me verify this logic? Or can you help to leave a comment in code to explain it? Thanks

I can add a comment. There is a doc, but I think you might not have access to it.

I think this comment already explains this logic. If Instant Submit is turned on, we can add expenses to an already submitted report. If reporting frequency is set to 'Weekly', then we can only add expenses to draft reports (i.e. not submitted yet).

Thanks for clarifying @youssef-lr .

hoangzinh · 2024-02-24T05:51:03Z

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 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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

Screen.Recording.2024-02-27.at.15.27.22.android.mp4

Android: mWeb Chrome

Screen.Recording.2024-02-27.at.17.05.29.android.chrome.mp4

iOS: Native

Screen.Recording.2024-02-27.at.17.10.25.ios.1.mp4

Screen.Recording.2024-02-27.at.17.12.49.ios.2.mov

iOS: mWeb Safari

Screen.Recording.2024-02-27.at.17.32.42.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2024-02-26.at.23.50.05.web.mp4

Screen.Recording.2024-02-27.at.14.42.59.web.manual.scan.mov

Screen.Recording.2024-02-27.at.14.45.04.web.distance.mp4

MacOS: Desktop

Screen.Recording.2024-02-27.at.15.02.30.desktop.mp4

youssef-lr · 2024-02-27T01:48:36Z

friendly bump @hoangzinh

hoangzinh · 2024-02-27T07:05:29Z

@youssef-lr sure, I'm complete recordings. Will try to complete it within today

youssef-lr · 2024-02-27T07:17:34Z

Thanks!

hoangzinh

LGTM

melvin-bot · 2024-02-27T10:35:54Z

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

melvin-bot · 2024-03-04T12:07:57Z

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

youssef-lr · 2024-03-04T12:10:03Z

Awesome thanks! All yours @Beamanator!

youssef-lr · 2024-03-04T12:12:45Z

Not sure why you got assigned @techievivek, Alex is on this :D

rlinoz · 2024-03-05T15:02:21Z

src/libs/ReportUtils.ts

+ * - report is a draft
+ * - report is a processing expense report and its policy has Instant reporting frequency
+ */
+function canAddTransactionsToMoneyRequest(report: OnyxEntry<Report>): boolean {


NAB: Rename to canAddOrDeleteTransactionFromMoneyRequest or something like that so we don't have to add this comment // If the report supports adding transactions to it, then it also supports deleting transactions from it..

True true, on it

rlinoz · 2024-03-05T15:05:40Z

src/libs/ReportUtils.ts

@@ -2957,11 +2972,11 @@ function buildOptimisticExpenseReport(chatReportID: string, policyID: string, pa
    const formattedTotal = CurrencyUtils.convertToDisplayString(storedTotal, currency);
    const policy = getPolicy(policyID);

-    const isFree = policy?.type === CONST.POLICY.TYPE.FREE;
+    const isInstantSubmitEnabled = PolicyUtils.isInstantSubmitEnabled(policy);

    // Define the state and status of the report based on whether the policy is free or paid


We can remove this comment, or update it to match the new condition.

I think the code is self-explanatory, so we can remove

youssef-lr · 2024-03-07T12:32:40Z

Updated @rlinoz! I think Alex is OOO til Monday. He hasn't requested any changes or anything since his last review except that we need to test, so let's try to get this merged today! 🙏

youssef-lr · 2024-03-07T12:33:28Z

src/libs/ReportUtils.ts

@@ -1285,14 +1285,13 @@ function canDeleteReportAction(reportAction: OnyxEntry<ReportAction>, reportID:
        // For now, users cannot delete split actions
        const isSplitAction = reportAction?.originalMessage?.type === CONST.IOU.REPORT_ACTION_TYPE.SPLIT;

-        if (isSplitAction || isSettled(String(reportAction?.originalMessage?.IOUReportID)) || (!isEmptyObject(report) && isReportApproved(report))) {


I removed this logic as it's already handled in canAddOrDeleteTransactions

rlinoz · 2024-03-07T14:26:17Z

src/libs/ReportUtils.ts

-function canAddTransactionsToMoneyRequest(report: OnyxEntry<Report>): boolean {
-    if (!isIOUReport(report) && !isExpenseReport(report)) {
+function canAddOrDeleteTransactions(moneyRequestReport: OnyxEntry<Report>): boolean {
+    if (!isMoneyRequest(moneyRequestReport)) {


isMoneyRequest only check for IOU reports, and I think this is making the button not show up inside the expense report (step 7 of the tests).

I think you will need to update this to use isMoneyRequestReport as well

Suggested change

if (!isMoneyRequest(moneyRequestReport)) {

if (!isMoneyRequest(moneyRequestReport) && !isMoneyRequestReport(moneyRequestReport)) {

This might fix the failing tests as well

woops just a mistake, will update

if (!isMoneyRequest(moneyRequestReport) && !isMoneyRequestReport(moneyRequestReport))

It should only be isMoneyRequestReport here, because we can't add transactions to a transaction :D

rlinoz · 2024-03-07T15:21:05Z

After approving a report if I go to the submitter account and send a new request I get an error because it tries to add to a report that has already been approved (the FE just doesn't know it):

Will we address this in the backend eventually?

Another option is if we get this specific error we create a new report with the new request.

youssef-lr · 2024-03-07T15:22:16Z

Do you have bwm running?

rlinoz · 2024-03-07T15:22:50Z

I do, it is just a little slow sometimes

youssef-lr · 2024-03-07T15:24:13Z

My guess is you tried to submit when the pusher update marking the report as approved wasn't applied yet. Can you try approving, and waiting a bit until you see it was approved, then submit?

youssef-lr · 2024-03-07T15:27:47Z

Another option is if we get this specific error we create a new report with the new request.

Yeah we could explore this for cases where a pusher update is missed, but in production this scenario rarely happens.

rlinoz · 2024-03-07T15:39:02Z

I think I got it:

With bwm.sh running

[Employee] Send a money request from the workspace chat
[Approver] Approve the request
[Employee] The report is never updated if you don't leave the workspace chat

Screen.Recording.2024-03-07.at.12.34.56.mov

Anyway, it doesn't look related to this changes, so I think we are good here

youssef-lr · 2024-03-07T15:41:56Z

Weird @rlinoz, it gets updated for me in real time:

Screen.Recording.2024-03-07.at.16.41.31.mov

OSBotify · 2024-03-07T15:47:18Z

✋ 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-03-08T00:03:29Z

🚀 Deployed to staging by https://github.com/youssef-lr in version: 1.4.49-0 🚀

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

OSBotify · 2024-03-12T18:37:51Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.50-5 🚀

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

youssef-lr added 2 commits February 13, 2024 00:39

Allow requesting money from processing reports in Collect with Instan…

9bc5b38

…t Submit enabled

Add new expenses to processing reports

34917e5

youssef-lr requested a review from a team as a code owner February 13, 2024 00:06

youssef-lr self-assigned this Feb 13, 2024

melvin-bot bot requested review from hoangzinh and removed request for a team February 13, 2024 00:06

youssef-lr removed the request for review from hoangzinh February 13, 2024 00:06

youssef-lr marked this pull request as draft February 13, 2024 00:06

youssef-lr changed the title ~~Youssef instant submit collect~~ Improve creating expenses on Collect with Instant Submit Feb 13, 2024

youssef-lr added 2 commits February 13, 2024 22:53

Set optimisitc report as submitted if instant submit is turned on

99d1542

Do not create a new report preview if we have a processing report alr…

4fc82e7

…eady

youssef-lr changed the title ~~Improve creating expenses on Collect with Instant Submit~~ [HOLD Auth#9916] Improve creating expenses on Collect with Instant Submit Feb 13, 2024

Merge branch 'main' into youssef_instant_submit_collect

f165755

youssef-lr changed the title ~~[HOLD Auth#9916] Improve creating expenses on Collect with Instant Submit~~ Improve creating expenses on Collect with Instant Submit Feb 22, 2024

youssef-lr added 2 commits February 22, 2024 19:39

Merge branch 'main' into youssef_instant_submit_collect

771eef6

Add support for splitBill

4eb5cbf

youssef-lr marked this pull request as ready for review February 23, 2024 03:06

youssef-lr requested a review from a team February 23, 2024 03:10

melvin-bot bot requested review from hoangzinh and removed request for a team February 23, 2024 03:10

hoangzinh reviewed Feb 23, 2024

View reviewed changes

hoangzinh approved these changes Feb 27, 2024

View reviewed changes

melvin-bot bot requested a review from rlinoz February 27, 2024 10:35

melvin-bot bot requested a review from techievivek March 4, 2024 12:07

youssef-lr removed the request for review from techievivek March 4, 2024 12:12

hoangzinh mentioned this pull request Mar 5, 2024

[HOLD E/E #359760] [$500] No "Hold Request" and "Add a receipt" option on workspace expense report as Admin #36202

Closed

6 tasks

rlinoz reviewed Mar 5, 2024

View reviewed changes

Apply suggestions from code review

ee17782

youssef-lr commented Mar 7, 2024

View reviewed changes

youssef-lr added 3 commits March 7, 2024 13:40

Fix bug, use isMoneyRequestReport

6a464b3

Cleanup

1777c68

Rename variable

9d9caf6

rlinoz requested changes Mar 7, 2024

View reviewed changes

Fix wrong helper method used

3fcd191

rlinoz approved these changes Mar 7, 2024

View reviewed changes

youssef-lr merged commit 9bbe923 into main Mar 7, 2024
16 checks passed

youssef-lr deleted the youssef_instant_submit_collect branch March 7, 2024 15:42

github-actions bot mentioned this pull request Mar 7, 2024

Deploy Checklist: New Expensify 2024-03-07 #37938

Closed

43 tasks

trjExpensify mentioned this pull request Mar 8, 2024

[HOLD for payment 2024-03-18] [HIGH] [Instant Submit] for Collect: Improve creating expenses on Instant Submit paid plans, from NewDot #34955

Closed

	if (!isMoneyRequest(moneyRequestReport)) {
	if (!isMoneyRequest(moneyRequestReport) && !isMoneyRequestReport(moneyRequestReport)) {

Improve creating expenses on Collect with Instant Submit #36388

Improve creating expenses on Collect with Instant Submit #36388

Conversation

youssef-lr commented Feb 13, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 13, 2024

melvin-bot bot commented Feb 23, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

youssef-lr Feb 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hoangzinh commented Feb 24, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

youssef-lr commented Feb 27, 2024

hoangzinh commented Feb 27, 2024

youssef-lr commented Feb 27, 2024

hoangzinh left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Feb 27, 2024

melvin-bot bot commented Mar 4, 2024

youssef-lr commented Mar 4, 2024

youssef-lr commented Mar 4, 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

youssef-lr commented Mar 7, 2024 • edited Loading

Choose a reason for hiding this comment

rlinoz Mar 7, 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

rlinoz commented Mar 7, 2024 • edited Loading

youssef-lr commented Mar 7, 2024

rlinoz commented Mar 7, 2024

youssef-lr commented Mar 7, 2024

youssef-lr commented Mar 7, 2024

rlinoz commented Mar 7, 2024

youssef-lr commented Mar 7, 2024

OSBotify commented Mar 7, 2024

OSBotify commented Mar 8, 2024

OSBotify commented Mar 12, 2024

youssef-lr commented Feb 13, 2024 •

edited

Loading

youssef-lr Feb 23, 2024 •

edited

Loading

hoangzinh commented Feb 24, 2024 •

edited

Loading

youssef-lr commented Mar 7, 2024 •

edited

Loading

rlinoz Mar 7, 2024 •

edited

Loading

rlinoz commented Mar 7, 2024 •

edited

Loading