Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rerender country and state if visited via deep link #28404

Conversation

saranshbalyan-1234
Copy link
Contributor

@saranshbalyan-1234 saranshbalyan-1234 commented Sep 28, 2023

Details

Fixed State and country not rendering if visited address page via deep link

Fixed Issues

$ #27814
PROPOSAL:
$ #27814 (comment)

Tests

Same as Qa Steps

Offline tests

Same as Qa Steps

QA Steps

  1. Go to Settings -> Profile -> Personal Details -> Home address
  2. Fill all the details
  3. Log out
  4. Open https://staging.new.expensify.com/settings/profile/personal-details/address
  5. Login and verify state and country fields are populated

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
    • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
screen-recording-2023-09-28-at-14225-am_j3G9Rn4V.mp4
Mobile Web - Chrome
WhatsApp.Video.2023-09-28.at.7.08.19.AM.mp4
Mobile Web - Safari
whatsapp-video-2023-09-28-at-65801-am_rmlarL7O.mp4
Desktop
screen-recording-2023-09-28-at-112839-pm_ipK8PtYB.mp4
iOS
Android

@saranshbalyan-1234 saranshbalyan-1234 requested a review from a team as a code owner September 28, 2023 16:51
@melvin-bot melvin-bot bot requested review from eVoloshchak and removed request for a team September 28, 2023 16:51
@melvin-bot
Copy link

melvin-bot bot commented Sep 28, 2023

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

@eVoloshchak
Copy link
Contributor

eVoloshchak commented Sep 28, 2023

It's possible to test this on iOS and Android too
You can open a deep link by running this command in Terminal
npx uri-scheme open new-expensify://settings/profile/personal-details/address --ios for iOS
npx uri-scheme open new-expensify://settings/profile/personal-details/address --android for Android

To test Desktop MacOS you can

  1. Have a dev desktop app running (while logged out)
  2. Open https://new.expensify.com/settings/profile/personal-details/address in browser
  3. You'll be prompted to open the desktop app, click "Open Electron"
  4. You will be redirected to desktop app, log in as usual
  5. If you don't see the address window on the right after logging in, repeat the steps 2-3

@eVoloshchak
Copy link
Contributor

Change QA tests to

  1. Go to Settings -> Profile -> Personal Details -> Home address
  2. Fill all the details
  3. Log out
  4. Open https://staging.new.expensify.com/settings/profile/personal-details/address
  5. Login and verify state and country fields are populated

@saranshbalyan-1234
Copy link
Contributor Author

It's possible to test this on iOS and Android too You can open a deep link by running this command in Terminal npx uri-scheme open new-expensify://settings/profile/personal-details/address --ios for iOS npx uri-scheme open new-expensify://settings/profile/personal-details/address --android for Android

To test Desktop MacOS you can

  1. Have a dev desktop app running (while logged out)
  2. Open https://new.expensify.com/settings/profile/personal-details/address in browser
  3. You'll be prompted to open the desktop app, click "Open Electron"
  4. You will be redirected to desktop app, log in as usual
  5. If you don't see the address window on the right after logging in, repeat the steps 2-3

@eVoloshchak have added video for desktop now, my system is giving some error while building app for mobile right now, but i have verified already few hours ago, can we go ahead without mobile video?

