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

[No QA] Fix mobile transitions for some emails #9469

Merged
merged 4 commits into from
Jun 27, 2022

Conversation

neil-marcellini
Copy link
Contributor

@neil-marcellini neil-marcellini commented Jun 15, 2022

Details

OldDot mobile does not encode URL parameters for the transition link. We can't fix it on OldDot mobile because we don't deploy it anymore, so this PR is a work around.

When determining if the transitioning user is logged in we compare the email in the URL param to the session email, and we also compare it to the un-encoded email extracted from the link with a regex. If both of those do not match, then we know that a new user is logging in.

Fixed Issues

$ #9426

Tests

Check out the Web-Expensify branch neil-test-mobile-transition which creates the transition link without encoding the URL params like OldDot mobile.

  1. Make sure you are signed out of NewDot
  2. Go to OldDot and sign in to an account that includes a + in the email E.x [email protected]
  3. Go to Settings > Policies > Group and note the number of free policies (or delete all of them)
  4. Click New Policy in the top right
  5. Click select on the free plan
  6. You should be directed to NewDot and have a new workspace created
  7. Hit the back button next to "Workspace" and verify that 1 additional workspace was created
  8. Repeat steps 2-7 to test the case where you are signed in to the same account on NewDot
  9. Sign in to a different account on OldDot
  10. Repeat steps 3-7 to test the case where you are signed in to a different account on NewDot

Checkout Web-Expensify branch main

  1. Run the transition tests for at least flows B and D described here with an email that includes a +.
  • 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.

Production QA / Regression Tests

Test the OldDot mobile app flows:

A. Get started inbox task

  1. Make sure you are signed out of NewDot on mobile web
  2. Go to the OldDot mobile app and sign up for a new account with a + in it and @gmail.com. E.x [email protected]
  3. Click on the "Get started" on the inbox task that says "Would you like to get started with our free plan?".
  4. You should be directed to NewDot on mobile web and have a new workspace created, and the workspace settings should open.
  5. Hit the back button next to "Workspace" and verify that 1 workspace was created
  6. Repeat steps 2-5 to test the case where you are signed in to a different account on NewDot

B. Edit a free policy

  1. Make sure you are signed out of NewDot on mobile web
  2. Go to the OldDot mobile app and sign into an account that has a free policy / workspace and includes a + in the email E.x [email protected]
  3. Click the hamburger menu (3 horizontal lines) in the upper left hand corner to open the side navigation bar
  4. Click on "Settings"
  5. Scroll down to the "Policies" section
  6. Click "View all" at the right on the first policy shown
  7. Select the "Group" tab
  8. Click "Edit" on a workspace
  9. NewDot should open on mobile web and your workspace settings should open.
  10. Repeat step 8 to test the case where you are signed into the same account on NewDot
  11. Go to the OldDot mobile app and sign into a different account that has a free policy / workspace
  12. Repeat steps 3-9 to test the case where you are signed in to a different account on NewDot
  • Verify that no errors appear in the JS console

Screenshots

N/A

@neil-marcellini neil-marcellini requested a review from a team as a code owner June 15, 2022 19:21
@neil-marcellini neil-marcellini self-assigned this Jun 15, 2022
@melvin-bot melvin-bot bot requested review from danieldoglas and removed request for a team June 15, 2022 19:21
@neil-marcellini
Copy link
Contributor Author

Updated to fix some of the logic and all the tests are passing. Ready for another review.


// If the email param matches what is stored in the session then we are
// definitely not logging in as a new user
if (paramsEmail === sessionEmail) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you confirm this handles all four cases?

  1. Unencoded new user (OldApp new user)
  2. Encoded new user (OldDot new user)
  3. Unencoded existing user (OldApp existing user)
  4. Encoded existing user (OldDot existing user)

Specifically interested in case 2? e.g. when do we return true when paramsEmail !== sessionEmail?

Copy link
Contributor Author

@neil-marcellini neil-marcellini Jun 17, 2022

Choose a reason for hiding this comment

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

  1. Unencoded new user (OldApp new user)
    The params and session emails don't match, then the linked and session emails also don't match so we correctly return true.

  2. Encoded new user (OldDot new user)
    The params and session emails don't match so we check the linked and session emails which
    also don't match so we correctly return true.

  3. Unencoded existing user (OldApp existing user)
    The params and session emails don't match, but then the linked email matches the session email so we correctly return false.

  4. Encoded existing user (OldDot existing user)
    The params and session emails match so we correctly return false.

@danieldoglas danieldoglas self-requested a review June 24, 2022 20:35
@danieldoglas
Copy link
Contributor

Code looks good to me, but I need to test it on Monday. If you've tested the flow @AndrewGable , you can merge it!

@neil-marcellini neil-marcellini merged commit 461f356 into main Jun 27, 2022
@neil-marcellini neil-marcellini deleted the neil-mobile-transition branch June 27, 2022 09:51
@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 staging by @neil-marcellini in version: 1.1.79-0 🚀

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

@kavimuru
Copy link

kavimuru commented Jun 28, 2022

@neil-marcellini , Our beta version OldDot is expired. Should we try in production app?

@sketchydroide
Copy link
Contributor

@kavimuru yes try with the AppStore version, the oldDot TestFlight is no longer active (there are nochanges and the build has eventuallly expired from its 90 days)

@neil-marcellini
Copy link
Contributor Author

Sorry @kavimuru, OldDot mobile will create a link to NewDot production so this will need to be QAed once this fix is in production. I don't think we do production QA for NewDot right? In that case we can skip QA and I will update the title to include [No QA].

@neil-marcellini neil-marcellini changed the title Fix mobile transitions for some emails [No QA] Fix mobile transitions for some emails Jun 29, 2022
@OSBotify
Copy link
Contributor

OSBotify commented Jul 8, 2022

🚀 Deployed to production by @roryabraham in version: 1.1.79-17 🚀

platform result
🤖 android 🤖 failure ❌
🖥 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.

6 participants