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

Refactor getUserDetails in App #9697

Merged
merged 3 commits into from
Jul 15, 2022
Merged

Conversation

luacmartins
Copy link
Contributor

@luacmartins luacmartins commented Jul 5, 2022

Details

Removes getUserDetails from App init since it's returned by OpenApp and ReconnectApp now.

Holding on prod deploy for https://github.com/Expensify/Web-Expensify/pull/34294

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/213880

Tests

  1. Open the browser console
  2. Sign in to the App
  3. Verify that you see a call to OpenApp and it returns the loginList, user and the NVPs below:
  • nvp_paypalMeAddress
  • preferredEmojiSkinTone
  • frequentlyUsedEmojis
  • private_blockedFromConcierge
  1. In the Network tab, set the App to offline and then back online
  2. Verify that a call to ReconnectApp is triggered and that the data above is returned.
  • Verify that no errors appear in the JS console

PR Review Checklist

Contributor (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 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 included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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
  • 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 */
    • Any functional components have the displayName property
    • 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
  • 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.

PR Reviewer Checklist

  • 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 verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 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 */
    • Any functional components have the displayName property
    • 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 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.

QA Steps

  1. Create an account
  2. Login to the App
  3. Verify that you can see your logins in Settings > Profile > Email address / Phone number
  4. Verify that your preferred emoji skin tone is set to default (yellow)
  5. Verify that your frequently used emojis are empty
  6. Verify that your PayPalMe address is empty
  7. Verify that your Settings > Preferences > Notifications is not subscribed
  • Verify that no errors appear in the JS console

Screenshots

Web

web.mov

Mobile Web

Desktop

iOS

Android

@luacmartins luacmartins self-assigned this Jul 5, 2022
@luacmartins luacmartins force-pushed the cmartins-refactorGetUserDetails branch from 5d24379 to 92416ec Compare July 7, 2022 00:22
@luacmartins luacmartins changed the title [HOLD #34214] Refactor getUserDetails in App [HOLD Web-E #34214 and App #9764] Refactor getUserDetails in App Jul 7, 2022
@neil-marcellini neil-marcellini self-requested a review July 12, 2022 15:32
@neil-marcellini
Copy link
Contributor

I'll review this too since I reviewed the Web PR.

@luacmartins luacmartins marked this pull request as ready for review July 12, 2022 17:35
@luacmartins luacmartins requested a review from a team as a code owner July 12, 2022 17:35
@melvin-bot melvin-bot bot requested review from srikarparsi and removed request for a team July 12, 2022 17:36
@luacmartins luacmartins force-pushed the cmartins-refactorGetUserDetails branch from 84f3ff3 to af39ed0 Compare July 13, 2022 00:27
@luacmartins
Copy link
Contributor Author

luacmartins commented Jul 13, 2022

This is ready for review. Just waiting for Web-E PR to be deployed to prod (hopefully tomorrow Jul 13) so we can merge this.

@luacmartins luacmartins changed the title [HOLD Web-E #34214 and App #9764] Refactor getUserDetails in App [HOLD Web-E #34214] Refactor getUserDetails in App Jul 13, 2022
@neil-marcellini
Copy link
Contributor

I think for the QA steps it would be better to create a new account and then verify that the login list and NVPs are set to the defaults. It might not be clear what "set correctly" means to the person running QA.

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

It looks like the new OpenApp and ReconnectApp commands are working well!

There were some subtle differences with the returned Onyx keys / expected NVPs in the test steps:

  • PAYPAL_ME_ADDRESS -> NVP_PAYPAL_ME_ADDRESS
  • NVP_PREFERRED_EMOJI_SKIN_TONE -> PREFERRED_EMOJI_SKIN_TONE
  • NVP_FREQUENTLY_USED_EMOJIS -> FREQUENTLY_USED_EMOJIS

I don't know if you want to update the Onyx keys to be more consistent about prefixing them with NVP_, so it's probably best to just update the test steps.

It looks like my frequently used emojis are duplicated now. My guess is that the problem occurs because we merge on a list value, which I believe just appends to the end. Sounds like a backend fix, sorry I didn't catch it there.
image

PR Reviewer Checklist

  • 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 verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 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 */
    • Any functional components have the displayName property
    • 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 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.

@luacmartins luacmartins changed the title [HOLD Web-E #34214] Refactor getUserDetails in App [HOLD Web-E #34294] Refactor getUserDetails in App Jul 13, 2022
@luacmartins
Copy link
Contributor Author

Thanks for the thorough review @neil-marcellini! I put up a PR to fix for the frequently used emojis issue and updated the nvp names in the test steps.

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Thanks for updating the test steps. Could you also please update the QA steps as I mentioned? Web-E #34294 is merged and this will be good to go once that is deployed.

@luacmartins
Copy link
Contributor Author

Updated the QA steps as well! Thanks!

@marcaaron
Copy link
Contributor

Can we remove the HOLD on this one?

@neil-marcellini
Copy link
Contributor

@marcaaron the frequently used emojis will be broken if this is deployed before https://github.com/Expensify/Web-Expensify/pull/34294. If we merge this now, would that happen or would Web be deployed first?

@marcaaron
Copy link
Contributor

marcaaron commented Jul 13, 2022

Ah ok, thank you! I missed it and just saw the Web-E PR (original one) was on production while skimming through issues.

Copy link
Contributor

@srikarparsi srikarparsi 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!

@luacmartins
Copy link
Contributor Author

luacmartins commented Jul 15, 2022

Actually, it seems that frequently used emojis are already duplicated 🤦 😅 . That makes sense since App already processes the response from OpenApp/ReconnectApp and we send an incorrect response using merge instead of set in Web-E. So this PR can be merged!

This bug will be fixed on the next Web-E deploy when this goes to prod.

@luacmartins luacmartins changed the title [HOLD Web-E #34294] Refactor getUserDetails in App Refactor getUserDetails in App Jul 15, 2022
@luacmartins luacmartins merged commit 454fbd2 into main Jul 15, 2022
@luacmartins luacmartins deleted the cmartins-refactorGetUserDetails branch July 15, 2022 19:04
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to production by @luacmartins in version: 1.1.85-8 🚀

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

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.

5 participants