Added 'name' field to waypoint by esh-g · Pull Request #29931 · Expensify/App

esh-g · 2023-10-19T02:19:11Z

Details

Bifurcated the address search with title and description for each address with a new field called name for each address.

Fixed Issues

$ #29222
$ #30255
PROPOSAL: #29222 (comment)

Tests

Click on request money.
Click on distance tab
Click on start and search for a location (as shown in video)
Make sure the places are shown with a title and a description.
Click on save and then select the finish place in the same way.
Make sure the waypoint names are shown like this:

Click on 'Next' and make sure the request is created successfully.
Go to the request and click on the receipt.
Make sure the receipt has the name of the place as well as description

Verify that no errors appear in the JS console

Offline tests

QA Steps

Click on request money.
Click on distance tab
Click on start and search for a location (as shown in video)
Make sure the places are shown with a title and a description.
Click on save and then select the finish place in the same way.
Make sure the waypoint names are shown like this:

Click on 'Next' and make sure the request is created successfully.
Go to the request and click on the receipt.
Make sure the receipt has the name of the place as well as description

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2023-10-19.at.8.43.42.PM-1.mov

Android: mWeb Chrome

71c90eb4-7d6b-4e4b-b6ae-ebdb07e706b9.mp4

iOS: Native

Screen.Recording.2023-10-19.at.9.47.42.PM.mov

iOS: mWeb Safari

9bafcaf4-69cf-4042-8681-b62a7b4c1426.mp4

MacOS: Chrome / Safari

991f7234-ab0f-433d-843c-c0161d68da8a.mp4

MacOS: Desktop

Screen.Recording.2023-10-19.at.9.25.39.PM-1.mov

melvin-bot · 2023-10-19T02:19:16Z

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

melvin-bot · 2023-10-19T02:19:16Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

esh-g · 2023-10-19T02:21:04Z

@mananjadhav I will attach the videos today (have to compress them without losing all the quality 😅) In the meantime, feel free to go over the changes

esh-g · 2023-10-19T16:19:04Z

@mananjadhav @dubielzyk-expensify All the videos have been added

mananjadhav · 2023-10-19T16:32:05Z

Thanks @esh-g. I'll get to this in a while.

src/components/AddressSearch/index.js

src/libs/TransactionUtils.ts

src/components/AddressSearch/index.js

Co-authored-by: Manan <manan.jadhav@gmail.com>

mananjadhav · 2023-10-19T18:13:33Z

@esh-g Can you confirm that we don't need to update AddressSearch.stories.js?

esh-g · 2023-10-19T18:26:08Z

@mananjadhav I don't think so because in the stories page, we are not able to access the places from the API anyway... It only shows the not found and error cases. I even tried it on main and this branch and the behaviour is same

mananjadhav · 2023-10-19T18:28:52Z

I just checked that. I asked because we're updating the view behavior of the component, but it looks like we don't pass the props to be able to populate the UI. Thanks for confirming.

mananjadhav · 2023-10-19T18:32:44Z

I think we have one issue here. Assuming if we have users with existing recent pins. They won't show up because the name is empty.

web-empty-name.mov

I am not sure if it's a case to consider, but this can lead to a bad experience for the user.

esh-g · 2023-10-19T18:39:30Z

@mananjadhav I also noticed that but it will only be faced for the current users until they don't replace their recents with the new format... I'm not sure if this would be a case to consider as well. So, please let me know if I should do so...

mananjadhav · 2023-10-19T18:43:33Z

I think it's a non-issue. Hence I am going ahead with the testing. We'll confirm with @neil-marcellini on this one.

mananjadhav · 2023-10-19T18:49:28Z

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

web-places-name-list.mov

Mobile Web - Chrome

mweb-chrome-places-name-list.mov

Mobile Web - Safari

mweb-safari-places-name-list-and-preview.mov

Desktop

desktop-places-name-list-and-preview.mov

iOS

ios-places-name-list-and-preview.mov

Android

android-name-places-list.mov

mananjadhav · 2023-10-19T19:10:25Z

Thanks for the quick PR @esh-g.

@neil-marcellini All yours. Want your feedback on this comment.

🎀 👀 🎀 C+ reviewed.

dubielzyk-expensify · 2023-10-20T01:01:09Z

Looks good. I do think this shouldn't be a thing though:

There should always be a primary text line and in this instance there's only a secondary one.

esh-g · 2023-10-20T10:11:03Z

@dubielzyk-expensify @neil-marcellini Just pushed a commit to handle that case... Let me know if it looks good!

esh-g · 2023-10-20T16:08:58Z

Gentle bump @neil-marcellini @dubielzyk-expensify

neil-marcellini

Great job on this so far! It's getting a bit tricky because we have to consider that existing recent waypoints don't have the name field. I'm pushing back on the design decision a bit and we'll discuss it in Slack. I'll let you know what we decide. In the meantime you can get started on the other changes.

src/pages/iou/WaypointEditor.js

src/components/AddressSearch/index.js

src/components/DistanceEReceipt.js

src/components/DistanceRequest/DistanceRequestRenderItem.js

src/libs/TransactionUtils.ts

src/types/onyx/RecentWaypoint.ts

src/types/onyx/Transaction.ts

esh-g · 2023-10-21T15:27:31Z

@neil-marcellini Really sorry for the delay... I have made all the requested changes. The main difference of opinion here was that I thought name ought to be a 'required' field which is why I wanted to make sure it was defined everywhere but I have raised the concern here but still I have now made the changes to make it an optional field

esh-g · 2023-10-23T16:16:59Z

gentle bump @neil-marcellini

neil-marcellini · 2023-10-23T16:50:58Z

I'm pushing back on the design decision a bit and we'll discuss it in Slack. I'll let you know what we decide.

