Fix/address page state navigation 2 #36770

ygshbht · 2024-02-18T07:41:27Z

Details

Fixed Issues

$ #23725
PROPOSAL: #23725 (comment)

Tests

Verify for places where you have to select an American State from a list:

For Personal Address:

Go to Profile > Address > State (with US as country)
Click back button of device
Notice it Properly navigates to Home address screen

For debit card page:

Go to /settings/wallet/add-debit-card or /send/new/add-debit-card > State
Click back button of device
Notice it properly navigates to Debit card screen

For ReimbusementAccountPage

Select a Workspace > Settings > Bank Account
Verify for all State Selectors you see in the flow (e.g Company Address, Incorporation State, etc.)

1. Click back button of device when in respective StateSelectionPages
1. Notice it properly navigates to previous screen
Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

Same as tests

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

Web

output_web.mp4

Mobile Web - Chrome

output_android.chrome.mp4

Mobile Web - Safari

output_ios.safari.mp4

Desktop

output_desktop.mp4

iOS

output_ios.mp4

Android

trimmed_output_android.mp4

…vigation

Co-authored-by: Rajat Parashar <parasharrajat@users.noreply.github.com>

melvin-bot · 2024-02-18T07:41:31Z

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

parasharrajat · 2024-03-22T22:48:23Z

@mountiny Could you please help us decide the next steps here?

ygshbht · 2024-03-23T12:18:49Z

@parasharrajat When you used StateSelector, and didnt select any country, it didnt show any error, which i have fixed through this 2619a29 commit following the same logic as CountrySelector, like it is production. I have also refactored the code in StateSelector by removing the local state (react state) for the state (geographical state)

ygshbht · 2024-03-25T00:51:26Z

@parasharrajat, I have been studying various parts of the repository to address the problems and merge this long-standing issue as soon as possible. As demonstrated in the video, a similar page, PronounPage, which also utilizes SelectionList, exhibits the same issue when I make those unrelated edits. From my observation, SelectionList attempts to match the scroll position of the previous SelectionList. Thus, in instances where you select United States, which is located towards the bottom of the CountrySelector list of 150 items (not using the search input, as it shortens the list), and then attempt to use StateSelector (with about 50 states), the list scrolls to the bottom, showing the last states (or directly errors out if shouldUseDynamicMaxToRenderPerBatch is also used). Therefore, if you mimic the PronounPage solution by simply adding an empty View, it resolves our problem without introducing side effects.

profilepage.mp4

…ultiple times

ygshbht · 2024-03-25T00:58:50Z

@parasharrajat I have pushed the patch in 4efccc0.

patch.mp4

parasharrajat · 2024-03-25T14:45:47Z

I will test it.

mountiny · 2024-03-25T22:14:58Z

Sorry I was ooo, I think that the latest comment suggests @ygshbht found a solution to this issue. @parasharrajat can you please test if that is working as expected tomorrow? thank you!

mountiny · 2024-03-28T11:34:25Z

@ygshbht Can you please resolve conflicts?

@parasharrajat can you conclude the testing please?

parasharrajat · 2024-03-28T16:54:01Z

Testing in 40 mins.

parasharrajat · 2024-03-29T11:19:24Z

src/components/StateSelector.tsx

+ useEffect(() => {
+ if (isFocused && didOpenStateSelector.current) {
+ didOpenStateSelector.current = false;
+ if (!stateFromUrl) {
+ onBlur?.();
+ }
+ }
+
+ if (!stateFromUrl) {
+ return;
+ }
+
+ // This will cause the form to revalidate and remove any error related to country name
+ if (onInputChange) {
+ onInputChange(stateFromUrl);
+ }
+
+ Navigation.setParams({state: undefined});
+
+ // eslint-disable-next-line react-hooks/exhaustive-deps
+ }, [stateFromUrl, onBlur, isFocused]);
+
+ const title = stateCode && Object.keys(COMMON_CONST.STATES).includes(stateCode) ? translate(`allStates.${stateCode}.stateName`) : '';


I am trying to understand the usages of state from URL stateFromUrl and state as a direct prop stateCode.

Here the title is calculated form the stateCode from prop value. What about the value that is coming from URL? We are dependent on onInputChange to pass back the URL value as prop. What if this component is not used in the Form and we don't have onInputChange handler which updates the prop value. Will this component work?

If this is the case, we are creating an incomplete error-prone component.

Yes, it won't work if not used within form. But I suppose since it in an input component, it will always be used inside a form. Do you want it to be more independent, generic, futureproof, and have its own state?

