Create separate transition pages to sign the user in / out

[neil-marcellini]

Details

This PR fixes all of the transition flows from OldDot to NewDot. The transition flow has been simplified by creating separate pages for when the user is signed out / in. There was a tricky bug where the transitioning user would be signed out multiple times, which was fixed by waiting for Onyx to finish clearing after signing out the previous user and before signing in the transitioning user.

Fixed Issues

$ #8295
$ #8676
$ https://github.com/Expensify/Expensify/issues/207655

Related Issues

https://github.com/Expensify/Expensify/issues/207423
https://github.com/Expensify/Expensify/issues/202627

Tests / Web QA

On dev only:
npm i to install the latest Onyx changes, then npm run web

• A. Set up my company for free

1. Make sure you are signed out of NewDot
2. Go to OldDot with a mobile screen size and sign up with a new account
3. Click join
4. Click "Set up my company for free".
5. You should be directed to NewDot and have a new workspace created.
6. Hit the back button next to "Workspace" and verify that 1 workspace was created
7. Repeat steps 2-6 to test the case where you are signed in to a different account on NewDot

• B. Select a free workspace

1. Make sure you are signed out of NewDot
2. Go to OldDot and sign in to an account if needed
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

• C. Clicking on the name of a free policy

1. Make sure you are signed out of NewDot
2. Go to OldDot and sign in (if needed) to an account that has a free workspace / group policy
3. Go to Settings > Policies > Group and click on the name of a free workspace
4. You should be directed to NewDot and the workspace settings should open
5. Repeat steps 2-4 to test the case where you are signed in to the same account on NewDot
6. Sign in to a different account on OldDot that has a free workspace / group policy
7. Repeat steps 3-4 to test the case where you are signed in to a different account on NewDot

• D. Get Started Inbox Task

1. Make sure you are signed out of NewDot
2. Go to OldDot and sign up for a new account with an @gmail.com address
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 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

E. Pricing select free

• E.1 Creating a free policy

1. Make sure you are signed out of NewDot
2. Go to OldDot and sign in with any account
3. Go to Settings > Policies > Group, refresh the page, then delete any free group policies
4. Go to expensify.com.dev/pricing and click "Select" on the free plan
5. You should be directed to NewDot and have a new workspace created, and the workspace settings should open.
6. Hit the back button next to "Workspace" and verify that 1 workspace was created
7. Repeat steps 3-6 to test the case where you are signed in to the same account
8. Go to OldDot and sign in with a different account
9. Repeat steps 3-6 to test the case where you are signed in to a different account.

• E.2 Navigating to an existing free policy

1. Make sure you are signed out of NewDot
2. Go to OldDot and sign in with any account with free group policies
3. Go to expensify.com.dev/pricing and click "Select" on the free plan
4. You should be directed to NewDot and the workspace settings should open for some workspace.
5. Repeat steps 3-4 to test the case where you are signed in to the same account
6. Go to OldDot and sign in with a different account with free group policies
7. Repeat steps 3-4 to test the case where you are signed in to a different account.

• F. Continue setup Inbox task

1. Make sure you are signed out of NewDot
2. Go to OldDot and sign in with any account with free group policies and without a bank account set up
3. In the OldDot inbox click "Continue setup" on the inbox task that says "Finish setting up your bank account".
4. You should be directed to NewDot and the Connect bank account page should open in the right sidebar
5. Repeat steps 3-4 to test the case where you are signed in to the same account
6. Go to OldDot and sign in with a different account with free group policies and without a bank account set up
7. Repeat steps 3-4 to test the case where you are signed in to a different account.

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

Screenshots

Web

Mobile Web

Desktop

iOS

Android

[neil-marcellini]

I cherry picked the last commit from this one a while back. I never got a chance to explain it since I was OOO at the time.

Sometimes, especially on dev, the CreateLogin request to sign the user in with the short lived token is sent before the Network is ready. I don't think we want to retry this request since it could create multiple logins, so I added a param to stop it from processing immediately. By adding it to the request queue and processing later this problem is solved.

Alternatively we could make CreateLogin idempotent and let it be retried, but I think this is simpler.

Check out the logs

log.js:24 [HMR] Waiting for update signal from WDS...
index.js:89 Running application "NewExpensify" with appParams:
 Object 
Development-level warnings: ON.
Performance optimizations: OFF.
Log.js:55 [info] [Onyx] set() called for key: currentDate - ""
client:48 [WDS] Hot Module Replacement enabled.
client:52 [WDS] Live Reloading enabled.
Log.js:55 [info] [Migrate Onyx] start - ""
Log.js:55 [info] [Migrate Onyx] Skipped migration MoveToIndexedDB (Not applicable to logged out users) - ""
Log.js:55 [info] [Migrate Onyx] Skipped migration RenameActiveClientsKey - ""
Log.js:55 [info] [Migrate Onyx] Skipped migration RenamePriorityModeKey - ""
Log.js:55 [info] [Migrate Onyx] Skipped migration AddEncryptedAuthToken - ""
Log.js:55 [info] [Migrate Onyx] finished in 0ms - ""
Log.js:55 [info] [LoginWithShortLivedTokenPage] signing in the transitioning user - ""
index.js:123 Skipping request that should not be re-tried:  Object
Log.js:55 [info] [Onyx] set() called for key: account properties: error,success,loading - ""
Log.js:55 [info] [Onyx] set() called for key: activeClients properties: 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17 - ""

[marcaaron]

I don't think we want to retry this request since it could create multiple logins, so I added a param to stop it from processing immediately. By adding it to the request queue and processing later this problem is solved. Alternatively we could make CreateLogin idempotent and let it be retried, but I think this is simpler.

Just a heads up, we are overhauling the retry logic atm and won't ever be retrying CreateLogin requests at all. So, might be simpler to wait for the changes here.

OOO and changes have been made.

[neil-marcellini]

Ok, I think it might be ready to go now.

[marcaaron]

Excellent comments here.

[marcaaron]

Perfect 👏

It would be good to create a follow up to explore the single navigator navigation setup we can - but I have a feeling that will be a tough refactor.

[neil-marcellini]

I had to fix some merge conflicts. @marcaaron @roryabraham @deetergp could you all please give a review? I would love to merge this today if I get 2 approving reviews.

[melvin-bot]

@marcaaron looks like this was merged without passing tests. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

Note: Not an emergency tests passed. - Marc

[neil-marcellini]

😂 alright, thanks Marc!

[OSBotify]

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

🚀 Deployed to staging by @marcaaron in version: 1.1.72-0 🚀

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

[mvtglobally]

@neil-marcellini Since this PR requires transition between OldDot and NewDot, It is not possible for us to do the same steps on Desktop or Native apps. Is it ok to test this on Web and mWeb only or there any specific steps we should validate on Desktop or Native apps

[neil-marcellini]

You only need to test on Web for now.

[OSBotify]

🚀 Deployed to production by @yuwenmemon in version: 1.1.73-2 🚀

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