Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[HOLD] Implement Uneven Splits #40386

Merged
merged 118 commits into from
May 7, 2024
Merged

[HOLD] Implement Uneven Splits #40386

merged 118 commits into from
May 7, 2024

Conversation

youssef-lr
Copy link
Contributor

@youssef-lr youssef-lr commented Apr 17, 2024

Details

Fixed Issues

$ #40616

Tests

  • Verify that no errors appear in the JS console

Creating an uneven split from Global Create

  1. Click on the ‘+’ button.
  2. Choose ‘Split expense’
  3. Enter an amount
  4. Type in a few participants and press ‘split’ on each of them.
  5. Confirm the selection
  6. Click on ‘Amount’ and change it.
  7. Make sure we have adjusted the even shares based on the new amount.
  8. Change the amount of the first participant.
  9. Verify the amounts of the remaining participants have been adjusted and are equal to even splits of the remaining total (total - amount you entered)
  10. Repeat the same step for each participant until the last participant has automatically the remaining correct amount.
  11. Confirm the split.
  12. Verify the money request reports have been created and have the correct amounts.
  13. Click on the Split preview card
  14. Verify the individual amounts are correctly shown next to each participant.

Creating an uneven split from a group chat

  1. Create a group chat with a few participants
  2. Click the ‘+’ button from the group chat and choose ‘Split Bill’
  3. Enter an amount
  4. Change the amount of the participants in the inputs next to each participant.
  5. Confirm the split.
  6. Verify the money request reports have been created and have the correct amounts.
  7. Click on the Split preview card
  8. Verify the correct amounts are shown next to each participant.

Error handling

  1. Click on the ‘+’ button.
  2. Choose ‘Request Money’
  3. Enter an amount
  4. Type in a few participants and press ‘split’ on each of them.
  5. Confirm the selection
  6. Change the amount of the first participant, choose an amount that exceeds the total value of the bill.
  7. Verify an error message is shown that says “You enter but the total is ”
  8. Verify clicking on ‘Split’ does nothing.
  9. Edit the amount so that it’s correct
  10. Verify the error message disappears.
  11. Confirm the split and make sure it gets created properly.

Offline tests

  1. Go offline
  2. Click on the ‘+’ button.
  3. Choose ‘Request Money’
  4. Enter an amount
  5. Type in a few participants and press ‘split’ on each of them and confirm the selection.
  6. Adjust the amounts next to each participant using correct values.
  7. Create the split.
  8. Verify the split is created offline
  9. Verify the preview card shows the correct participants.
  10. Click on the preview to view the split details page.
  11. Verify the page shows the correct amounts next to each participant.
  12. Go back online.
  13. Verify the split action is no longer grayed out
  14. Verify individual chats and money reports have the correct amounts.

QA Steps

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (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
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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 followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • 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
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@youssef-lr youssef-lr self-assigned this Apr 17, 2024
Copy link

melvin-bot bot commented Apr 17, 2024

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@@ -0,0 +1,206 @@
import React, {useCallback, useEffect, useRef, useState} from 'react';
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now I copied and pasted code from MoneyRequestAmountForm, we're working on making the underlying amount input reusable here #40382

Copy link
Contributor

github-actions bot commented May 6, 2024

Copy link
Contributor

@dubielzyk-expensify dubielzyk-expensify left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As for the split stuff this is looking awesome.

I'm still getting the jumpy Next button and Missing translation, but since you've mentioned this isn't related to this PR, I'll go ahead and approve.

Thanks for going through all these details. It was worth it 😄

@dubielzyk-expensify
Copy link
Contributor

dubielzyk-expensify commented May 6, 2024

The "Paid by" appears to be sticky as well now when you scroll, which is not correct

@youssef-lr youssef-lr merged commit 5259776 into main May 7, 2024
17 checks passed
@youssef-lr youssef-lr deleted the youssef_uneven_splits_2 branch May 7, 2024 01:09
@OSBotify
Copy link
Contributor

OSBotify commented May 7, 2024

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@youssef-lr
Copy link
Contributor Author

PR above should fix this issue image

@youssef-lr
Copy link
Contributor Author

QA please don't check this off until the PR above is CP'ed.

@OSBotify
Copy link
Contributor

OSBotify commented May 9, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.71-6 🚀

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

@abdulrahuman5196
Copy link
Contributor

We had minor UI issue from this PR, more information here #41751 (comment)

@@ -616,6 +658,10 @@ function MoneyRequestConfirmationList({
return;
}

if (formError) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We caused a bug. RCA here - #41336 (comment)

@@ -709,14 +757,28 @@ function MoneyRequestConfirmationList({
<FormHelpMessage
style={[styles.ph1, styles.mb2]}
isError
message={formError}
message={!shouldShowReadOnlySplits ? debouncedFormError : formError}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi ✋ Coming from #43184

The check shouldShowReadOnlySplits should be used on the split request, so adding isTypeSplit to avoid the debouncedFormError called on the non-split request.

? IOUUtils.calculateAmount(selectedParticipants.length, iouAmount, iouCurrencyCode ?? '', isPayer)
: transaction.comment.splits.find((split) => split.accountID === participantOption.accountID)?.amount;
}
return {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We did not prevent opening up the profile page for non-existing accounts thereby resulting in #42841

}

setFormError('');
}, [isTypeSplit, transaction?.splitShares, iouAmount, iouCurrencyCode, setFormError, translate]);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, We need to include isFocused and transaction in the dependency array, because we reset the form error whenever the screen gains or loses focus here
This caused this bug: #45199
More info in this proposal: #45199 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.