Fix: Address field shows previous set of results on typing any char after removing the previous text #18258

Pujan92 · 2023-05-02T06:39:47Z

Details

Updated AddressSearch component to use useMemo for the query object which gets passed to the GooglePlacesAutocomplete, with that same ref of query we are passing to the GooglePlacesAutocomplete which eventually won't recreate the function debounceData inside GooglePlacesAutocomplete.

Fixed Issues

$ #16367
PROPOSAL: #16367 (comment)

Tests

Go to Settings > Profile > Personal details > Home address
Type/Remove characters quickly in/from "Address line 1" field
Verify the dropdown suggestion list only updates after you stop typing/removing characters
(Web / Desktop) Inspect the Network tab and Verify previous ongoing requests are getting canceled while typing/removing characters

Verify that no errors appear in the JS console

Offline Tests

N/A

QA Steps

Go to Settings > Profile > Personal details > Home address
Type/Remove characters quickly in/from "Address line 1" field
Verify the dropdown suggestion list only updates after you stop typing/removing characters
(Web / Desktop) Inspect the Network tab and Verify previous ongoing requests are getting canceled while typing/removing characters

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-05-02.at.12.01.50.PM.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

Screen.Recording.2023-05-02.at.12.09.01.PM.mov

iOS

Simulator.Screen.Recording.-.iPhone.14.-.2023-05-02.at.12.05.28.mp4

Android

MelvinBot · 2023-05-02T06:39:51Z

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

MelvinBot · 2023-05-02T06:39:55Z

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

s77rt · 2023-05-02T08:56:00Z

src/components/AddressSearch/index.js

+
+    // To avoid regeneration of query object on each re-renders
+    const query = useMemo(() => (
+        {language: props.preferredLocale, types: 'address', ...(props.isLimitedToUSA && {components: 'country:us'})}
+    ), [props.preferredLocale, props.isLimitedToUSA]);


Suggested change

// To avoid regeneration of query object on each re-renders

const query = useMemo(() => (

{language: props.preferredLocale, types: 'address', ...(props.isLimitedToUSA && {components: 'country:us'})}

), [props.preferredLocale, props.isLimitedToUSA]);

const query = useMemo(() => ({

language: props.preferredLocale,

types: 'address',

components: props.isLimitedToUSA ? 'country:us' : undefined,

}), [props.preferredLocale, props.isLimitedToUSA]);

Just for visibility and I think the comment is not necessary here.

s77rt · 2023-05-02T12:57:33Z

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

Mobile Web - Chrome

mweb-chrome.mp4

Mobile Web - Safari

mweb-safari.mp4

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

s77rt · 2023-05-02T13:03:19Z

@Pujan92 Can you please make tests step clearer? Example: type quickly and verify you only see the results of the last typed string or verify you only see results after you are done typing i.e. you should not see intermediate results, etc. (or in any way you see fit better).

For Web/Desktop, please indicate that you should check the Network tab and verify that old requests are cancelled once you start typing more letters.

Also please remove the offline tests.

Pujan92 · 2023-05-02T13:50:50Z

@Pujan92 Can you please make tests step clearer? Example: type quickly and verify you only see the results of the last typed string or verify you only see results after you are done typing i.e. you should not see intermediate results, etc. (or in any way you see fit better).

For Web/Desktop, please indicate that you should check the Network tab and verify that old requests are cancelled once you start typing more letters.

Also please remove the offline tests.

Ok @s77rt , are these steps makes sense?

Type or Remove any characters quickly
Verify the results are matched with text value once you stop typing/removing
For web/desktop verify the previous ongoing requests are getting canceled from the network tab

s77rt · 2023-05-02T19:28:09Z

@Pujan92 Sorry for the confusion, but by removing the offline tests I meant to keep the title and just write n/a (not applicable). As for the tests please update to:

Go to Settings > Profile > Personal details > Home address
Type/Remove characters quickly in/from "Address line 1" field
Verify the dropdown suggestion list only updates after you stop typing/removing characters
(Web / Desktop) Inspect the Network tab and Verify previous ongoing requests are getting cancelled while typing/removing characters

Pujan92 · 2023-05-03T05:53:08Z

@s77rt Thanks! updated with the suggested changes.

s77rt

LGTM! 🚀

cc @flodnv

flodnv

Lovely, thanks!

OSBotify · 2023-05-03T14:16:15Z

✋ 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-05-04T16:42:43Z

🚀 Deployed to staging by https://github.com/flodnv in version: 1.3.10-0 🚀

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

OSBotify · 2023-05-09T04:06:34Z

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

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

used useMemo to the query obejct for GooglePlacesAutocomplete

942d9a6

Pujan92 requested a review from a team as a code owner May 2, 2023 06:39

melvin-bot bot requested review from flodnv and s77rt and removed request for a team May 2, 2023 06:39

Pujan92 mentioned this pull request May 2, 2023

[HOLD for payment 2023-05-16] [$1000] App displays fixed set of results for few seconds and closes when using symbols like (,@,?,# on first open in address1 field of home address #16367

Closed

6 tasks

s77rt suggested changes May 2, 2023

View reviewed changes

PR comment addressed

01340b4

s77rt approved these changes May 3, 2023

View reviewed changes

flodnv approved these changes May 3, 2023

View reviewed changes

flodnv merged commit 234be3f into Expensify:main May 3, 2023

OSBotify mentioned this pull request May 4, 2023

Deploy Checklist: New Expensify 2023-05-04 #18411

Closed

32 tasks

MelvinBot mentioned this pull request Apr 6, 2024

[Snyk] Security upgrade eslint from 7.32.0 to 9.0.0 #39794

Closed

50 tasks

melvin-bot bot mentioned this pull request Apr 6, 2024

[Snyk] Security upgrade eslint from 7.32.0 to 9.0.0 #39795

Closed

Fix: Address field shows previous set of results on typing any char after removing the previous text #18258

Fix: Address field shows previous set of results on typing any char after removing the previous text #18258

Uh oh!

Conversation

Pujan92 commented May 2, 2023 • 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!

MelvinBot commented May 2, 2023

Uh oh!

MelvinBot commented May 2, 2023

Uh oh!

s77rt May 2, 2023

Choose a reason for hiding this comment

Uh oh!

s77rt commented May 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

s77rt commented May 2, 2023

Uh oh!

Pujan92 commented May 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

s77rt commented May 2, 2023

Uh oh!

Pujan92 commented May 3, 2023

Uh oh!

s77rt left a comment

Choose a reason for hiding this comment

Uh oh!

flodnv left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented May 3, 2023

Uh oh!

OSBotify commented May 4, 2023

Uh oh!

OSBotify commented May 9, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Pujan92 commented May 2, 2023 •

edited

Loading

s77rt commented May 2, 2023 •

edited

Loading

Pujan92 commented May 2, 2023 •

edited

Loading