Fix disappearing finish waypoint when start waypoint is selected #29811

alitoshmatov · 2023-10-17T18:08:26Z

Details

When default waypoint is set to null they are getting removed from onyx, but we need them for start and finish waypoints. Now for default waypoints we set {} rather than null value

Fixed Issues

$ #29748
PROPOSAL: #29748 (comment)

Tests

Go to workspace chat report
Click + and choose request money
Switch to distance request
Enter starting address
Make sure empty finish waypoint is still there

Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

Same as tests

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

Android: Native

waypoints-android.mp4

Android: mWeb Chrome

waypoints-mweb.mp4

iOS: Native

waypoints-ios.mp4

iOS: mWeb Safari

waypoints-safari.mp4

MacOS: Chrome / Safari

waypoints-web.mov

MacOS: Desktop

waypoints-desktop.mov

melvin-bot · 2023-10-17T18:08:32Z

@Santhosh-Sellavel 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

Looking good. I'll test soon. One suggestion

src/components/DistanceRequest/index.js

neil-marcellini · 2023-10-17T18:36:26Z

It tests well

Santhosh-Sellavel · 2023-10-17T19:47:04Z

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 && <xMyComponent />.
- 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(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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web & Desktop

Screen.Recording.2023-10-18.at.1.04.50.AM.mov

Mobile Web - Chrome

Screen_Recording_20231018_011525_Chrome.mp4

Mobile Web - Safari & iOS

Screen.Recording.2023-10-18.at.1.12.29.AM.mov

Android

Santhosh-Sellavel · 2023-10-17T19:48:11Z

There are some console errors but irrelevant to the changes made here.

Santhosh-Sellavel · 2023-10-17T19:51:10Z

LGTM just waiting to test on Android alone!

Santhosh-Sellavel · 2023-10-17T20:05:45Z

Quick question @neil-marcellini

Is this is bug or expected?

I set a start address and cleared it, but the finish got removed.

Screen.Recording.2023-10-18.at.1.34.02.AM.mov

neil-marcellini · 2023-10-17T20:09:47Z

Is this is bug or expected?

I set a start address and cleared it, but the finish got removed.

Oh great catch. That's not expected. There should always be a start and finish

Santhosh-Sellavel · 2023-10-17T20:17:27Z

Should this be handled here or can be a separate one?

alitoshmatov · 2023-10-17T20:17:39Z

Here is also null value is used to empty waypoint, thus resulting in total removal of the key from onyx. But we cannot replace this null with {} since this waypoint already has fields like address, lat, long and merging {} does not change anything and results in not removing of the address.

App/src/libs/actions/Transaction.ts

Line 112 in a88728a

saveWaypoint(transactionID, index.toString(), null);

cc: @Santhosh-Sellavel @neil-marcellini

alitoshmatov · 2023-10-17T20:22:38Z

One quick solution could be emptying each field inside waypoint object like so:

saveWaypoint(transactionID, index.toString(), {address: '', lat: null, lng: null});

Santhosh-Sellavel · 2023-10-17T20:23:33Z

Here is also null value is used to empty waypoint, thus resulting in total removal of the key from onyx. But we cannot replace this null with {} since this waypoint already has fields like address, lat, long and merging {} does not change anything and results in not removing of the address.

App/src/libs/actions/Transaction.ts

Line 112 in a88728a

saveWaypoint(transactionID, index.toString(), null);

cc: @Santhosh-Sellavel @neil-marcellini

Cool but clearing won't delete the other entries as well.

alitoshmatov · 2023-10-17T20:30:03Z

How about this : #29811 (comment)
@Santhosh-Sellavel

Santhosh-Sellavel · 2023-10-17T20:34:58Z

Bad Idea!

Santhosh-Sellavel

LGTM.

Didn't test this on Android something broke with my Android Build setup. But that shouldn't be a blocker here so Approving!

Santhosh-Sellavel · 2023-10-17T20:43:17Z

I think it's better to handle it separately, handling it more carefully and after testing thoroughly!

cc: @neil-marcellini let me know your thoughts, thanks!

neil-marcellini

The code looks great and tests well. I think it's good to merge.

web1080.mov

neil-marcellini · 2023-10-17T22:05:11Z

To be clear we discussed the plan in a DM and agreed on the solution.

OSBotify · 2023-10-17T22:12:37Z

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

…waypoint Fix disappearing finish waypoint when start waypoint is selected (cherry picked from commit fc8ce73)

OSBotify · 2023-10-17T22:51:19Z

🚀 Cherry-picked to staging by https://github.com/francoisl in version: 1.3.85-4 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2023-10-17T23:12:00Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.85-4 🚀

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

Setting default empty waypoints to empty object rather than null

a88728a

alitoshmatov requested a review from a team as a code owner October 17, 2023 18:08

melvin-bot bot requested review from Santhosh-Sellavel and removed request for a team October 17, 2023 18:08

alitoshmatov mentioned this pull request Oct 17, 2023

[HOLD for payment 2023-10-25] [$500] IOU-In distance request, after selecting start waypoint finish section disappears #29748

Closed

6 tasks

neil-marcellini requested changes Oct 17, 2023

View reviewed changes

src/components/DistanceRequest/index.js Outdated Show resolved Hide resolved

Simplified updateWaypoints

19c8e25

alitoshmatov requested a review from neil-marcellini October 17, 2023 18:52

neil-marcellini previously approved these changes Oct 17, 2023

View reviewed changes

Santhosh-Sellavel approved these changes Oct 17, 2023

View reviewed changes

melvin-bot bot requested a review from neil-marcellini October 17, 2023 20:38

Updated waypoint removing logic and types

61574b7

alitoshmatov dismissed neil-marcellini’s stale review via 61574b7 October 17, 2023 21:41

Updated types, introduces Waypoints type

01016dc

neil-marcellini approved these changes Oct 17, 2023

View reviewed changes

neil-marcellini merged commit fc8ce73 into Expensify:main Oct 17, 2023

OSBotify pushed a commit that referenced this pull request Oct 17, 2023

Merge pull request #29811 from alitoshmatov/29748/disapearing-finish-…

6386213

…waypoint Fix disappearing finish waypoint when start waypoint is selected (cherry picked from commit fc8ce73)

OSBotify mentioned this pull request Oct 17, 2023

Deploy Checklist: New Expensify 2023-10-16 #29717

Closed

situchan mentioned this pull request Oct 19, 2023

Fix map preview not extended to full view #28922

Merged

66 tasks

Fix disappearing finish waypoint when start waypoint is selected #29811

Fix disappearing finish waypoint when start waypoint is selected #29811

Uh oh!

Conversation

alitoshmatov commented Oct 17, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Oct 17, 2023

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

neil-marcellini commented Oct 17, 2023

Uh oh!

Santhosh-Sellavel commented Oct 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

Santhosh-Sellavel commented Oct 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Santhosh-Sellavel commented Oct 17, 2023

Uh oh!

Santhosh-Sellavel commented Oct 17, 2023

Uh oh!

neil-marcellini commented Oct 17, 2023

Uh oh!

Santhosh-Sellavel commented Oct 17, 2023

Uh oh!

alitoshmatov commented Oct 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alitoshmatov commented Oct 17, 2023

Uh oh!

Santhosh-Sellavel commented Oct 17, 2023

Uh oh!

alitoshmatov commented Oct 17, 2023

Uh oh!

Santhosh-Sellavel commented Oct 17, 2023

Uh oh!

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

Uh oh!

Santhosh-Sellavel commented Oct 17, 2023

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

neil-marcellini commented Oct 17, 2023

Uh oh!

OSBotify commented Oct 17, 2023

Uh oh!

OSBotify commented Oct 17, 2023

Uh oh!

OSBotify commented Oct 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Santhosh-Sellavel commented Oct 17, 2023 •

edited

Loading

Santhosh-Sellavel commented Oct 17, 2023 •

edited

Loading

alitoshmatov commented Oct 17, 2023 •

edited

Loading