Get distance from transaction vs route #40307

neil-marcellini · 2024-04-16T17:53:13Z

Details

The distance is now stored on the transaction as soon as it's fetched with GetRouteForDraft, and after the request is created. Previously the backend did not store the distance on the transaction after GetRouteForDraft, which created a confusing inconsistency about where the source of truth is for distance.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/388212
PROPOSAL: N/A

Tests

Request money and choose distance
Enter start and stop addresses
Verify the distance displays properly
Create the reqest
Verify the distance displays properly

Verify that no errors appear in the JS console

Offline tests

Go offline
Request money and choose distance
Enter start and stop addresses
Create the request
Go online
Verify the distance displays properly

QA Steps

Same as tests

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

I only tested on Mac Chrome because the changes are platform independent.

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-04-30.at.8.16.10.AM.mov

MacOS: Desktop

melvin-bot · 2024-04-30T15:23:57Z

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

neil-marcellini · 2024-04-30T15:24:09Z

No C+ needed for this simple change

melvin-bot · 2024-04-30T15:24:20Z

@rojiphil @ One of you needs to 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]

luacmartins

Are other properties not available in the transaction.comment, e.g. geometry?

src/components/MoneyRequestConfirmationList.tsx

neil-marcellini · 2024-04-30T16:06:32Z

Are other properties not available in the transaction.comment, e.g. geometry?

Yeah and those are fine because we only use them before the expense is created, as opposed to distance.

luacmartins · 2024-04-30T18:04:41Z

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 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 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 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.
I have checked off every checkbox in the PR reviewer 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

OSBotify · 2024-04-30T18:12:49Z

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

OSBotify · 2024-05-01T03:01:31Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.69-0 🚀

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

OSBotify · 2024-05-02T13:05:06Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.69-2 🚀

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

jjcoffee · 2024-05-15T09:30:44Z

src/libs/TransactionUtils.ts

-function getDistance(transaction: Transaction): number {
-    return transaction?.routes?.route0?.distance ?? 0;
+function getDistance(transaction: Transaction | null): number {
+    return transaction?.comment?.customUnit?.quantity ?? 0;


Coming from #41389. With this change we also needed to tweak this

App/src/components/MoneyRequestConfirmationList.tsx

Line 266 in 5f50430

const shouldCalculateDistanceAmount = isDistanceRequest && (iouAmount === 0 || prevRate !== rate);

in order to adjust the quantity whenever there's a modification in the distance. More details here.

neil-marcellini added 2 commits April 16, 2024 10:47

Define the TransactionCustomUnit type

dc229ae

Update how distance is accessed

792cec8

neil-marcellini self-assigned this Apr 16, 2024

neil-marcellini changed the title ~~Get distance from transaction vs route~~ [HOLD Web-E 41685] Get distance from transaction vs route Apr 16, 2024

neil-marcellini changed the title ~~[HOLD Web-E 41685] Get distance from transaction vs route~~ Get distance from transaction vs route Apr 30, 2024

neil-marcellini added 2 commits April 30, 2024 08:06

Merge branch 'main' into neil-TransactionCustomUnit

803dbb7

Fix lint by removing type assertions

9c2f556

neil-marcellini marked this pull request as ready for review April 30, 2024 15:23

neil-marcellini requested a review from a team as a code owner April 30, 2024 15:23

melvin-bot bot requested review from s77rt and removed request for a team April 30, 2024 15:23

neil-marcellini requested a review from a team April 30, 2024 15:24

melvin-bot bot requested review from rojiphil and removed request for a team April 30, 2024 15:24

neil-marcellini removed request for s77rt and rojiphil April 30, 2024 15:24

luacmartins requested changes Apr 30, 2024

View reviewed changes

src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved

Update getDistance util and use it more

2859ec2

luacmartins approved these changes Apr 30, 2024

View reviewed changes

luacmartins merged commit e138a59 into main Apr 30, 2024
15 checks passed

luacmartins deleted the neil-TransactionCustomUnit branch April 30, 2024 18:05

github-actions bot mentioned this pull request May 1, 2024

Deploy Checklist: New Expensify 2024-05-01 #41376

Closed

59 tasks

cretadn22 mentioned this pull request May 1, 2024

[PAY 16TH MAY][$250] Distance - Amount in confirmation page does not update after changing distance #41389

Closed

6 tasks

jjcoffee reviewed May 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Get distance from transaction vs route #40307

Get distance from transaction vs route #40307

Uh oh!

neil-marcellini commented Apr 16, 2024 •

edited

Loading

Uh oh!

melvin-bot bot commented Apr 30, 2024

Uh oh!

neil-marcellini commented Apr 30, 2024

Uh oh!

melvin-bot bot commented Apr 30, 2024

Uh oh!

luacmartins left a comment

Uh oh!

Uh oh!

neil-marcellini commented Apr 30, 2024

Uh oh!

luacmartins commented Apr 30, 2024 •

edited

Loading

Uh oh!

Uh oh!

OSBotify commented Apr 30, 2024

Uh oh!

OSBotify commented May 1, 2024

Uh oh!

OSBotify commented May 2, 2024

Uh oh!

jjcoffee May 15, 2024

Uh oh!

Uh oh!

Get distance from transaction vs route #40307

Get distance from transaction vs route #40307

Uh oh!

Conversation

neil-marcellini commented Apr 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Apr 30, 2024

Uh oh!

neil-marcellini commented Apr 30, 2024

Uh oh!

melvin-bot bot commented Apr 30, 2024

Uh oh!

luacmartins left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

neil-marcellini commented Apr 30, 2024

Uh oh!

luacmartins commented Apr 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

Uh oh!

OSBotify commented Apr 30, 2024

Uh oh!

OSBotify commented May 1, 2024

Uh oh!

OSBotify commented May 2, 2024

Uh oh!

jjcoffee May 15, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

neil-marcellini commented Apr 16, 2024 •

edited

Loading

luacmartins commented Apr 30, 2024 •

edited

Loading