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

Sign in, out, or navigate on transition mount #8257

Merged
merged 14 commits into from
Mar 23, 2022
Merged

Conversation

neil-marcellini
Copy link
Contributor

@neil-marcellini neil-marcellini commented Mar 21, 2022

Details

Fix endless loading on the transition page by navigating at the end of componentDidMount.

Fixed Issues

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

Tests

Below are tests for all of the transition flows from Web-Expensify to NewDot. I have outlined all of the flows here, but I have only included tests for the Web. The mobile flows haven't worked for a while, as far as I can tell, so I think those should be fixed in a follow up issue.

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. Repeat steps 2-5 to test the case where you are signed into 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 click New Policy in the top right
  4. Click select on the free plan
  5. You should be directed to NewDot and have a new workspace created.
  6. Repeat steps 2-5 to test the case where you are signed in to the same account on NewDot
  7. Sign in to a different account on OldDot
  8. Repeat steps 3-5 to test the case where you are signed into 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 into a different account on NewDot

This flow is a bit slow and will sometimes show a blank page for a little while.

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. Go back to OldDot and go to Settings > Policies > Group
  6. Refresh the page and verify that 1 free workspace policy has been created
  7. Repeat steps 2-6 to test the case where you are signed into a different account on NewDot

E. Pricing select free

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

F. Continue setup Inbox task

  1. Go to OldDot and sign up for a new account with an @gmail.com address
  2. Click on the "Get started" on the inbox task that says "Would you like to get started with our free plan?".
  3. You should be directed to NewDot and have a new workspace created, and the workspace settings should open.
  4. Sign out of NewDot
  5. Go back to the OldDot inbox and refresh the page
  6. Click "Continue setup" on the inbox task that says "Finish setting up your bank account".
  7. The Connect bank account page should open in the right sidebar
  8. Sign out of NewDot
  9. Go back to OldDot
  10. Repeat steps 6-7 to test the case where you are signed out of NewDot
  11. Sign out of NewDot and sign in with a different account
  12. Repeat steps 6-7 to test the case where you are signed into a different account on NewDot
  • 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)

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 other components are not impacted by changes in this PR (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 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)

QA Steps

Same as above but on staging.

  • Verify that no new errors appear in the JS console

Screenshots

Web

Mobile Web

Desktop

iOS

Android

@neil-marcellini neil-marcellini self-assigned this Mar 21, 2022
@iwiznia iwiznia requested a review from a team March 21, 2022 19:35
@melvin-bot melvin-bot bot requested review from AndrewGable and removed request for a team March 21, 2022 19:35
@iwiznia
Copy link
Contributor

iwiznia commented Mar 21, 2022

(sorry was doing a test of puller bear, removing @AndrewGable as reviewer)

@iwiznia iwiznia removed the request for review from AndrewGable March 21, 2022 19:37
Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

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

Interesting.. so no componentDidUpdate() at all? Does it work? If so - I like it.

@neil-marcellini neil-marcellini marked this pull request as ready for review March 22, 2022 21:33
@neil-marcellini neil-marcellini requested a review from a team as a code owner March 22, 2022 21:33
@melvin-bot melvin-bot bot requested review from sketchydroide and removed request for a team March 22, 2022 21:33
Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

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

Just asking some questions and trying to understand the changes for now. Will do a proper review / test after.

