Skip to content

Detect split request based on the route params - #33482

Merged
youssef-lr merged 37 commits into
Expensify:mainfrom
bernhardoj:fix/32912-split-based-on-route
Feb 28, 2024
Merged

youssef-lr merged 37 commits into
Expensify:mainfrom
bernhardoj:fix/32912-split-based-on-route

Conversation

@bernhardoj

@bernhardoj bernhardoj commented Dec 22, 2023 •

Copy link
Copy Markdown
Contributor

Details

After the money request was refactored, we lost the split request flag. This flag is used to change the title to Split if it's a split request and allow the user to split with 1 participant. In this PR, we update the iouType params everytime we do a split request.

Fixed Issues

$ #32912
PROPOSAL: #32912 (comment)

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

  1. Open the money request page and switch to the manual tab
  2. Enter any amount and press Next
  3. Press "Split" on any user to add them as a split participant
  4. Verify the page title change to Split and the "Add to split" button shows
  5. Press "Add to split"
  6. Verify the confirmation page shows a split confirmation
  7. Go back to the first money request page
  8. Switch to another tab and switch back to manual
  9. Verify the title changes back to Request Money
  10. Enter any amount and press Next again
  11. Verify the title shows Manual
  12. Select any participant directly
  13. Verify the confirmation page shows a request confirmation
  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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.

Screenshots/Videos

Android: Native
Screen.Recording.2023-12-22.at.16.18.36.mov
Android: mWeb Chrome
Screen.Recording.2023-12-22.at.16.13.43.mov
iOS: Native
Screen.Recording.2023-12-22.at.16.12.42.mov
iOS: mWeb Safari
Screen.Recording.2023-12-22.at.16.14.34.mov
MacOS: Chrome / Safari
Screen.Recording.2023-12-22.at.16.10.43.mov
MacOS: Desktop
Screen.Recording.2023-12-22.at.16.11.55.mov

@bernhardoj
bernhardoj requested a review from a team as a code owner December 22, 2023 08:28
@melvin-bot
melvin-bot Bot removed the request for review from a team December 22, 2023 08:28
@melvin-bot

melvin-bot Bot commented Dec 22, 2023

Copy link
Copy Markdown

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

@melvin-bot
melvin-bot Bot requested a review from parasharrajat December 22, 2023 08:28
}
IOU.updateMoneyRequestTypeParams(routes, newIouType.current);
newIouType.current = null;
}, [routes, participants]);

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I decided to update the route params, ONLY after the participant onyx is updated.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Are you safe guarding the case where participants are failed to update in Onyx due to some unexpected reason?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Nope. This is to help reduce the lag where the participant Onyx is late to update, so I want to make sure the participant is updated first. But somehow, this morning I retested it (updating both params and participant at the same time), and the flow works really smoothly and fast.

I don't know exactly what happened with the performance when I worked on the PR, but I think we can keep this.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Let's add a comment explaining the logic purpose.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

// Participants can be added as normal or split participants. We want to wait for the participants' data to be updated before
// updating the money request type route params reducing the amount of work at the same time.

Do you think this is enough?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@parasharrajat looks like we got no answer from the internal team yet, but let's say we are not allowed to do it, I have another alternative.

We will use the useEffect back. Then, how do we fix the case where the selected participants are the same? We can update the params immediately knowing the participants' onyx won't be updated.

image

What do you think?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@parasharrajat So, the conclusion is we are not allowed to do the promise chaining. This left us with the alternate option above

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

That looks feasible to me. let's do it. I wasn't sure of action chaining but had doubts. Thanks for bringing this to Slack, it will help us keep code clear and minimize refactor efforts.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

let's reset the newIouType after calling the updateRouteParams in addparticipant and keep updateRouteParams clean.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done

Comment thread src/pages/iou/request/step/IOURequestStepParticipants.js Outdated
Comment thread src/pages/iou/request/step/IOURequestStepParticipants.js
Comment thread src/pages/iou/request/step/IOURequestStepParticipants.js
@bernhardoj

Copy link
Copy Markdown
Contributor Author

Unit test failing on main too

@parasharrajat

Copy link
Copy Markdown
Member

@bernhardoj Please merge the main when you can. I think those tests are fixed now.

@bernhardoj

Copy link
Copy Markdown
Contributor Author

Done

Comment thread src/libs/actions/IOU.js Outdated
@bernhardoj

Copy link
Copy Markdown
Contributor Author

@parasharrajat I found an issue, please hold

@bernhardoj

Copy link
Copy Markdown
Contributor Author

@parasharrajat In case you missed it, here is the issue that I mean

@parasharrajat

Copy link
Copy Markdown
Member

Thanks for sharing. I was about to ask that.

@bernhardoj

Copy link
Copy Markdown
Contributor Author

to be more consistent with the other request types on the first page.

I actually still don't understand which part is not consistent. Can you explain it more? Maybe we have a different understanding.

Not updating the iouType of the first page will not show the selected participant when visiting the participant page again, which broke the current behavior on prod.

@akinwale

Copy link
Copy Markdown
Contributor

I actually still don't understand which part is not consistent. Can you explain it more? Maybe we have a different understanding.

On the first page of Request money with the tab switcher, whenever we switch to Manual, Scan or Distance, the title remains "Request money" regardless of which tab is active.

Since this is the case for all the tabs, it's more consistent to keep the title as "Request money" before the user moves on to the next page with the participants selector, where the title can change to "Split" for split request, or remain as "Manual" for a regular manual request.

Hope this makes sense.

@akinwale

Copy link
Copy Markdown
Contributor

@bernhardoj For additional context, this is the page I'm referring to. If I return to this page while a split participant is still selected, the title changes to "Split bill", but it should remain "Request money" since the other tabs maintain the same title as well.

