Enable distance splits by neil-marcellini · Pull Request #42302 · Expensify/App

neil-marcellini · 2024-05-16T14:39:36Z

Details

Enable splitting distance expenses. The goal is to make sure that the feature works for the mainline cases, that it doesn't break existing split flows, and that it's still hidden by the beta. There will be a number of small bugs that already exist on main and probably a few with this new feature. In order to keep things moving, these bugs will be listed and issues will be created to fix them with help from the community before removing the beta.

Fixed Issues

$ #36967
PROPOSAL: N/A

Tests

Known bugs on main:
While testing please take these into consideration and ignore them since they were not caused by this PR.

Chats will show blank and won't load report actions. Sometimes switching chats will fix this.
[$500] [Dev] Infinite receipt loading spinner with backend dev environment #44692
- Now, receipt images don't load at all
Splitting with an existing group chat shortly after sign in fails due to incorrect optimistic 1:1 chat ID, since the existing DM isn't in the allReports cache.
global create allows submit expense P2P distance outside of beta

New bugs to fix later
Maybe new, maybe happen on main

Split with new workspace, error, selected rate has been deleted
Split with existing workspace, multiple previews displayed
receipt image doesn't display in split details (related to other receipt issues on dev)

A. Split distance with new accounts

Sign into an account on the p2pDistanceRequests beta
Click the green plus, Split expense
Choose distance, enter 2 waypoints, click Next
Enter 2 new accounts and select them for the split
Verify that the split on the confirmation page looks good and makes sense, then save it
Verify that a new group chat is created and you are navigated to it
Verify the new split distance expense is displayed with a route receipt image, the type "Distance", an amount, merchant in the correct distance format, the split participant avatars, and the "Your split" text.
Click on the split expense
Verify the split details page opens showing who its paid by, the participants, the route receipt, amount and description.
Click show more
Verify the merchant and date show
Go to a DM with one of the split participants
Verify the split expense shows with the route, " owes:" text, amount, and merchant. Verify the amount is an even split of the total. Verify the distance is also a split of the total and multiplies times the rate to equal the split amount.
Click on it to open the transaction thread
Verify the details there look correct

B. Workspace distance split

Sign into an account on the p2pDistanceRequests beta
Split a distance expense with a workspace
Verify that the split on the confirmation page looks good and makes sense, then save it
Verify the split expense is created in the workspace chat
Verify the new split distance expense is displayed with a route receipt image, the type "Distance", an amount, merchant in the correct distance format, the split participant avatars, and the "Your split" text.
Click on the split expense
Verify the split details page opens showing who its paid by, the participants, the route receipt, amount and description.
Click show more
Verify the merchant and date show

C. Manual split with existing accounts

Split an expense manually
Verify everything looks right

D. Verify splits without the p2pDistanceRequests beta

Sign into an account not on the p2pDistanceRequests beta, or disable the beta in the frontend code
Click green plus, split expense
Verify that only manual and scan appear as options

E. Split with an existing group

Create a group chat
Split a distance expense with them
Verify it's created properly

F. Manual split new accounts

Split an expense manually
Enter emails that haven't signed up yet
Verify everything looks right

Verify that no errors appear in the JS console

Offline tests

Skipping these for now since the existing tests are a lot to run through already. I'm pretty sure it will work well offline, but we can fine tune that while the feature is still under beta and before adding the regression tests for the feature.

QA Steps

Same as tests. If you find any issues please tag me in Slack and make sure they are not labeled as a deploy blocker, unless it's an issue that happens outside of the beta.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

I only tested on web because the changes are platform independent, and C+ will help test all platforms.

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

A

splitA.mp4

B

splitB1080.mov

C

splitC.mov

D

splitD.mov

E

splitE.mp4

F

splitF.mov

MacOS: Desktop

…istic transaction function

neil-marcellini · 2024-08-03T00:17:21Z

Hi @mananjadhav. Sorry for the delay in getting back to this. I just made one small change for clean up, merged main, and now I think it's all working well. Please test again and let me know if you have any problems. Also please include reproduction steps for any bugs you find.

edit-amount-success.mov

distance-split-existing.mov

While I wait for your next review I will re-test the bugs I found in this branch and on main and report them.

mananjadhav · 2024-08-05T14:26:30Z

thanks @neil-marcellini. I'll review and test this again. I'll put in the reproduction steps for future reports but several of these looked unrelated to the PR.

mananjadhav · 2024-08-06T18:04:24Z

Starting on this now.

mananjadhav · 2024-08-06T18:31:18Z

@neil-marcellini We can skip for this one, but offline tests won't work. If we create an offline distance split, we don't have the amount and the splits throw an error: The sum of splits must equal the total amount..