We decided in Slack (internally) that it's ok to have the address displayed in the secondary text style when the place name is missing.

esh-g · 2023-10-23T16:58:38Z

@neil-marcellini Are you saying that only for the distance receipt or also for the suggestion row?

neil-marcellini

Thank you for the cleanup so far @esh-g. We made our decision about the styling, so would you please get that updated too? Please DM me if you have questions and let me know when it's ready for another review.

src/pages/iou/WaypointEditor.js

neil-marcellini

Ok, thanks for all the updates. I think it's good to go.

src/components/AddressSearch/index.js

neil-marcellini · 2023-10-23T18:12:27Z

@mananjadhav would you please test once more since we have made a handful of changes?

mananjadhav · 2023-10-24T08:30:07Z

I will test this in a few hours.

mananjadhav · 2023-10-24T18:14:21Z

@neil-marcellini @esh-g Tested with the updated changes.

Screenshots/Videos

Web

web-name-in-places.mov

Mobile Web - Chrome

mweb-chrome-name-in-places.mov

Mobile Web - Safari

mweb-safari-name-in-places.mov

Desktop

desktop-name-in-places.mov

iOS

ios-name-in-places.mov

Android

android-name-in-places.mov

esh-g · 2023-10-25T15:54:09Z

gentle bump @neil-marcellini

OSBotify · 2023-10-25T17:12:25Z

✋ 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 · 2023-10-25T17:50:19Z

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

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

OSBotify · 2023-10-26T22:40:54Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.91-8 🚀

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

OSBotify · 2023-10-30T08:05:32Z

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

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

OSBotify · 2023-10-31T21:38:42Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.93-1 🚀

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

esh-g added 2 commits October 19, 2023 07:42

Added 'name' field to waypoint

05d43c3

Fix lint

89e0fa4

esh-g requested a review from a team as a code owner October 19, 2023 02:19

melvin-bot bot requested review from dubielzyk-expensify and mananjadhav and removed request for a team October 19, 2023 02:19

Remove console logs

68060f3

esh-g mentioned this pull request Oct 19, 2023

[HOLD for payment 2023-11-02] [$500] Show place name and address for suggestions and recent waypoints, like google and apple maps. #29222

Closed

Correct Proptypes

7c9d15a

mananjadhav reviewed Oct 19, 2023

View reviewed changes

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

mananjadhav reviewed Oct 19, 2023

View reviewed changes

src/libs/TransactionUtils.ts Outdated Show resolved Hide resolved

mananjadhav reviewed Oct 19, 2023

View reviewed changes

src/components/AddressSearch/index.js Show resolved Hide resolved

Edit comment

034549f

Co-authored-by: Manan <manan.jadhav@gmail.com>

Remove unnecessary comments

be1585a

mananjadhav approved these changes Oct 19, 2023

View reviewed changes

melvin-bot bot requested a review from neil-marcellini October 19, 2023 19:08

neil-marcellini requested changes Oct 20, 2023

View reviewed changes

Changes requested in review

20020b2

dubielzyk-expensify previously approved these changes Oct 22, 2023

View reviewed changes

neil-marcellini reviewed Oct 23, 2023

View reviewed changes

src/pages/iou/WaypointEditor.js Outdated Show resolved Hide resolved

esh-g added 2 commits October 23, 2023 23:04

secondary text style when name missing

0731102

Unset name for current location

67e5322

esh-g dismissed dubielzyk-expensify’s stale review via 67e5322 October 23, 2023 17:41

Remove name from input keys

55ffbda

neil-marcellini approved these changes Oct 23, 2023

View reviewed changes

src/components/AddressSearch/index.js Show resolved Hide resolved

esh-g mentioned this pull request Oct 24, 2023

[HOLD for payment 2023-11-02] [$500] Distance IOU- Selected suggested address is not shown in address field #30255

Closed

6 tasks

esh-g mentioned this pull request Oct 25, 2023

[HOLD for payment 2024-01-11] [$500] Android - IOU-In a address, one word in Hindi and other text in English are shown. #30298

Closed

6 tasks

neil-marcellini merged commit 8609454 into Expensify:main Oct 25, 2023

OSBotify mentioned this pull request Oct 25, 2023

Deploy Checklist: New Expensify 2023-10-25 #30365

Closed

99 tasks

OSBotify mentioned this pull request Oct 30, 2023

Deploy Checklist: New Expensify 2023-10-30 #30560

Closed

Conversation

esh-g commented Oct 19, 2023 • edited by johncschuster 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 Oct 19, 2023

Uh oh!

melvin-bot bot commented Oct 19, 2023

Uh oh!

esh-g commented Oct 19, 2023

Uh oh!

esh-g commented Oct 19, 2023

Uh oh!

mananjadhav commented Oct 19, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mananjadhav commented Oct 19, 2023

Uh oh!

esh-g commented Oct 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mananjadhav commented Oct 19, 2023

Uh oh!

mananjadhav commented Oct 19, 2023

Uh oh!

esh-g commented Oct 19, 2023

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mananjadhav commented Oct 19, 2023

Uh oh!

dubielzyk-expensify commented Oct 20, 2023

Uh oh!

esh-g commented Oct 20, 2023

Uh oh!

esh-g commented Oct 20, 2023

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

esh-g commented Oct 21, 2023

Uh oh!

esh-g commented Oct 23, 2023

Uh oh!

neil-marcellini commented Oct 23, 2023

Uh oh!

esh-g commented Oct 23, 2023

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

esh-g commented Oct 19, 2023 •

edited by johncschuster

Loading

esh-g commented Oct 19, 2023 •

edited

Loading

mananjadhav commented Oct 19, 2023 •

edited

Loading

mananjadhav commented Oct 19, 2023 •

edited

Loading