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.

Sign up for GitHub

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

Jump to bottom

feat: Edit Distance Rate flow #40021

Merged
merged 26 commits into from
Aug 5, 2024
Merged

feat: Edit Distance Rate flow #40021

merged 26 commits into from
Aug 5, 2024

Conversation

paultsimura
Copy link
Contributor

@paultsimura paultsimura commented Apr 10, 2024 •
edited
Loading

Details

This PR implements the "Edit Rate" functionality for Distance requests.

Fixed Issues

$ #36987
PROPOSAL: #36987 (comment)

Tests

Same as QA

Offline tests

Same as QA

QA Steps

Test 1:

Pre-requisite: have a workspace with multiple Distance Rates;

  1. Create a Distance request to the workspace
  2. Navigate to the request details page
  3. Click the "Rate" field and change the rate
  4. Verify the rate & amount are changed correctly
  5. Verify the "modified expense" action was added

Test 2:

  1. Create a Distance request to self via "track expense"
  2. Navigate to the request details page
  3. Verify the "Rate" field is not clickable

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
2024-07-22.-.13.07.-.android.mp4
Android: mWeb Chrome
2024-07-22.-.12.47.-.chrome.mp4
iOS: Native
2024-07-31.-.11.08.-.Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-07-31.at.11.08.31.mp4
iOS: mWeb Safari
2024-07-22.-.12.47.-.Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-07-22.at.12.30.56.mp4
MacOS: Chrome / Safari
2024-07-22.-.12.47.-.Screen.Recording.2024-07-22.at.12.11.41.mp4
MacOS: Desktop
2024-07-22.-.12.47.-.Screen.Recording.2024-07-22.at.12.22.34.mp4

@paultsimura
Init: Edit Rate flow
a3ea866
@paultsimura
Merge branch 'fork/feat/36985-create-new-rate-field' into feat/36987-…
d514b30 
…rate-edit

# Conflicts:
#	src/pages/iou/request/step/IOURequestStepRate.tsx
@paultsimura
Rate edit: initial commit
967921b
@paultsimura
Merge branch 'main' into feat/36987-rate-edit
2c07b55 
# Conflicts:
#	src/components/MoneyTemporaryForRefactorRequestConfirmationList.tsx
@paultsimura
Merge branch 'fork/feat/36985-create-new-rate-field' into feat/36987-…
ed1f907 
…rate-edit

# Conflicts:
#	src/components/MoneyTemporaryForRefactorRequestConfirmationList.tsx
@paultsimura
Merge branch 'main' into feat/36987-rate-edit
180d885 
# Conflicts:
#	src/libs/Navigation/types.ts
#	src/libs/ReportUtils.ts
#	src/libs/actions/IOU.ts
#	src/pages/iou/request/step/IOURequestStepDistanceRate.tsx
@paultsimura
Merge branch 'main' into feat/36987-rate-edit
1158ffd 
# Conflicts:
#	src/libs/ReportUtils.ts
#	src/libs/TransactionUtils.ts
#	src/libs/actions/IOU.ts
#	src/pages/iou/request/step/IOURequestStepDistanceRate.tsx
#	src/types/onyx/Transaction.ts
@paultsimura paultsimura mentioned this pull request Jul 2, 2024
Closed
@paultsimura

This comment was marked as outdated.

Sign in to view
@paultsimura paultsimura changed the title feat: Edit Rate flow feat: Edit Distance Rate flow Jul 19, 2024
@paultsimura paultsimura force-pushed the feat/36987-rate-edit branch from b99e213 to 14a078f Compare July 20, 2024 12:10
@paultsimura paultsimura force-pushed the feat/36987-rate-edit branch from 14a078f to b7fa71e Compare July 20, 2024 12:21
@paultsimura paultsimura marked this pull request as ready for review July 22, 2024 11:08
@paultsimura paultsimura requested a review from a team as a code owner July 22, 2024 11:08
@melvin-bot melvin-bot bot requested review from mananjadhav and removed request for a team July 22, 2024 11:08
@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented Jul 22, 2024

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

@paultsimura paultsimura mentioned this pull request Jul 22, 2024
Closed
@mananjadhav
Copy link
Collaborator

Catching up on the latest of the issue and the PR. I'll review this by tomorrow.

@paultsimura
Copy link
Contributor Author

Thanks @mananjadhav, please note that the optimistic message differs from the online one a little (e.g. using miles instead of mi), but it's an issue that existed before, and I'll address it within #44582

@mananjadhav
Copy link
Collaborator

I'll finish this today.

mananjadhav
mananjadhav reviewed Jul 30, 2024
View reviewed changes
src/libs/TransactionUtils.ts Outdated
@@ -239,6 +239,11 @@ function getUpdatedTransaction(transaction: Transaction, transactionChanges: Tra
shouldStopSmartscan = true;
}