Reproduction Steps:

Sign into an account on the p2pDistanceRequests beta
Go offline.
Click the FAB, Split expense.
Choose distance, enter 2 waypoints, click Next.
Enter 2 new accounts and select them for the split.
Verify whether you're able to add split the amounts.

web-offline-distance-split.mov

mananjadhav · 2024-08-06T18:38:34Z

Just finished testing different scenarios on web and everything else looks good. Highlighted the offline case in the previous comment.

mananjadhav · 2024-08-06T18:58:31Z

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-distance-split.mov

Android: mWeb Chrome

mweb-chrome-distance-split.mov

iOS: Native

ios-distance-split-2.mov

iOS: mWeb Safari

mweb-safari-distance-split.mov

MacOS: Chrome / Safari

Distance Split

web-distance-split_y27cNsyv.mp4

Distance Split Other

web-distance-split-others_GnBaJ7dl.mp4

Offline Split -- doesn't work

web-offline-distance-split.mov

MacOS: Desktop

desktop-distance-split_xRgJMAN8.mp4

melvin-bot · 2024-08-06T19:33:38Z

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

arosiclair

👍

OSBotify · 2024-08-07T13:30:49Z

✋ 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-08-07T22:11:24Z

🚀 Deployed to staging by https://github.com/arosiclair in version: 9.0.18-0 🚀

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

youssef-lr · 2024-08-08T09:40:01Z

Looks like there is a bug where the QAB distance split uses 'SplitBill' endpoint when it should use 'CreateDistanceRequest' #47021.

pecanoro · 2024-08-08T10:24:54Z

This PR also broke TrackExpense on DMs since it started calling the wrong endpoint: #47042 (comment)

OSBotify · 2024-08-12T10:02:38Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.18-10 🚀

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

shubham1206agra · 2024-08-13T12:21:41Z

src/libs/TransactionUtils/index.ts

-        receipt,
-        filename,
+        receipt: receipt?.source ? {source: receipt.source, state: receipt.state ?? CONST.IOU.RECEIPT_STATE.SCANREADY} : {},
+        filename: receipt?.source ?? receipt?.name ?? filename,


We forgot to enforce the filename as a string here which led to crash in iOS. Details #47022

jjcoffee · 2024-08-20T14:43:30Z

src/pages/iou/request/step/IOURequestStepConfirmation.tsx

-
            playSound(SOUNDS.DONE);