Screenshot 2024-02-27 at 12 45 46

@bernhardoj

Copy link
Copy Markdown
Contributor Author

whenever we switch to Manual, Scan or Distance, the title remains "Request money" regardless of which tab is active.

The title is not the tab title, but the start page title.

<HeaderWithBackButton
title={tabTitles[iouType]}
onBackButtonPress={navigateBack}
/>

When you switch tabs, we reset the data (and params), so you see "Request money" again.
https://github.com/Expensify/App/pull/33482/files#diff-9fd7de5c6297b35051f97572bc4cf6e43ce907fb7a7b2e3bc1f7bec03246308fR122-R124

This will happen if we change that behavior.

Screen.Recording.2024-02-27.at.19.56.51.mov

@akinwale

akinwale commented Feb 27, 2024 •

Copy link
Copy Markdown
Contributor

@bernhardoj I see. I realise the tab titles are from the previous flow prior to the money request tabs being added ("Split bill" used to be a separate menu item in the FAB iirc).

One feasible approach would be to set the corresponding start page title for CONST.IOU.TYPE.SPLIT to translate('iou.requestMoney'). I don't think we need to block on this, however.

const tabTitles = {
[CONST.IOU.TYPE.REQUEST]: translate('iou.requestMoney'),
[CONST.IOU.TYPE.SEND]: translate('iou.sendMoney'),
[CONST.IOU.TYPE.SPLIT]: translate('iou.splitBill'),
};

@akinwale

Copy link
Copy Markdown
Contributor

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
33482-android-native.mp4
Android: mWeb Chrome
33482-android-chrome.mp4
iOS: Native
33482-ios-native.mp4
iOS: mWeb Safari
33482-ios-safari.mp4
MacOS: Chrome / Safari
33482-web.mp4
MacOS: Desktop
33482-desktop.mp4

@akinwale akinwale left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM.

@melvin-bot
melvin-bot Bot requested a review from youssef-lr February 27, 2024 12:41
@youssef-lr

Copy link
Copy Markdown
Contributor

BUG: Clicking on 'Split bill' from a room then navigating to Scan opens 'Hmm not found' page, Manual works fine. I can't reproduce in main.

Screen.Recording.2024-02-28.at.04.02.22.mov

@bernhardoj

Copy link
Copy Markdown
Contributor Author

Checking

@bernhardoj

Copy link
Copy Markdown
Contributor Author

Fixed. The problem is we reset the iouType params to REQUEST when switching tabs, but group chat doesn't support REQUEST.

I decided to only reset the iouType when the request is coming from global create (FAB +).

Navigation.navigate(ROUTES.MONEY_REQUEST_STEP_CONFIRMATION.getRoute(nextStepIOUType, transactionID, selectedReportID.current || reportID));
}, [iouType, transactionID, reportID]);
const goToNextStep = useCallback(
(isSplit) => {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is this param really needed? It seems like iouType gets updated from the route once we tab 'split' on a participant. Simply using iouType here seems to work fine. Can you double check pelase?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it would be nice if we removed it, or find a way to make this onFinish(true); less ambiguous, it's not immediately obvious what the boolean is doing there.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Basically this seems to work fine, but I might be missing something

Screenshot 2024-02-28 at 04 49 45

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It's to cover a case where the iouType is not updated yet when goToNextStep is called.

  1. Add a participant to split. At this point, iouType is split
  2. Press the participant. When goToNextStep is called, iouType is still split, but it should be a request.

find a way to make this onFinish(true); less ambiguous,

addParticipant also has isSplit on the param, maybe we can pass the iou type instead of boolean?

const goToNextStep = useCallback(
    (selectedIouType) => {
        const isSplit = selectedIouType === CONST.IOU.TYPE.SPLIT;    

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

  1. Add a participant to split. At this point, iouType is split
  2. Press the participant. When goToNextStep is called, iouType is still split, but it should be a request.

Nice, yeah I knew I was missing something :D.

addParticipant also has isSplit on the param, maybe we can pass the iou type instead of boolean?

Yeah this looks better, thanks!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done

@youssef-lr

Copy link
Copy Markdown
Contributor

Fixed. The problem is we reset the iouType params to REQUEST when switching tabs, but group chat doesn't support REQUEST.

Nice thanks, that fixed it.

@youssef-lr youssef-lr left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the changes!

@youssef-lr
youssef-lr merged commit e5b3eb2 into Expensify:main Feb 28, 2024
@OSBotify

Copy link
Copy Markdown
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.

@github-actions github-actions Bot mentioned this pull request Feb 28, 2024
91 tasks done
@OSBotify

Copy link
Copy Markdown
Contributor

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

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

@Gonals

Gonals commented Feb 29, 2024

Copy link
Copy Markdown
Contributor

This seems to have introduced this issue

It also seems it is not possible to request splits twice from the same user when it is a new user, as the app tries to generate a new chat and it errors out

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.45-6 🚀

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

{({didScreenTransitionEnd}) => (
<MoneyRequestParticipantsSelector
participants={participants}
participants={isSplitRequest ? participants : []}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Mark for reference.

Comment on lines -158 to -162
// When going back to the participants step, if the iou is a "request" (not a split), then the participants need to be cleared from the
// transaction so that the participant can be selected again.
if (iouType === CONST.IOU.TYPE.REQUEST) {
IOU.setMoneyRequestParticipants_temporaryForRefactor(transactionID, []);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Mark for reference.

);

const goToNextStep = useCallback(() => {
const nextStepIOUType = numberOfParticipants.current === 1 ? iouType : CONST.IOU.TYPE.SPLIT;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is only mark for reference (Not for this PR author).

nextStepIOUType will not be relevant now. Please use iouType directly for navigation to confirmation page.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants