[HOLD for payment 2023-10-30] Profile - 'Country' doesn't change if selected manually and then another suggested address is selected

[lanitochka17]

If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!

---

Version Number: 1.3.81-6

Reproducible in staging?: Yes

Reproducible in production?: Yes

If this was caught during regression testing, add the test name, ID and link from TestRail:

Email or phone of affected tester (no customers):

Logs: https://stackoverflow.com/c/expensify/questions/4856

Expensify/Expensify Issue URL:

Issue reported by: Applause - Internal Team

Slack conversation:

Action Performed:

1. Go to staging.new.expensify.com or open Expensify App (iOS, Android, Desktop)
2. Login with any account
3. Go to Settings > Profile > Personal details > Home address
4. Select any country
5. Start type any address in Address Line 1
6. Select any suggested address in another country

Expected Result:

All fields are filled in correctly. Country replaced with the suggested one

Actual Result:

The “Country” field has not changed and remains the same as it was previously selected manually

Workaround:

Unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

Bug6233524_1697053961845.Desktop-Selected-County-not-change-to-suggested.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~0192336d38fb4edbd9
• Upwork Job ID: 1712810996160061440
• Last Price Increase: 2023-10-13
• Automatic offers:
• 0xmiroslav | Reviewer | 27241875
• ishpaul777 | Contributor | 27241878

[melvin-bot]

Triggered auto assignment to @laurenreidexpensify (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

[melvin-bot]

Bug0 Triage Checklist (Main S/O)

• This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
• This bug is not a duplicate report (check E/App issues and #expensify-bugs)
  • If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead
• This bug is reproducible using the reproduction steps in the OP. S/O
  • If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
  • If the reproduction steps aren't clear and you determine the correct steps, please update the OP.
• This issue is filled out as thoroughly and clearly as possible
  • Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
• I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

[ishpaul777]

Proposal

Problem

'Country' not change if select it manually and then select another suggested address

Root Cause

In useEffect of AddressPage we have added a dependecy for currentCountry so even when the address country is changed when a auto suggested address in clicked it get overridden by country from url Param.

Changes

We can safely remove currentCountry from url so the useEffect run only on componentmount and url param change but not when currentCountry change.

[alitoshmatov]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Profile - 'Country' not change if select it manually and then select another suggested address

What is the root cause of that problem?

When we select country from country list, selected country is stored in route data. And we have this piece of code to retrieve this data from route and set local state

App/src/pages/settings/Profile/PersonalDetails/AddressPage.js

Lines 156 to 161 in 8e80bda

	useEffect(() => {
	if (!countryFromUrl || countryFromUrl === currentCountry) {
	return;
	}
	handleAddressChange(countryFromUrl, 'country');
	}, [countryFromUrl, handleAddressChange, currentCountry]);

Notice that currentCountry is also in a dependency list. So when autocomplete changes country it will trigger above useEffect and it will read countryFromUrl and set it to current country reverting the changes.

What changes do you think we should make in order to solve the problem?

We should remove currentCountry from dependency list, and I think we can also remove countryFromUrl === currentCountry condition which won't affect expected behavior. So at the end, this useEffect is triggered only if country in route is changed

What alternative solutions did you explore? (Optional)

[DylanDylann]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Profile - 'Country' not change if select it manually and then select another suggested address

What is the root cause of that problem?

When the user selects a country from the country list, we will set the selected country to route. But when the country is completed automatically by Google API, we don't reset the country in the route. So that the country in route will override the selected country

What changes do you think we should make in order to solve the problem?

When a country is changed automatically by Google API (clicking suggestion from address line 1), we should reset the route to settings/profile/personal-details/address

In here:

App/src/pages/settings/Profile/PersonalDetails/AddressPage.js

Line 189 in 44bcf1c

onValueChange={handleAddressChange}

We should update like this

onValueChange={(value, key)=> {
                                if (countryFromUrl) {
                                    Navigation.navigate(ROUTES.SETTINGS_PERSONAL_DETAILS_ADDRESS)
                                }
                                handleAddressChange(value, key)
                            }}

As mentioned here #29382 (comment) We also remove the redundant call by removing currentCountry here

App/src/pages/settings/Profile/PersonalDetails/AddressPage.js

Line 161 in 44bcf1c

}, [countryFromUrl, handleAddressChange, currentCountry]);

Result

Screen.Recording.2023-10-16.at.22.04.06.mov

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~0192336d38fb4edbd9

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @0xmiroslav (External)

[laurenreidexpensify]

@0xmiroslav what you think of the proposals above?

[0xmiros]

@alitoshmatov's proposal looks good to me.
I think it's fine not resetting route when country is changed from dropdown.
🎀 👀 🎀 C+ reviewed

[melvin-bot]

Triggered auto assignment to @lakchote, see https://stackoverflow.com/c/expensify/questions/7972 for more details.

[DylanDylann]

@0xmiroslav A bit curious, With @alitoshmatov's #29382 (comment) proposal, When we select new address line 1 the country will update but the country in the url still be old value.

[0xmiros]

@DylanDylann I added explanation:

I think it's fine not resetting route when country is changed from dropdown.

[DylanDylann]

Sorry I miss it, If we remain the wrong url, user will be get wrong information when reloading

[0xmiros]

Good point but we should optimize code as well. There's redundant call of handleAddressChange when selected from autocomplete suggestion.

we should reset the route to settings/profile/personal-details/address

How will you reset this root manually though?

[ishpaul777]

hii @0xmiroslav my proposal was before the selected proposal and suggest enough to solve the problem, selected proposal has a minor change with no effect over the functionality

I think we can also remove countryFromUrl === currentCountry condition which won't affect expected behavior.

[0xmiros]

We can safely remove currentCountry from url

@ishpaul777 your solution was this one, am I wrong?

[ishpaul777]

omg this was a typo! sorry for confusion but my intent was to remove from dependency list,

[DylanDylann]

How will you reset this root manually though?

@0xmiroslav Updated proposal for more detail

[0xmiros]

Still I am not inclined to force update route on the same page as we don't have this pattern yet in the app. (@DylanDylann tell me if you found any)

[lakchote]

I would prefer not having to update the route. It would be an edge case that on reload the user gets wrong information.
On the other hand, by not updating the route we avoid performance overheads. When looking at the video, we can see for a second the UI is frozen when selecting the address and updating the country which is not ideal IMO.

[0xmiros]

@lakchote thanks for feedback.

In this case, I think we can go with @ishpaul777 to be fair as it was just a typo url -> dependency.
Though that one typo had completely different meaning 🙂

[melvin-bot]

📣 @0xmiroslav 🎉 An offer has been automatically sent to your Upwork account for the Reviewer role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job

[melvin-bot]

📣 @ishpaul777 🎉 An offer has been automatically sent to your Upwork account for the Contributor role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job
Please accept the offer and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Keep in mind: Code of Conduct | Contributing 📖

[laurenreidexpensify]

@ishpaul777 do we have a draft PR up yet? Thanks!

[ishpaul777]

Sorry for not giving ETA. I am working on it will raise a PR by the end of today(wednesday).

[ishpaul777]

@0xmiroslav PR is up for your review, please take a look when you get the chance, Thanks!

[melvin-bot]

🎯 ⚡️ Woah @0xmiroslav / @ishpaul777, great job pushing this forwards! ⚡️

The pull request got merged within 3 working days of assignment, so this job is eligible for a 50% #urgency bonus 🎉

• when @ishpaul777 got assigned: 2023-10-17 15:12:20 Z
• when the PR got merged: 2023-10-19 07:24:41 UTC

On to the next one 🚀

[melvin-bot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[melvin-bot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 1.3.88-11 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• Fix/country not changing from autosuggestion #29890

If no regressions arise, payment will be issued on 2023-10-30. 🎊

After the hold period is over and BZ checklist items are completed, please complete any of the applicable payments for this issue, and check them off once done.

• External issue reporter
• Contributor that fixed the issue
• Contributor+ that helped on the issue and/or PR

For reference, here are some details about the assignees on this issue:

• @0xmiroslav requires payment offer (Reviewer)
• @ishpaul777 requires payment offer (Contributor)

As a reminder, here are the bonuses/penalties that should be applied for any External issue:

• Merged PR within 3 business days of assignment - 50% bonus
• Merged PR more than 9 business days after assignment - 50% penalty

[melvin-bot]

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@0xmiroslav] The PR that introduced the bug has been identified. Link to the PR:
• [@0xmiroslav] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment:
• [@0xmiroslav] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion:
• [@0xmiroslav] Determine if we should create a regression test for this bug.
• [@0xmiroslav] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.
• [@laurenreidexpensify] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[laurenreidexpensify]

Payment Summary:

• External issue reporter - Applause N/A
• Contributor that fixed the issue - @ishpaul777 - $500 + $250, payment issued in Upwork
• Contributor+ that helped on the issue and/or PR - @0xmiroslav - $500 + $250, payment issued in Upwork

[laurenreidexpensify]

Wait @0xmiroslav can you confirm if it's Upwork or NewDot for payment for you? Thanks

[0xmiros]

upwork yet

[0xmiros]

• The PR that introduced the bug has been identified. Link to the PR: Implement dedicated route for CountryPicker in AddressPage #26742
• The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment: https://github.com/Expensify/App/pull/26742/files#r1376069662
• A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion: N/A
• Determine if we should create a regression test for this bug. This was caught by Applause team so no need additional regression test
• If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.