+            if (isDistanceRequest && !isMovingTransactionFromTrackExpense) {


Moving this createDistanceRequest call here caused an error in #47042 when tracking a distance expense as we end up calling CreateDistanceRequest here instead of trackExpense.

hoangzinh · 2024-08-27T11:25:02Z

src/libs/actions/IOU.ts

 function getOrCreateOptimisticSplitChatReport(existingSplitChatReportID: string, participants: Participant[], participantAccountIDs: number[], currentUserAccountID: number) {
    // The existing chat report could be passed as reportID or exist on the sole "participant" (in this case a report option)
-    const existingChatReportID = existingSplitChatReportID || participants[0].reportID;
+    const existingChatReportID = existingSplitChatReportID ?? participants[0].reportID ?? '';


Hi team. Coming from this issue #47159. Be careful when change to using "??", because if existingSplitChatReportID is an empty string, it won't fallback to participants[0].reportID. For more details: #47159 (comment)

parasharrajat · 2024-10-28T05:17:31Z

src/components/MoneyRequestConfirmationList.tsx

+        // If it's a split request among individuals, set the split shares
+        const participantAccountIDs: number[] = selectedParticipantsProp.map((participant) => participant.accountID ?? -1);
+        if (isTypeSplit && !isPolicyExpenseChat && amount && transaction?.currency) {
+            IOU.setSplitShares(transaction, amount, currency, participantAccountIDs);


This side-effect does not update the values immediately which creates some delay before real values are shown to the user. #47100

neil-marcellini added 2 commits May 15, 2024 20:20

Allow distance splits on start page

115c045

Set split share when distanceAmount updates

3ee8a7a

neil-marcellini self-assigned this May 16, 2024

neil-marcellini added 12 commits May 16, 2024 08:30

WIP split distance global create set split data

813f8ca

WIP set up CreateDistanceRequestParams for split

cc66e80

Prettier

a9e267c

Carefully fix distance split params

c9a7962

Set onyxData from split or money request data

87010b1

Make distance split navigate for report or global create

d7c5424

Simplify creating distance for split or regular request

8ba2bd1

Make customUnitRateID basically required, fix tsc

4591003

Merge branch 'main' into neil-distance-split

588b2c5

Remove accidentally committed file

336172b

Merge branch 'main' into neil-distance-split

67ffddc

Fix creating workspace distance split and other cleanups

8891513

neil-marcellini mentioned this pull request Jul 1, 2024

[P2P Distance] Update CreateDistanceRequest params in App #36986

Closed

neil-marcellini added 13 commits July 1, 2024 18:36

Merge branch 'main' into neil-distance-split

261d191

Build optimistic receipt for distance split, and move it inside optim…

29a01f3

…istic transaction function

Use existing split chat reportID for distance if present

dc2d0da

Prevent using an existingSplitChatReport with undefined id

a981882

Set optimistic data marking split as a distance transaction

41dec6a

Set waypoints pending so optimistic route shows

1b10e40

Clear pending fields after split

c6909a4

Show optimistic distance route when the request failed

8c61759

Merge branch 'main' into neil-distance-split

1be11ce

Only allow global create distance for non-splits

5188d48

Fix missed replacement of changed variable

ff2f258

Prettify

e2809f4

Remove leftover debug console logs

0c86538

neil-marcellini marked this pull request as ready for review July 10, 2024 16:58

mananjadhav approved these changes Aug 6, 2024

View reviewed changes

melvin-bot bot requested a review from arosiclair August 6, 2024 19:33

arosiclair approved these changes Aug 7, 2024

View reviewed changes

arosiclair merged commit 65bca91 into main Aug 7, 2024

arosiclair deleted the neil-distance-split branch August 7, 2024 13:19

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

Deploy Checklist: New Expensify 2024-08-07 #47006

Closed

88 tasks

This was referenced Aug 8, 2024

[P2P Distance] - Group chat avatar changes after splitting distance expense with existing users #47020

Closed

[HOLD for payment 2024-08-19] [$250] iOS - Distance split - App crashes after opening split distance expense receipt #47022

Closed

pecanoro mentioned this pull request Aug 8, 2024

[HOLD for payment 2024-08-19] [$250] Track expense - App throws error when submitting track distance expense #47042

Closed

6 tasks

lanitochka17 mentioned this pull request Aug 8, 2024

[HOLD for payment 2024-10-25] [$250] [P2P Distance] Split - Participants amount displayed 0.00 briefly on confirmation screen #47100

Closed

6 tasks

marcaaron mentioned this pull request Aug 8, 2024

[HOLD for payment 2024-08-19] [$250] Expense - Receipt thumbnail shows a green receipt placeholder while it is uploading #47050

Closed

6 tasks

This was referenced Aug 12, 2024

[hold for payment 2024-08-26] [$250] Split - Unable to split expense with workspace via FAB #47159

Closed

Deploy Checklist: New Expensify 2024-08-12 #47219

Closed

shubham1206agra reviewed Aug 13, 2024

View reviewed changes

jjcoffee reviewed Aug 20, 2024

View reviewed changes

hoangzinh reviewed Aug 27, 2024

View reviewed changes

parasharrajat reviewed Oct 28, 2024

View reviewed changes

fedirjh mentioned this pull request Apr 2, 2025

[Awaiting checklist] [$250] Expense - Tax details missing in confirmation page and briefly disappear in individual expense #58464

Closed

8 tasks


		playSound(SOUNDS.DONE);

		if (isDistanceRequest && !isMovingTransactionFromTrackExpense) {

Conversation

neil-marcellini commented May 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

neil-marcellini commented Aug 3, 2024

Uh oh!

mananjadhav commented Aug 5, 2024

Uh oh!

mananjadhav commented Aug 6, 2024

Uh oh!

mananjadhav commented Aug 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mananjadhav commented Aug 6, 2024

Uh oh!

mananjadhav commented Aug 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Aug 6, 2024

Uh oh!

arosiclair left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Aug 7, 2024

Uh oh!

OSBotify commented Aug 7, 2024

Uh oh!

youssef-lr commented Aug 8, 2024

Uh oh!

pecanoro commented Aug 8, 2024

Uh oh!

OSBotify commented Aug 12, 2024

Uh oh!

shubham1206agra Aug 13, 2024

Choose a reason for hiding this comment

Uh oh!

jjcoffee Aug 20, 2024

Choose a reason for hiding this comment

Uh oh!

hoangzinh Aug 27, 2024

Choose a reason for hiding this comment

Uh oh!

parasharrajat Oct 28, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

neil-marcellini commented May 16, 2024 •

edited

Loading

mananjadhav commented Aug 6, 2024 •

edited

Loading

mananjadhav commented Aug 6, 2024 •

edited

Loading