src/libs/Navigation/AppNavigator/MainDrawerNavigator.js Outdated Show resolved Hide resolved
@@ -188,6 +189,7 @@ function createTemporaryLogin(authToken, email) {
partnerUserSecret: autoGeneratedPassword,
shouldRetry: false,
forceNetworkRequest: true,
shouldProcessImmediately,
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here - I'm having trouble seeing how this is connected to the transition stuff.

Copy link
Contributor

Choose a reason for hiding this comment

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

Removed this code and it doesn't seem to impact anything.

src/libs/Growl.js Outdated Show resolved Hide resolved
@marcaaron
Copy link
Contributor

Gonna jump in and add some commits here and do some testing @roryabraham

@marcaaron
Copy link
Contributor

Looks like test steps are failing for me when logged in with a pre-existing different account for the first set of steps "A" "Setup my workspace from OldDot".

@marcaaron
Copy link
Contributor

Oh actually it's because of a dev quirk. A call to Push_Authenticate makes the API return 404 because of the Referrer-Policy header.

@marcaaron
Copy link
Contributor

For "Continue Setup" steps there's a super annoying bug where if you dismiss the bank account modal you get redirected to OldDot. I don't think that was introduced here though, but it's kinda of 🥔

@marcaaron
Copy link
Contributor

marcaaron commented Mar 23, 2022

Keeping track of the testing.. so far everything's good for the first and last test...

  • A
  • B
  • C
  • D
  • E
  • F

@marcaaron
Copy link
Contributor

I think we should also test all three cases here...

  • Logged in as same user in NewDot
  • Logged in as different user in NewDot
  • Not logged in at all on NewDot

As they are all slightly different.

@marcaaron
Copy link
Contributor

Adding some logs to make testing/debugging easier.

@@ -68,7 +68,9 @@ function show({routes, toggleCreateMenu}) {
// If we are rendering the SidebarScreen at the same time as a workspace route that means we've already created a workspace via workspace/new and should not open the global
// create menu right now.
const topRouteName = lodashGet(_.last(routes), 'name', '');
const isDisplayingWorkspaceRoute = topRouteName.toLowerCase().includes('workspace');
const loginWithShortLivedTokenRoute = _.find(routes, route => route.name === 'LogInWithShortLivedToken');
const exitingToWorkspaceRoute = lodashGet(loginWithShortLivedTokenRoute, 'params.exitTo', '') === 'workspace/new';
Copy link
Contributor

Choose a reason for hiding this comment

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

Added this otherwise we would pop open the create menu in some contexts. I guess the top route is not always "workspace" and sometimes still the LoginWithShortLivedToken page.

@roryabraham
Copy link
Contributor

I'm up-to-date on this branch and just tested:

  1. Sign into account A on NewDot
  2. Sign into account B on OldDot, where account B has an existing workspace
  3. Go to Settings -> Policies and click on the workspace

And it correctly logged out account A and logged in account B, but it did not open the existing workspace

@marcaaron
Copy link
Contributor

Cool. Lemme re-test that flow. Share logs if can.

@roryabraham
Copy link
Contributor

image

@marcaaron
Copy link
Contributor

It's working for me 😄

2022-03-23_13-17-18.mp4

@marcaaron
Copy link
Contributor

Seems good to go from my end. Gonna do another round of tests in a bit.

@roryabraham
Copy link
Contributor

Screen.Recording.2022-03-23.at.4.21.45.PM.mov

Maybe a race condition because it doesn't seem to be working for me 😕

Copy link
Contributor

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

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

Thought about it some more and if this inconsistently reproducible bug is the only one left, then we should just merge this and address it with a follow-up. I'm going to be offline until tomorrow but going to approve this so it's mergeable.

@marcaaron
Copy link
Contributor

Cool. Seems like this is blocking the deploy. If so we can add a CP staging to it (though the flow breaking on the Growl might still be affected) will retest once it hits and try to check it off.

@github-actions
Copy link
Contributor

⚠️ ⚠️ Heads up! This pull request has the CP Staging label. ⚠️ ⚠️
Merging it will cause it to be immediately deployed to staging, even if the open StagingDeployCash deploy checklist is locked.

@marcaaron marcaaron merged commit cea6cf0 into main Mar 23, 2022
@marcaaron marcaaron deleted the neil-setup-transition branch March 23, 2022 23:53
OSBotify pushed a commit that referenced this pull request Mar 24, 2022
Sign in, out, or navigate on transition mount

(cherry picked from commit cea6cf0)
OSBotify added a commit that referenced this pull request Mar 24, 2022
@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by @marcaaron in version: 1.1.44-4 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

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