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

Allow split actions to be edited and implement IOU action completeSplitBill #29064

Merged
merged 68 commits into from
Oct 12, 2023

Conversation

youssef-lr
Copy link
Contributor

@youssef-lr youssef-lr commented Oct 9, 2023

Details

Fixed Issues

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

Tests

  • Verify that no errors appear in the JS console

From Global Create

  1. Start a split bill from Global Create by using the Scan tab and attaching a receipt, choose a new user.
  2. Tap on the split action to reveal the split details page.
  3. Make sure the page is editable.
  4. Enter the amount, date, and merchant, make sure the amount is updated next to the 'Split' button.
  5. Click 'Split', and confirm a report preview displaying the split amount.
  6. Make sure an IOU report has been created, which should contain an expense with the same receipt attached to the original split action.

From Teachers Unite workspace

  1. Sign up as a teacher using https://staging.new.expensify.com/teachersunite
  2. Split a bill from the workspace chat created, and complete using the same test steps as above.
  3. Make sure an expense report is created with half the amount of the total created.

Testing errors

  1. Start a split bill
  2. One the split details page, click on Split without entering the details
  3. Make sure errors appear next to the missing field
  4. Fill in those missing fields one by one, make sure the errors disappear, as well as the form error.
  5. Complete the split bill and make sure child reports are created succesfully.

Offline tests

The same test steps from above, but go offline before completing a split bill, then back online once you click on 'Split'.

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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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 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 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

This was tested thoroughly and evidence can be seen in the comments of this PR as well as in internal Slack channels where videos have been shared

Web
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@youssef-lr youssef-lr changed the title Youssef complete split bill Allow split actions to be edited and implement IOU action completeSplitBill Oct 9, 2023
@youssef-lr youssef-lr changed the base branch from main to youssef_startSplitBill October 9, 2023 04:27
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Oct 9, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 69c0df9
Status: ✅  Deploy successful!
Preview URL: https://c0140b05.helpdot.pages.dev
Branch Preview URL: https://youssef-completesplitbill.helpdot.pages.dev

View logs

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

@youssef-lr lint is not happy

src/libs/TransactionUtils.ts Outdated Show resolved Hide resolved
Base automatically changed from youssef_startSplitBill to main October 10, 2023 16:58
youssef-lr and others added 3 commits October 11, 2023 01:10
Co-authored-by: Vit Horacek <36083550+mountiny@users.noreply.github.com>
@@ -143,7 +143,13 @@ function getUpdatedTransaction(transaction: Transaction, transactionChanges: Tra
updatedTransaction.tag = transactionChanges.tag;
}

if (shouldStopSmartscan && transaction?.receipt && Object.keys(transaction.receipt).length > 0 && transaction?.receipt?.state !== CONST.IOU.RECEIPT_STATE.OPEN) {
if (
shouldUpdateReceiptState &&
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure why this function handles updating a receipt, the function name is getUpdatedTransaction, but seems like the function has a side effect.

@s77rt
Copy link
Contributor

s77rt commented Oct 11, 2023

Strange how the error is The prop transaction.isRequired is marked as required instead of The prop transaction is marked as required.

@s77rt
Copy link
Contributor

s77rt commented Oct 11, 2023

Okay got it. It should be

transaction: transactionPropTypes.isRequired

and not

transaction: PropTypes.shape(transactionPropTypes).isRequired

transactionPropTypes already is a shape. Same fix needed for draftTransaction in SplitBillDetailsPage and EditSplitBillPage

@mountiny mountiny requested a review from s77rt October 11, 2023 23:04
@mountiny
Copy link
Contributor

@s77rt this is ready, can you pleaase complete the checklist so we can get this PR to staging today. Thanks!

mountiny
mountiny previously approved these changes Oct 11, 2023
@s77rt
Copy link
Contributor

s77rt commented Oct 11, 2023

Conflicts

@s77rt
Copy link
Contributor

s77rt commented Oct 11, 2023

@mountiny Can you please fix this prop type for draftTransaction as well

@s77rt
Copy link
Contributor

s77rt commented Oct 12, 2023

Is the mweb bug supposed to be fixed later?

Screenshot 2023-10-12 at 1 03 08 AM

comment: transactionDescription,
merchant: transactionMerchant,
created: transactionCreated,
} = draftTransaction ? ReportUtils.getTransactionDetails(draftTransaction) : ReportUtils.getTransactionDetails(transaction);
Copy link
Contributor

Choose a reason for hiding this comment

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

This will always return true because we add a default {}, no?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will make it undefined in the follow up PR

@luacmartins luacmartins merged commit 828b8b3 into main Oct 12, 2023
15 checks passed
@luacmartins luacmartins deleted the youssef_completeSplitBill branch October 12, 2023 01:06
@luacmartins
Copy link
Contributor

Note: we merged this PR as is and will address the remaining issues as a followup tomorrow @youssef-lr

@OSBotify
Copy link
Contributor

✋ 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

Thanks folks!!!

const {translate, toLocaleDigit} = useLocalize();
const transaction = props.isEditingSplitBill ? props.draftTransaction || props.transaction : props.transaction;
Copy link
Contributor

Choose a reason for hiding this comment

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

@youssef-lr This was not added to the prop type definition for this component.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Working on a follow up PR to clean things up, we wanted this merged quickly so we can test 🙏🏼

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform result
🤖 android 🤖 skipped 🚫
🖥 desktop 🖥 skipped 🚫
🍎 iOS 🍎 skipped 🚫
🕸 web 🕸 skipped 🚫

2 similar comments
@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform result
🤖 android 🤖 skipped 🚫
🖥 desktop 🖥 skipped 🚫
🍎 iOS 🍎 skipped 🚫
🕸 web 🕸 skipped 🚫

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform result
🤖 android 🤖 skipped 🚫
🖥 desktop 🖥 skipped 🚫
🍎 iOS 🍎 skipped 🚫
🕸 web 🕸 skipped 🚫

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

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


const isTypeRequest = props.iouType === CONST.IOU.MONEY_REQUEST_TYPE.REQUEST;
const isSplitBill = props.iouType === CONST.IOU.MONEY_REQUEST_TYPE.SPLIT;
Copy link
Contributor

Choose a reason for hiding this comment

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

Should keep the name consistent and use isTypeSplit.

Comment on lines +88 to +89
defaultAmount={transactionAmount}
reportID={reportID}
Copy link
Contributor

Choose a reason for hiding this comment

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

FYI, this component doesn't use either of these props. I'm going to remove them in my PR and I'll ping you on it.

Comment on lines +670 to +674
error={
shouldDisplayFieldError && (transaction.modifiedMerchant === '' || transaction.modifiedMerchant === CONST.TRANSACTION.PARTIAL_TRANSACTION_MERCHANT)
? translate('common.error.enterMerchant')
: ''
}
Copy link
Contributor

Choose a reason for hiding this comment

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

We should show the merchant error only if the merchant is required i.e. the report is linked to a workspace.

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.

7 participants