Currently it is not used without a Form and If it is used as a standalone component, it can always be wrapped around a Form like IncorporationStateBusiness. Or the devs can modify the code as per their needs. For current uses and its intended purpose, do you think it still needs a local state?

Current StatePicker too doesnt have local state. Since we're just mimicking its functionality, do you still think we need to worry about local state?

Ok, I am fine with its current state and it can be modified later if needed. But let's add explanatory comments to the logic above to explain what's going on in the effect and how this component is working.

Sure, done.

parasharrajat · 2024-04-01T10:32:07Z

Screenshots

🔲 iOS / native

Screen.Recording.2024-04-01.at.3.46.20.PM.mov

🔲 iOS / Safari

Screen.Recording.2024-04-01.at.3.48.49.PM.mov

🔲 MacOS / Desktop

Screen.Recording.2024-04-01.at.3.42.14.PM.mov

🔲 MacOS / Chrome

Screen.Recording.2024-04-01.at.3.39.46.PM.mov

🔲 Android / Chrome

Screen.Recording.2024-04-01.at.3.58.33.PM.mov

🔲 Android / native

Screen.Recording.2024-04-01.at.3.52.20.PM.mov

parasharrajat

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(theme.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 the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
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.

🎀 👀 🎀 C+ reviewed

parasharrajat · 2024-04-01T19:12:10Z

@mountiny Ready for review.

mountiny

Been a long journey, I wont hold this for longer, thank you very much for pushing this ahead

mountiny · 2024-04-02T22:19:33Z

src/components/StateSelector.tsx

+ /** Callback to call when the picker modal is dismissed */
+ onBlur?: () => void;
+
+ /** object to get route details from */


NAB

Suggested change

/** object to get route details from */

/** Object to get route details from */

mountiny · 2024-04-02T22:21:08Z

src/pages/settings/Profile/PersonalDetails/StateSelectionPage.tsx

+ if (navigation.getState()?.routes.length === 1) {
+ // If this is the only page in the navigation stack (examples include direct navigation to this page via URL or page reload).
+ if (_.isEmpty(backTo)) {
+ // No "backTo": default back navigation.


NAB: I think some of these comments might not have been needed

Suggested change

// No "backTo": default back navigation.

mountiny · 2024-04-02T22:24:12Z

Thank you for patience and good work @ygshbht @parasharrajat 🙌

OSBotify · 2024-04-08T10:53:59Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.60-13 🚀

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

ygshbht and others added 27 commits October 7, 2023 12:53

Convert StatePicker modal to StateSelection page

cd8ca07

Incorporation state resets bugfix

1284e59

Modify pages to accomodate for StateSelection

963cf67

Merge https://github.com/Expensify/App into fix/address-page-state-na…

1305561

…vigation

Refactor to use useGeographicalStateFromRoute hook

16ba084

move getStateFromRoute to useGeographicalStateFromRoute

0f83cff

Add displayname to StateSelectorWithRef

0951d5d

Merge https://github.com/Expensify/App into fix/address-page-state-na…

3b88d46

…vigation

Fix AddressPage: State not changing on autocomplete

598c7c6

Refactor StateSelector logic

4a21636

Refactor AddressPage

312d0c6

linting fixes StateSelector

8a293b5

linting

c946cbb

StateSelector and related files refactoring

144eea9

Merge https://github.com/Expensify/App into fix/address-page-state-na…

d2848d3

…vigation

Fix incorrect merge

17f2aab

Reverted scripts/shellCheck.sh to state at 33f15e8

9fb4f72

Linting

d6a643c

Merge https://github.com/Expensify/App into fix/address-page-state-na…

080285a

…vigation

Comment formatting src/hooks/useGeographicalStateFromRoute.ts

9bb88ee

Co-authored-by: Rajat Parashar <parasharrajat@users.noreply.github.com>

Rename useStateFomrUrl to shouldUseStateFromUrl

5e38447

forwardedRef type correction StateSelector

470ec03

StateSelector: rename paramName to queryParam

8f28580

Remove lodashGet from useGeographicalStateFromRoute

7be20b3

StateSelectionPage appendParam restructuring

428e48c

Prettier formatting

7cd8b6f

Merge branch 'main' into fix/address-page-state-navigation-2

5a02b71

ygshbht requested a review from a team as a code owner February 18, 2024 07:41

melvin-bot bot removed the request for review from a team February 18, 2024 07:41

ygshbht added 2 commits March 23, 2024 15:47

Merge branch 'main' into fix/address-page-state-navigation-2

24cbec3

Fix: Inconsistent validation error for required field in home address

2619a29

Remove unused code: StateSelector

f48a7fc

StateSelectionPage: Fix issue of page crash when country is changed m…

4efccc0

…ultiple times

ygshbht added 3 commits March 25, 2024 06:42

es lint comment formatting

b9fe092

eslint Formatting fix

5f0cc47

prettier

3585296

Merge branch 'main' into fix/address-page-state-navigation-2

639a646

parasharrajat reviewed Mar 29, 2024

View reviewed changes

ygshbht added 2 commits March 30, 2024 04:51

Merge branch 'main' into fix/address-page-state-navigation-2

7e81480

Add explanatory comments to StateSelector

3f87bf2

parasharrajat approved these changes Apr 1, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny April 1, 2024 10:32

mountiny approved these changes Apr 2, 2024

View reviewed changes

mountiny merged commit ed59db2 into Expensify:main Apr 2, 2024
19 checks passed

github-actions bot mentioned this pull request Apr 4, 2024

[INCORRECT] (used to be a checklist but was incorrectly triggered) #39573

Closed

44 tasks

mountiny mentioned this pull request Apr 4, 2024

Deploy Checklist: New Expensify 2024-04-04 #39588

Closed

48 tasks

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

[HOLD for payment 2024-04-15] [$750] mWeb - Click on back button from country picker page redirects to wrong page #23725

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix/address page state navigation 2 #36770

Fix/address page state navigation 2 #36770

ygshbht commented Feb 18, 2024 •

edited

Loading

melvin-bot bot commented Feb 18, 2024

parasharrajat commented Mar 22, 2024

ygshbht commented Mar 23, 2024 •

edited

Loading

ygshbht commented Mar 25, 2024 •

edited

Loading

ygshbht commented Mar 25, 2024

parasharrajat commented Mar 25, 2024

mountiny commented Mar 25, 2024

mountiny commented Mar 28, 2024

parasharrajat commented Mar 28, 2024

parasharrajat Mar 29, 2024 •

edited

Loading

ygshbht Mar 29, 2024

ygshbht Mar 29, 2024

ygshbht Mar 29, 2024

parasharrajat Mar 29, 2024

ygshbht Mar 29, 2024 •

edited

Loading

parasharrajat commented Apr 1, 2024

parasharrajat left a comment

parasharrajat commented Apr 1, 2024

mountiny left a comment

mountiny Apr 2, 2024

mountiny Apr 2, 2024

mountiny commented Apr 2, 2024

OSBotify commented Apr 8, 2024

	/** object to get route details from */
	/** Object to get route details from */

Fix/address page state navigation 2 #36770

Fix/address page state navigation 2 #36770

Conversation

ygshbht commented Feb 18, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 18, 2024

parasharrajat commented Mar 22, 2024

ygshbht commented Mar 23, 2024 • edited Loading

ygshbht commented Mar 25, 2024 • edited Loading

ygshbht commented Mar 25, 2024

parasharrajat commented Mar 25, 2024

mountiny commented Mar 25, 2024

mountiny commented Mar 28, 2024

parasharrajat commented Mar 28, 2024

parasharrajat Mar 29, 2024 • edited Loading

Choose a reason for hiding this comment

ygshbht Mar 29, 2024

Choose a reason for hiding this comment

ygshbht Mar 29, 2024

Choose a reason for hiding this comment

ygshbht Mar 29, 2024

Choose a reason for hiding this comment

parasharrajat Mar 29, 2024

Choose a reason for hiding this comment

ygshbht Mar 29, 2024 • edited Loading

Choose a reason for hiding this comment

parasharrajat commented Apr 1, 2024

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

parasharrajat commented Apr 1, 2024

mountiny left a comment

Choose a reason for hiding this comment

mountiny Apr 2, 2024

Choose a reason for hiding this comment

mountiny Apr 2, 2024

Choose a reason for hiding this comment

mountiny commented Apr 2, 2024

OSBotify commented Apr 8, 2024

ygshbht commented Feb 18, 2024 •

edited

Loading

ygshbht commented Mar 23, 2024 •

edited

Loading

ygshbht commented Mar 25, 2024 •

edited

Loading

parasharrajat Mar 29, 2024 •

edited

Loading

ygshbht Mar 29, 2024 •

edited

Loading