Fix - Cannot enter address in personal details, address disappears after entering #28474

[AmjedNazzal]

Details

We are adding a street fallback for instances where neither street_number nor route exist in the API response

Fixed Issues

$ #28474
PROPOSAL: #28474 (comment)

Tests

1. Go to Settings > Profile > Personal details > Address
2. In address line 1, type "200 dury" or "161 sajik" and pick the first result
3. Observe that address line 1 gets filled correctly with the choosen address

• Verify that no errors appear in the JS console

Offline tests

No test steps as google autocomplete doesn't work offline

QA Steps

1. Go to Settings > Profile > Personal details > Address
2. In address line 1, type "200 dury" or "161 sajik" and pick the first result
3. Observe that address line 1 gets filled correctly with the choosen address

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

android-native-address-details.mp4

Android: mWeb Chrome

mweb-chrome-address-details.mov

iOS: Native

ios-native-address-details.mov

iOS: mWeb Safari

mweb-safari-address-details.mov

MacOS: Chrome / Safari

web-chrome-address-details.mov

MacOS: Desktop

macos-desktop-address-details.mov

[melvin-bot]

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

[melvin-bot]

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

[AmjedNazzal]

@jjcoffee I've made some changes, I've removed the extra fallback and I've implemented _.get to avoid potential error throwing, also added an extra check for details.adr_address to ensure that we don't try calling .match on an undefined prop. let me know what you think :)

[AmjedNazzal]

Sorry that I keep making changes but what I decided is that I'm already using a regex to capture the street address so there is no point in using ExpensiMark here since it will be passed plain text string anyway and it uses regex in a similar way as well regardless so I don't see the benefit of using it, I think just simple plain regex should suffice here, otherwise we could make a custom parser or use a parsing library, which looking at our package.json it seem like we already have htmlparser2 v7.2.0, although we don't seem to be using it anywhere in the app so not sure why it's there.

[AmjedNazzal]

@jjcoffee Thoughts?

[jjcoffee]

I think I prefer parsing vs regex, and it looks like htmlparser2 is used in a few places. Not a huge deal if it's too much of a pain to implement but it might be worth a try!

[AmjedNazzal]

@jjcoffee It's not a pain at all! here's my code to implement htmlparser2 for this, let me know what you think of it, until then I will be doing some testing to see if there seem to be any potential issues with using this code

if (!values.street && details.adr_address) {
  let streetAddress;
  let matchedText = false;

  const parser = new HtmlParser({
      onopentag(name, attribs){
          if(name === "span" && attribs.class === "street-address"){
              matchedText = true;
          }
      },
      ontext(text){
          if(matchedText){
              streetAddress = text;
          }
      },
      onclosetag(tagname){
          if(tagname === "span"){
              matchedText = false;
          }
      }
  }, { decodeEntities: true });
  parser.write(details.adr_address);
  parser.end();

  if (streetAddress) {
      values.street = streetAddress.trim();
  } 
}

[jjcoffee]

Ah this doesn't look as tidy as I imagined! I think it might be overkill for this case and we can probably stick with the regex for now, unless you don't want your extra work to go to waste 😄 We can also see what the internal engineer thinks.

I'll try to get the checklist done tomorrow, unfortunately higher priority PRs got in the way today!

[AmjedNazzal]

@jjcoffee Haha no don't worry about it, I don't mind trying different things to see what feels right, we can certently stick to the regex way, it should work fine either way since we already use similar methods in ExpensiMark anyway :)

[jjcoffee]

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

Android: Native

android-native-2023-11-09_14.55.43.mp4

Android: mWeb Chrome

android-chrome-2023-11-09_14.51.25.mp4

iOS: Native

ios-native-2023-11-09_15.50.46.mp4

iOS: mWeb Safari

ios-safari-2023-11-09_15.40.36.mp4

MacOS: Chrome / Safari

desktop-chrome-2023-11-09_14.26.33.mp4

MacOS: Desktop

desktop-app-2023-11-09_15.01.48.mp4

[jjcoffee]

@AmjedNazzal Testing on a distance request, I'm getting a bit of a weird result where only the street number displays:

distance-request-2023-11-09_15.54.45.mp4

[AmjedNazzal]

@jjcoffee That's due to how DistanceRequest sets up it's waypoints and it's waypoints preview, it uses values.address which holds the full address like this "200 Duryugongwon-ro, Dalseo-gu, Daegu, South Korea" and then extracts from it, it doesn't use values.street at all.

[jjcoffee]

Ooh okay yeah I see that looks like it would be out of scope for this issue I think!

[jjcoffee]

LGTM!

[jjcoffee]

@cristipaval All yours! Just a quick note that we did look at parsing the HTML instead, but it ended up not being as elegant as I had hoped, so I decided it's not worth it for this when a very simple regex check will do.

There is also this issue for distance requests, but it seems out of scope as distance requests do some manual parsing of the address for display.

[cristipaval]

@cristipaval All yours! Just a quick note that we did look at parsing the HTML instead, but it ended up not being as elegant as I had hoped, so I decided it's not worth it for this when a very simple regex check will do.

There is also this issue for distance requests, but it seems out of scope as distance requests do some manual parsing of the address for display.

Agree! Thank you both!

[OSBotify]

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

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.99-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.99-0 🚀

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

[OSBotify]

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.4.0-0 🚀

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