src/pages/settings/Profile/PersonalDetails/AddressPage.js Outdated Show resolved Hide resolved
@@ -81,12 +80,19 @@ function AddressPage({privatePersonalDetails, route}) {
const isLoadingPersonalDetails = lodashGet(privatePersonalDetails, 'isLoading', true);
const [street1, street2] = (address.street || '').split('\n');
const [state, setState] = useState(address.state);
const [currentCountry, setCurrentCountry] = useState(PersonalDetails.getCountryISO(address.country));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some linter errors

image

@eVoloshchak
Copy link
Contributor

can we go ahead without mobile video

Generally - no, but If you won't have success with building iOS and Android - I'll help you with videos
But it should definitely work, both iOS and Android are working for me

@saranshbalyan-1234
Copy link
Contributor Author

can we go ahead without mobile video

Generally - no, but If you won't have success with building iOS and Android - I'll help you with videos

But it should definitely work, both iOS and Android are working for me

Yes, please help with videos

@saranshbalyan-1234
Copy link
Contributor Author

is there anything required from my end @eVoloshchak ?

@@ -87,6 +86,11 @@ function AddressPage({privatePersonalDetails, route}) {
* @param {Object} values - form input values
* @returns {Object} - An object containing the errors for each inputID
*/
useEffect(() => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some linter errors still
image

You can check those by running npm run lint (ignore the errors in /vendor/bundle/ruby)

src/pages/settings/Profile/PersonalDetails/AddressPage.js Outdated Show resolved Hide resolved
@@ -87,6 +86,11 @@ function AddressPage({privatePersonalDetails, route}) {
* @param {Object} values - form input values
* @returns {Object} - An object containing the errors for each inputID
*/
useEffect(() => {
if(!address) return;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still a linter error

image
Suggested change
if(!address) return;
if(!address) {
return
}

@@ -87,6 +86,11 @@ function AddressPage({privatePersonalDetails, route}) {
* @param {Object} values - form input values
* @returns {Object} - An object containing the errors for each inputID
*/
useEffect(() => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the wrong place to put useEffect, it's currently between validate function and JSdoc for the said function

It should be placed after const [state, setState] = useState(address.state); (make sure there's an empty line above and below useEffect)

Copy link
Contributor

@eVoloshchak eVoloshchak Sep 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies @techievivek, accidentally approved the PR, meant to request changes
Ignore this for now

const isLoadingPersonalDetails = lodashGet(privatePersonalDetails, 'isLoading', true);
const [street1, street2] = (address.street || '').split('\n');
const [state, setState] = useState(address.state);

useEffect(() => {
Copy link
Contributor

@eVoloshchak eVoloshchak Sep 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's misaligned and there's a space required after an if statement (same as throughout the app)

useEffect(() => {
    if (!address) {
        return 
    }
    setState(address.state);
    setCurrentCountry(address.country);
}, [address]);

@eVoloshchak
Copy link
Contributor

eVoloshchak commented Sep 29, 2023

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

Web
Screen.Recording.2023-09-29.at.20.25.44.mov
Mobile Web - Chrome
screen-20230929-203246.mp4
Mobile Web - Safari
RPReplay_Final1696012676.MP4
Desktop
Screen.Recording.2023-09-29.at.21.23.03.mov
iOS
Screen.Recording.2023-09-29.at.20.42.39.mov
Android
Screen.Recording.2023-09-29.at.21.10.51.mov

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@saranshbalyan-1234
Copy link
Contributor Author

hi @techievivek all the check have been passed now, can you please have a look?

Copy link
Contributor

@techievivek techievivek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. :shipit:

@techievivek techievivek merged commit d16686d into Expensify:main Oct 2, 2023
13 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Oct 2, 2023

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@saranshbalyan-1234
Copy link
Contributor Author

hi @techievivek i have not recieved any upwork contract for this, this is my first PR

@eVoloshchak
Copy link
Contributor

@saranshbalyan-1234, don't worry, this will be handled before/when the payment is due (7 days after PR hits production)
We use GitHub as the only source of truth, so what matters is you're assigned to the GH job

@saranshbalyan-1234
Copy link
Contributor Author

@eVoloshchak thanks for the response

@OSBotify
Copy link
Contributor

OSBotify commented Oct 2, 2023

🚀 Deployed to staging by https://github.com/techievivek in version: 1.3.76-0 🚀

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

@mountiny
Copy link
Contributor

mountiny commented Oct 3, 2023

QA raised this #27814 was still not fixed on this pr, can you please confirm @eVoloshchak @saranshbalyan-1234

@saranshbalyan-1234
Copy link
Contributor Author

Checking

@eVoloshchak
Copy link
Contributor

Cannot reproduce on staging
Is this a problem with a specific platform maybe?

@ufumerfarooq
Copy link

ufumerfarooq commented Oct 3, 2023

@eVoloshchak City field is not populating, I have checked this on web/chrome

#27814 (comment)

@OSBotify
Copy link
Contributor

OSBotify commented Oct 3, 2023

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.76-6 🚀

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

@saranshbalyan-1234
Copy link
Contributor Author

this PR caused this regression https://github.com/Expensify/App/pull/28362/files

@OSBotify
Copy link
Contributor

OSBotify commented Oct 3, 2023

🚀 Deployed to staging by https://github.com/techievivek in version: 1.3.77-0 🚀

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

@DylanDylann
Copy link
Contributor

@saranshbalyan-1234 @eVoloshchak Ping you guys because we are having the same problem with city field. I mentioned about it before @saranshbalyan-1234 raise this PR. But It seems no one paid attention to it.

@OSBotify
Copy link
Contributor

OSBotify commented Oct 5, 2023

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.77-7 🚀

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

@saranshbalyan-1234 saranshbalyan-1234 deleted the rerender-country-state-on-address-page--deep-link branch October 31, 2023 15:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants