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

fix: [P2P Distance] Split - Participants amount displayed 0.00 briefly on confirmation screen. #47370

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

Krishna2323
Copy link
Contributor

@Krishna2323 Krishna2323 commented Aug 14, 2024

Details

Fixed Issues

$ #47100
PROPOSAL: #47100 (comment)

Tests

  1. Tap FAB > Split expense > Distance
  2. Tap + > Split expense > Distance
  3. Enter the start and finish viewpoints
  4. Select a few participants and proceed to the confirmation screen
  5. Verify correct participants amounts are displayed without any delay
  • Verify that no errors appear in the JS console

Offline tests

  1. Tap FAB > Split expense > Distance
  2. Tap + > Split expense > Distance
  3. Enter the start and finish viewpoints
  4. Select a few participants and proceed to the confirmation screen
  5. Verify correct participants amounts are displayed without any delay

QA Steps

  1. Tap FAB > Split expense > Distance
  2. Tap + > Split expense > Distance
  3. Enter the start and finish viewpoints
  4. Select a few participants and proceed to the confirmation screen
  5. Verify correct participants amounts are displayed without any delay
  • 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 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 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 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.

Screenshots/Videos

Android: Native
android_native.mp4
Android: mWeb Chrome
android_chrome.mp4
iOS: Native
ios_native.mp4
iOS: mWeb Safari
ios_safari.mp4
MacOS: Chrome / Safari
web_chrome.mp4
MacOS: Desktop
desktop_app.mp4

…y on confirmation screen.

Signed-off-by: krishna2323 <belivethatkg@gmail.com>
@Krishna2323 Krishna2323 requested a review from a team as a code owner August 14, 2024 00:23
Copy link

melvin-bot bot commented Aug 14, 2024

@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 removed the request for review from a team August 14, 2024 00:23
@Krishna2323 Krishna2323 marked this pull request as draft August 14, 2024 00:23
Signed-off-by: krishna2323 <belivethatkg@gmail.com>
Signed-off-by: krishna2323 <belivethatkg@gmail.com>
Signed-off-by: krishna2323 <belivethatkg@gmail.com>
Signed-off-by: krishna2323 <belivethatkg@gmail.com>
@Krishna2323
Copy link
Contributor Author

@parasharrajat, while testing, I found a bug that is not related to our issue. Should we handle it in this PR, or is it better to open a new issue to avoid regressions?

BUG: When we start split a distance request with multiple participants and go back and change the participant to a policy, an error message is shown.The sum of splits must equal the total amount..

STEPS:

  1. Start a split distance request.
  2. Select waypoints and proceed
  3. Select multiple participants (not policy) and proceed
  4. Go back and remove all participants and select a workspace
Monosnap.screencast.2024-08-18.16-15-06.mp4

@parasharrajat
Copy link
Member

@Krishna2323 Is this issue happening on staging?

@Krishna2323
Copy link
Contributor Author

@Krishna2323 Is this issue happening on staging?

Yes, I can reproduce on latest main without any changes.

Signed-off-by: krishna2323 <belivethatkg@gmail.com>
@parasharrajat
Copy link
Member

I see. So let's not solve it here.

@parasharrajat
Copy link
Member

We can discuss this on the issue and ask to create a new PR for this.

@Krishna2323
Copy link
Contributor Author

@parasharrajat, do we need to update anything here?

@Krishna2323
Copy link
Contributor Author

@parasharrajat, friendly bump.

@parasharrajat
Copy link
Member

@Krishna2323 I am currently in a priority task. I will take a look as soon as possible.

@parasharrajat
Copy link
Member

@Krishna2323 Thanks for waiting. my availability was low last week. I will for sure review this tomorrow.

@parasharrajat
Copy link
Member

@Krishna2323 Could you please merge main?

@Krishna2323
Copy link
Contributor Author

Merged main.

@Krishna2323
Copy link
Contributor Author

@parasharrajat bump.

