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/15753: suggested address not populate if unknown to google db #16388

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Mar 22, 2023

Details

Some suggested places from Google Place Autocomplete do not automatically populate to other fields in Home Address page if they do not exists on Google database. This PR fixes the issue by using the suggested result as fallback values when there's no data on Google database.

Fixed Issues

$ #15753
PROPOSAL: #15753 (comment)

Tests

  1. Login with any account
  2. Click on Profile avatar > Profile > Personal details > Home address
  3. In the Address line 1 field type in: I
  4. Select I-35 (i.e. I-35 Ottawa, KS, USA)
  5. Verify that other fields are filled automatically just as the suggestion (i.e. Interstate 35 - Ottawa - Kansas - United States)
  6. Select I-80 (i.e. I-80 Seward, NE, USA)
  7. Verify that other fields are filled automatically just as the suggestion (i.e. Interstate 80 - Seward - Nebraska - United States)
  8. In the Address line 1 field, type in: N12 ireland
  9. Select the option N12, Knockaconny, County Monaghan, Ireland
  10. Make sure that the City, State / Province, and Country fields get automatically filled
  11. In the Address line 1 field, type in: BR-101
  12. Select the option that starts with BR-101, Linhares
  13. Make sure that the City, State / Province, and Country fields get automatically filled
  • Verify that no errors appear in the JS console

Offline tests

Same above

QA Steps

  1. Login with any account
  2. Click on Profile avatar > Profile > Personal details > Home address
  3. In the Address line 1 field type in: I
  4. Select I-35 (i.e. I-35 Ottawa, KS, USA)
  5. Verify that other fields are filled automatically just as the suggestion (i.e. Interstate 35 - Ottawa - Kansas - United States)
  6. Select I-80 (i.e. I-80 Seward, NE, USA)
  7. Verify that other fields are filled automatically just as the suggestion (i.e. Interstate 80 - Seward - Nebraska - United States)
  8. In the Address line 1 field, type in: N12 ireland
  9. Select the option N12, Knockaconny, County Monaghan, Ireland
  10. Make sure that the City, State / Province, and Country fields get automatically filled
  11. In the Address line 1 field, type in: BR-101
  12. Select the option that starts with BR-101, Linhares
  13. Make sure that the City, State / Province, and Country fields get automatically filled
  • 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 / Chrome
    • iOS / native
    • iOS / 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 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 correct English and 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
    • 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 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 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

Web
Screencast.from.21-03-2023.23.46.11.webm
Mobile Web - Chrome
Screenrecording_20230321_234840.mp4
Mobile Web - Safari
RPReplay_Final1679457203.mp4
Desktop
Screen.Recording.2023-03-22.at.10.45.02.1.mp4
iOS
Screen.Recording.2023-03-22.at.10.49.05.mp4
Android
untitled_2vIq0QBq.mp4

@MelvinBot
Copy link

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

@tienifr tienifr marked this pull request as ready for review March 22, 2023 14:56
@tienifr tienifr requested a review from a team as a code owner March 22, 2023 14:56
@melvin-bot melvin-bot bot requested review from francoisl and sobitneupane and removed request for a team March 22, 2023 14:56
@MelvinBot
Copy link

@francoisl @sobitneupane 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]

@tienifr
Copy link
Contributor Author

tienifr commented Mar 23, 2023

Hi @sobitneupane Please help to review this PR. Many thanks

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

@tienifr We had discussed on using fallback solution only if the predicted country is USA. It looks like we are using fallback solution for all countries. Will the solution work for all countries?

@tienifr
Copy link
Contributor Author

tienifr commented Mar 23, 2023

I'm leaning towards @tienifr's original #15753 (comment) – without limiting the fallback solution if the predicted country is USA as I #15753 (comment).

As @francoisl mentioned in his comment, I tested with other countries: Vietnam, Austria, Denmark, Combodia... and it worked just fine.

@tienifr
Copy link
Contributor Author

tienifr commented Mar 24, 2023

@francoisl Take a look at the PR when you're available. Thanks!

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

Some Issues on other countries:
Screenshot 2023-03-24 at 18 50 24

@tienifr
Copy link
Contributor Author

tienifr commented Mar 27, 2023

@sobitneupane There are 2 issues there:

  1. The city field is filled with false
  2. The Zip/Postal code is missing

