Fix hint inconsistent zipcode format #17144

getusha · 2023-04-07T19:46:55Z

Details

Fixed Issues

$ #16912
PROPOSAL: #16912 (comment)

Tests

Open the app
Go to settings
Go to Personal Information and search for any location
Notice that below the zip code field
Now go to any workspace. Go to connect bank account page
Verify that the zip code field samples starts with e.g. and consistent across the pages.

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

Screen.Recording.2023-04-07.at.10.50.57.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-04-07.at.10.50.57.AM.1.mov

Mobile Web - Safari

Screen.Recording.2023-04-07.at.11.18.44.AM.mov

Desktop

Screen.Recording.2023-04-07.at.11.28.08.AM.mov

iOS

Screen.Recording.2023-04-07.at.11.58.24.AM.mov

Android

Screen.Recording.2023-04-07.at.12.14.52.PM.mov

…use custom formatter

MelvinBot · 2023-04-07T19:47:01Z

@puneetlath @rushatgabhane 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]

rushatgabhane · 2023-04-10T08:04:23Z

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

rushatgabhane · 2023-04-10T10:12:41Z

src/pages/ReimbursementAccount/AddressForm.js

@@ -139,7 +139,7 @@ const AddressForm = props => (
            onChangeText={value => props.onFieldChange({zipCode: value})}
            errorText={props.errors.zipCode ? props.translate('bankAccount.error.zipCode') : ''}
            maxLength={CONST.BANK_ACCOUNT.MAX_LENGTH.ZIP_CODE}
-            hint={props.translate('common.zipCodeExample')}
+            hint={props.translate('common.format', {zipSampleFormat: CONST.COUNTRY_ZIP_REGEX_DATA.US.samples})}


@getusha should we use samples based on the country? (similar to AddressPage)

@rushatgabhane i don't think i see country picker on these places.

rushatgabhane · 2023-04-10T10:14:55Z

src/pages/ReimbursementAccount/AddressForm.js

@@ -139,7 +139,7 @@ const AddressForm = props => (
            onChangeText={value => props.onFieldChange({zipCode: value})}
            errorText={props.errors.zipCode ? props.translate('bankAccount.error.zipCode') : ''}
            maxLength={CONST.BANK_ACCOUNT.MAX_LENGTH.ZIP_CODE}
-            hint={props.translate('common.zipCodeExample')}
+            hint={props.translate('common.format', {zipSampleFormat: CONST.COUNTRY_ZIP_REGEX_DATA.US.samples})}


Bug: On Home Adress page, there is no hint displayed by default.
It only appears when you use address search to select an address.

@rushatgabhane i can reproduce the same on prod. can you add more details?

getusha · 2023-04-10T15:01:55Z

@rushatgabhane AddressForm doesn't have a place to pick/get a country it uses us as default, i am going to ask this on slack.

getusha · 2023-04-10T16:06:25Z

@rushatgabhane Pushed changes! can you check it?

rushatgabhane

@puneetlath LGTM!

puneetlath

Looks good. Just a couple small comments.

src/languages/en.js

puneetlath · 2023-04-11T13:41:33Z

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

-        const zipSampleFormat = lodashGet(CONST.COUNTRY_ZIP_REGEX_DATA, [currentCountry, 'samples'], '');
+        const currentCountry = lodashGet(this.props.privatePersonalDetails, 'address.country') || '';
+        const currentCountryISO = PersonalDetails.getCountryISO(currentCountry);
+        const targetCountryISO = !_.isEmpty(currentCountryISO) ? currentCountryISO : CONST.COUNTRY.US;


Could we combine these two lines like so?

Suggested change

const targetCountryISO = !_.isEmpty(currentCountryISO) ? currentCountryISO : CONST.COUNTRY.US;

const currentCountryISO = PersonalDetails.getCountryISO(currentCountry) || CONST.COUNTRY.US;

I think if we change to this it will show empty hint

Open the Home Details page

Pick a country

Close the drawer

and come back
because currentCountry will be defined in that case.

Interesting. Why is that?

@puneetlath's code suggestion is logically the same, right?

@rushatgabhane i think i tested the wrong file, the issue is not appearing after applying the suggestion. is it? i will push the suggestion now.

resolved can you check? @puneetlath

getusha · 2023-04-11T15:38:26Z

@puneetlath updated the generic name from format to zipCodeExampleFormat the new name sounds great! can you take a look? thank you.

puneetlath

Looks good to me. Before I merge - I just want to double-check that we've re-tested since updating?

getusha · 2023-04-11T17:47:50Z

☑️ Web

Screen.Recording.2023-04-11.at.10.15.52.AM.mov

☑️ Mobile Web - Safari

Screen.Recording.2023-04-11.at.10.19.43.AM.mov

☑️ Mobile Web - Chrome

Screen.Recording.2023-04-11.at.10.26.57.AM.mov

☑️ IOS

Screen.Recording.2023-04-11.at.10.36.32.AM.mov

Tested on different platforms and without any issue @puneetlath

OSBotify · 2023-04-11T21:25:32Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.2.99-0 🚀

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

OSBotify · 2023-04-13T03:01:32Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.2.99-6 🚀

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

use e.g. instead of Format: and deprecate common.zipCodeExample then …

7608c7e

…use custom formatter

getusha requested a review from a team as a code owner April 7, 2023 19:46

melvin-bot bot requested review from puneetlath and rushatgabhane and removed request for a team April 7, 2023 19:46

remove zipCodeExample from es.js

1e88317

rushatgabhane suggested changes Apr 10, 2023

View reviewed changes

Milos213 mentioned this pull request Apr 10, 2023

[HOLD for payment 2023-04-20] [$1000] Inconsistency hint text for zipcode on home address page vs the connect bank account page #16912

Closed

6 tasks

Improve hint display and show US if no country selected.

c61e0be

rushatgabhane previously approved these changes Apr 10, 2023

View reviewed changes

puneetlath previously approved these changes Apr 11, 2023

View reviewed changes

getusha added 2 commits April 11, 2023 08:35

update generic zipcode format variable name

151fc05

update format usage to zipCodeExampleFormat

049ebdf

getusha dismissed stale reviews from puneetlath and rushatgabhane via 049ebdf April 11, 2023 15:37

simplify code currentCountryISO

acd2231

puneetlath approved these changes Apr 11, 2023

View reviewed changes

puneetlath merged commit ae65795 into Expensify:main Apr 11, 2023

OSBotify mentioned this pull request Apr 11, 2023

Deploy Checklist: New Expensify 2023-04-11 #17298

Closed

26 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix hint inconsistent zipcode format #17144

Fix hint inconsistent zipcode format #17144

getusha commented Apr 7, 2023

MelvinBot commented Apr 7, 2023

rushatgabhane commented Apr 10, 2023 •

edited

Loading

rushatgabhane Apr 10, 2023

getusha Apr 10, 2023

rushatgabhane Apr 10, 2023

rushatgabhane Apr 10, 2023 •

edited

Loading

getusha Apr 10, 2023

rushatgabhane Apr 10, 2023

getusha commented Apr 10, 2023

getusha commented Apr 10, 2023

rushatgabhane left a comment

puneetlath left a comment

puneetlath Apr 11, 2023

getusha Apr 11, 2023

rushatgabhane Apr 11, 2023 •

edited

Loading

getusha Apr 11, 2023

getusha Apr 11, 2023

getusha commented Apr 11, 2023

puneetlath left a comment

getusha commented Apr 11, 2023

OSBotify commented Apr 11, 2023

OSBotify commented Apr 13, 2023

	const targetCountryISO = !_.isEmpty(currentCountryISO) ? currentCountryISO : CONST.COUNTRY.US;
	const currentCountryISO = PersonalDetails.getCountryISO(currentCountry) \|\| CONST.COUNTRY.US;

Fix hint inconsistent zipcode format #17144

Fix hint inconsistent zipcode format #17144

Conversation

getusha commented Apr 7, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Apr 7, 2023

rushatgabhane commented Apr 10, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rushatgabhane Apr 10, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

getusha commented Apr 10, 2023

getusha commented Apr 10, 2023

rushatgabhane left a comment

Choose a reason for hiding this comment

puneetlath left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rushatgabhane Apr 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

getusha commented Apr 11, 2023

puneetlath left a comment

Choose a reason for hiding this comment

getusha commented Apr 11, 2023

OSBotify commented Apr 11, 2023

OSBotify commented Apr 13, 2023

rushatgabhane commented Apr 10, 2023 •

edited

Loading

rushatgabhane Apr 10, 2023 •

edited

Loading

rushatgabhane Apr 11, 2023 •

edited

Loading