Comment on lines +122 to +151
// Sets `amount` and `split` share data before moving to the next step to avoid briefly showing `0.00` as the split share for participants
const setDistanceRequestData = useCallback(
(isPolicyExpenseChat: boolean) => {
// Get policy report based on transaction participants
const policyReport = transaction?.participants?.[0] ? ReportUtils.getReport(selectedReportID.current) : report;

const policyID = IOU.getIOURequestPolicyID(transaction, policyReport);
const policy = PolicyUtils.getPolicy(report?.policyID ?? policyID);
const policyCurrency = policy?.outputCurrency ?? PolicyUtils.getPersonalPolicy()?.outputCurrency ?? CONST.CURRENCY.USD;

const customUnitRateID = TransactionUtils.getRateID(transaction) ?? '-1';
const mileageRates = DistanceRequestUtils.getMileageRates(policy);
const defaultMileageRate = DistanceRequestUtils.getDefaultMileageRate(policy);
const mileageRate: MileageRate = TransactionUtils.isCustomUnitRateIDForP2P(transaction)
? DistanceRequestUtils.getRateForP2P(policyCurrency)
: mileageRates?.[customUnitRateID] ?? defaultMileageRate;

const {unit, rate} = mileageRate ?? {};
const distance = TransactionUtils.getDistanceInMeters(transaction, unit);
const currency = mileageRate?.currency ?? policyCurrency;
const amount = DistanceRequestUtils.getDistanceRequestAmount(distance, unit ?? CONST.CUSTOM_UNITS.DISTANCE_UNIT_MILES, rate ?? 0);
IOU.setMoneyRequestAmount(transactionID, amount, currency);

const participantAccountIDs: number[] | undefined = transaction?.participants?.map((participant) => participant.accountID ?? -1);
if (isSplitRequest && amount && currency && !isPolicyExpenseChat) {
IOU.setSplitShares(transaction, amount, currency ?? '', participantAccountIDs ?? []);
}
},
[report, transaction, transactionID, isSplitRequest],
);
Copy link
Member

@parasharrajat parasharrajat Sep 7, 2024

Choose a reason for hiding this comment

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

Don't we have to remove the similar logic from IOURequestStepConfirmation page after we added it here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@parasharrajat, yeah you are right. I was looking at the wrong code and thought that it should be there to avoid regressions but we have a similar logic which only runs once when the IOURequestStepConfirmation mounts.

I have removed the code on IOURequestStepConfirmation page, please check and let me know. Thanks

Comment on lines 346 to 363
const isFirstUpdatedDistanceAmount = useRef(false);

useEffect(() => {
if (isFirstUpdatedDistanceAmount.current) {
return;
}
if (!isDistanceRequest) {
return;
}
const amount = DistanceRequestUtils.getDistanceRequestAmount(distance, unit ?? CONST.CUSTOM_UNITS.DISTANCE_UNIT_MILES, rate ?? 0);
IOU.setMoneyRequestAmount(transactionID, amount, currency ?? '');
isFirstUpdatedDistanceAmount.current = true;
}, [distance, rate, unit, transactionID, currency, isDistanceRequest]);

Copy link
Member

Choose a reason for hiding this comment

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

May be we should keep it in case someone directly accesses the page via URL. I am not too sure on this. What do you think @Krishna2323

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@parasharrajat, I have re-added that, I think we should keep that because incase if the user start a split req from group report, the participant step will be skipped and the amount will be not updated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@parasharrajat, friendly bump.

@parasharrajat
Copy link
Member

@Krishna2323 I need some help testing this PR. Could you point out the a few different flow that you think might be affected from this change.

@Krishna2323
Copy link
Contributor Author

@parasharrajat, I need some time to check if we need this PR or not because the flow has been changed, now you can't directly split from FAB. I will update very soon.

@parasharrajat
Copy link
Member

Sure...man.

@Krishna2323
Copy link
Contributor Author

@parasharrajat, the flow has been changed but the issue will still occur because initially the amount is 0, I'm thinking to make the same changes in IOURequestStepDistance. WDYT?

Monosnap.screencast.2024-09-25.05-16-35.mp4

@parasharrajat
Copy link
Member

When you say flow has been changed, what do you mean by that?

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.

2 participants