The first issue is my fault due to the way I get the term within getPlaceAutocompleteTerms, I've fixed this.

The second issue is not related to this PR.

@sobitneupane
Copy link
Contributor

@francoisl I think we should use this fallback solution only for USA. Address formats for other countries are usually different and might not work always. What do you suggest?

@tienifr
Copy link
Contributor Author

tienifr commented Mar 28, 2023

@francoisl Are you available?

@tienifr
Copy link
Contributor Author

tienifr commented Mar 30, 2023

@arielgreen Do you think we need to assign someone else to review this PR? As I think @francoisl may be OOO.

@francoisl
Copy link
Contributor

Hi, sorry I was out of office but I'm back now.

I think we should use this fallback solution only for USA. Address formats for other countries are usually different and might not work always.

My rationale for proposing not to restrict to USA was that we might as well try to use the fallback logic for all countries, on the off chance that the terms follow the same 'street', 'city', 'state', 'country' order.

The difficult part of testing is that it's hard to find addresses similar to I-80 of the original issue for which Google Maps' API doesn't return details, but for other countries. I found a couple examples by just entering random road names I found on Google Maps:

  • Search for N12 Ireland, choose the first suggestion that contains Knockaconny: with this proposed fix, we'd correctly fill in the city
  • Search for BR-101, choose the first suggestion that contains Linhares from Brazil: with this fix, we'd also correctly fill in the city

And so on, there must be other examples in other countries, but it's time-consuming to search for them.


Also @tienifr there is a conflict on the branch, do you mind updating please?

@tienifr
Copy link
Contributor Author

tienifr commented Mar 31, 2023

@francoisl I've already resolved it. Btw, I'm not sure your final conclusion on whether to apply this logic to the US only.

@francoisl
Copy link
Contributor

Btw, I'm not sure your final conclusion on whether to apply this logic to the US only.

Hm sorry, what do you mean? Are you rethinking your solution and saying we should restrict the fix to the US only? I'm still thinking we should not restrict the fix to the US only, as suggested by my examples above.

We can even add those two examples to the test and QA steps, for example:

[... current steps]
8. In the Address line 1 field, type in: N12 ireland
9. Select the option N12, Knockaconny, County Monaghan, Ireland
10. Make sure that the City, State / Province, and Country fields get automatically filled
11. In the Address line 1 field, type in: BR-101
12. Select the option that starts with BR-101, Linhares
13. Make sure that the City, State / Province, and Country fields get automatically filled

@tienifr
Copy link
Contributor Author

tienifr commented Apr 1, 2023

@francoisl Thanks for your comments, I just updated the test step. @sobitneupane bump

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

Screenshots/Videos

Web Screenshot 2023-04-01 at 08 05 49 Screenshot 2023-04-01 at 08 05 32 Screenshot 2023-04-01 at 08 05 08 Screenshot 2023-04-01 at 08 04 29 Screenshot 2023-04-01 at 08 03 16 Screenshot 2023-04-01 at 08 07 14
Mobile Web - Chrome Screenshot 2023-04-01 at 08 15 57 Screenshot 2023-04-01 at 08 15 26 Screenshot 2023-04-01 at 08 15 07
Mobile Web - Safari
Desktop Screenshot 2023-04-01 at 08 08 50 Screenshot 2023-04-01 at 08 08 42 Screenshot 2023-04-01 at 08 09 40 Screenshot 2023-04-01 at 08 09 30 Screenshot 2023-04-01 at 08 09 04 Screenshot 2023-04-01 at 08 11 37
iOS
Android

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

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 / Chrome
    • iOS / native
    • iOS / 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 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 correct English and 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 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 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.

@tienifr
Copy link
Contributor Author

tienifr commented Apr 1, 2023

@francoisl this PR is ready to merge, could you help to check and merge it? Many thanks

@francoisl francoisl merged commit 4ee21e9 into Expensify:main Apr 1, 2023
@OSBotify
Copy link
Contributor

OSBotify commented Apr 1, 2023

✋ 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
Copy link
Contributor

OSBotify commented Apr 3, 2023

🚀 Deployed to staging by https://github.com/francoisl in version: 1.2.94-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Apr 5, 2023

🚀 Deployed to production by https://github.com/thienlnam in version: 1.2.94-3 🚀

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

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.

5 participants