if (Object.hasOwn(transactionChanges, 'customUnitRateID')) {
updatedTransaction.modifiedCustomUnitRateID = transactionChanges.customUnitRateID;
shouldStopSmartscan = true;
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't have the context for this, and hence asking, this is needed to be true right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, just like updating waypoints or amount manually

@mananjadhav
Copy link
Collaborator

@paultsimura Can you please fix the merge conflicts.

@neil-marcellini Quick bump on this one.

neil-marcellini
neil-marcellini reviewed Aug 1, 2024
View reviewed changes
Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Leaving a partial review for now.

src/pages/iou/request/step/IOURequestStepDistanceRate.tsx Show resolved Hide resolved
src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
neil-marcellini
neil-marcellini requested changes Aug 1, 2024
View reviewed changes
Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Overall looking really good! I'm very impressed. I have a couple important questions so requesting changes for that.

src/pages/iou/request/step/IOURequestStepDistanceRate.tsx Show resolved Hide resolved
src/pages/iou/request/step/IOURequestStepDistanceRate.tsx Show resolved Hide resolved
src/libs/TransactionUtils/index.ts Show resolved Hide resolved
@paultsimura
Merge branch 'refs/heads/main' into feat/36987-rate-edit
ebdbe0e 
# Conflicts:
#	src/components/ReportActionItem/MoneyRequestView.tsx
neil-marcellini
neil-marcellini approved these changes Aug 2, 2024
View reviewed changes
Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Good to go. There are conflicts so hopefully you can also fix the NAB comment related to calculateAmountForUpdatedWaypointOrRate and transactionChanges. Please let me know via DM when it's ready for review again.

neil-marcellini
neil-marcellini requested changes Aug 2, 2024
View reviewed changes
src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
@neil-marcellini neil-marcellini mentioned this pull request Aug 2, 2024
Closed
@paultsimura
Copy link
Contributor Author

@neil-marcellini I've found a potential bug: If I've tracked a distance expense to myself, and then shared it with an accountant, it starts showing the defaultP2PRate: $0.89.

Do you know if this is the correct behavior? Shouldn't it use the workspace rate I'm selecting while sharing it?

2024-08-03.-.14.13.-.Screen.Recording.2024-08-03.at.14.12.49.mp4

@paultsimura
Edit Rate: code cleanup
65a07ff
@paultsimura
Merge branch 'refs/heads/main' into feat/36987-rate-edit
2029ec5 
# Conflicts:
#	src/libs/TransactionUtils/getDistanceInMeters.ts
#	src/libs/TransactionUtils/index.ts
#	src/libs/actions/IOU.ts
paultsimura
paultsimura commented Aug 3, 2024
View reviewed changes
src/CONST.ts
@@ -13,6 +13,7 @@ import type {Unit} from './types/onyx/Policy';
type RateAndUnit = {
unit: Unit;
rate: number;
currency: string;
Copy link
Contributor Author

@paultsimura paultsimura Aug 3, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Added this so the RateAndUnit is more consistent with the MileageRate and we could use the currency from their union type: MileageRate | RateAndUnit.

Copy link
Contributor

Choose a reason for hiding this comment

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

NAB: IMO let's delete this type and just use MileageRate, since RateAndUnit is a subset of it, and the name is not great and now inaccurate. It can be cleaned up in a follow up.

@neil-marcellini
Copy link
Contributor

@neil-marcellini I've found a potential bug: If I've tracked a distance expense to myself, and then shared it with an accountant, it starts showing the defaultP2PRate: $0.89.

Do you know if this is the correct behavior? Shouldn't it use the workspace rate I'm selecting while sharing it?

Yep that seems to be a bug with our existing backend. I think we never implemented the rate updates for this track and share with accountant flow. Please report the bug.

neil-marcellini
neil-marcellini approved these changes Aug 5, 2024
View reviewed changes
Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

I think it's good to go. Thank you!

src/CONST.ts
@@ -13,6 +13,7 @@ import type {Unit} from './types/onyx/Policy';
type RateAndUnit = {
unit: Unit;
rate: number;
currency: string;
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB: IMO let's delete this type and just use MileageRate, since RateAndUnit is a subset of it, and the name is not great and now inaccurate. It can be cleaned up in a follow up.

src/libs/ReportUtils.ts
originalMessage.amount = TransactionUtils.getAmount(updatedTransaction, isFromExpenseReport);
originalMessage.currency = TransactionUtils.getCurrency(updatedTransaction);
originalMessage.merchant = TransactionUtils.getMerchant(updatedTransaction);
const modifiedData = TransactionUtils.calculateAmountForUpdatedWaypointOrRate(oldTransaction, transactionChanges, policy, isFromExpenseReport);
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB: Maybe call this modifiedDistanceFields or something similarly descriptive?

@neil-marcellini neil-marcellini merged commit 8cfeb33 into Expensify:main Aug 5, 2024
9 checks passed
This was referenced Aug 5, 2024
Closed
Closed
Closed
@OSBotify
Copy link
Contributor

OSBotify commented Aug 6, 2024

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.17-0 🚀

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

This was referenced Aug 6, 2024
Closed
Closed
Closed
@BhuvaneshPatil BhuvaneshPatil mentioned this pull request Aug 6, 2024
Closed
6 tasks
@grgia grgia mentioned this pull request Aug 6, 2024
Closed
6 tasks
@marcochavezf marcochavezf mentioned this pull request Aug 6, 2024
Closed
6 tasks
@OSBotify
Copy link
Contributor

OSBotify commented Aug 7, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

2 similar comments
@OSBotify
Copy link
Contributor

OSBotify commented Aug 8, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 8, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

@jjcoffee
Copy link
Contributor

jjcoffee commented Sep 6, 2024

Coming from #46880, we should have added the rate as a pendingAction for the amount field, to support offline updates of the rate greying out the amount field.

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

@neil-marcellini neil-marcellini neil-marcellini approved these changes

@mananjadhav mananjadhav mananjadhav approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@paultsimura @mananjadhav @neil-marcellini @OSBotify @jjcoffee