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

Only create 1 free workspace when transitioning #8611

Closed
wants to merge 4 commits into from

Conversation

neil-marcellini
Copy link
Contributor

@neil-marcellini neil-marcellini commented Apr 12, 2022

Details

Related Issue

$ #7617

Tests

Below are tests for all of the transition flows from Web-Expensify to NewDot. This PR specifically fixes flows A, B, and D. Once all the PRs have been merged into the feature branch we can test all of the flows, so ignore the rest for now.

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

  • 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. Go back to OldDot and go to Settings > Policies > Group
  7. Refresh the page and verify that 1 free workspace policy has been created
  8. Repeat steps 3-7 to test the case where you are signed into the same account
  9. Go to OldDot and sign in with a different account
  10. Repeat steps 3-7 to test the case where you are signed into 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 into 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 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. Go back to the OldDot inbox and refresh the page
  5. Click "Continue setup" on the inbox task that says "Finish setting up your bank account".
  6. The Connect bank account page should open in the right sidebar
  7. Sign out of NewDot
  8. Go back to OldDot
  9. Repeat steps 5-6 to test the case where you are signed out of NewDot
  10. Sign out of NewDot and sign in with a different account
  11. Repeat steps 5-6 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)
  • 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

  • Verify that no errors appear in the JS console

Screenshots

Web

Mobile Web

Desktop

iOS

Android

@neil-marcellini
Copy link
Contributor Author

Still a draft PR since I'm working on resolving this bug with flow C.

Screen.Recording.2022-04-12.at.1.54.52.PM.mov

@roryabraham
Copy link
Contributor

It looks to me like some action is finishing and probably calling Navigation.navigate to the report screen. I would do a global search for Navigation.navigate in the src/libs/actions directory and add temporary logs for all it's usages to see which one is causing the redirect. I would need to dig in some more, but at first glance I would be most suspicious of this line

@neil-marcellini
Copy link
Contributor Author

@roryabraham thanks for taking a look. I added logs for all calls to Navigation.navigate and I did not see any of my log lines in the output for this flow. I believe that the problem is really the authToken getting set to null as I mentioned in my comment on the issue. I want to figure out why that is happening. I'll try looking into the internals of Onyx.

@neil-marcellini neil-marcellini changed the base branch from main to neil-transition-flows April 18, 2022 21:06
@neil-marcellini neil-marcellini marked this pull request as ready for review April 21, 2022 16:35
@neil-marcellini neil-marcellini requested review from marcaaron and a team as code owners April 21, 2022 16:35
@melvin-bot melvin-bot bot requested review from techievivek and removed request for a team April 21, 2022 16:36
@neil-marcellini neil-marcellini self-assigned this Apr 22, 2022
@neil-marcellini neil-marcellini changed the title [HOLD 8498] Only create 1 free workspace when transitioning Only create 1 free workspace when transitioning Apr 26, 2022
@neil-marcellini
Copy link
Contributor Author

Ready for review! Please let me know if you have questions.

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 a couple questions. Looks like there's some lint errors.

network: {isOffline: true},
session: {email: null},
Copy link
Contributor

Choose a reason for hiding this comment

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

question: Is there a reason why we are using null vs. just defaulting session to an empty object?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Here we use _.isNull which will return false if email is undefined, so it could determine that we are logging in as a new user when we are not. I think that's why I did this

const isLoggingInAsNewUser = !_.isNull(this.props.session.email) && (email !== this.props.session.email);

@@ -191,6 +204,10 @@ class AuthScreens extends React.Component {
return false;
}

if (this.props.isCreatingWorkspace) {
Copy link
Contributor

Choose a reason for hiding this comment

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

@neil-marcellini Can you provide please just a quick explanation of why we need this?

It seems like the AuthScreens must be mounting twice for us to need this, but I'm unsure which events/states/user actions cause it to mount twice.

Copy link
Contributor Author

@neil-marcellini neil-marcellini Apr 26, 2022

Choose a reason for hiding this comment

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

Good point. I put up this PR before I had figured out that Onyx.clear() was resetting the session silently. I will run the tests with #8736 merged into the feature branch instead of this PR, and if it works then we won't need these changes.

create(name).then(navigateToPolicy);
create(name).then(() => {
navigateToPolicy();
Onyx.set(ONYXKEYS.IS_CREATING_WORKSPACE, false);
Copy link
Contributor

@marcaaron marcaaron Apr 26, 2022

Choose a reason for hiding this comment

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

question: Can we leave IS_CREATING_WORKSPACE in the create() call (maybe in a .finally() block)? That seems like a better place for it because anyone calling that method must remember to set IS_CREATING_WORKSPACE to false now.

suggestion: Put it back the way it was if possible or if not make the functions that call create() each set the IS_CREATING_WORKSPACE: true flag.

@neil-marcellini
Copy link
Contributor Author

neil-marcellini commented Apr 26, 2022

Testing with commits fc2f02d and b2b2eec and then everything from #8736, but rebased to drop these commits with IS_CREATING_WORKSPACE.

  • A
  • B
  • C
  • D
  • E.1
  • E.2
  • F

@neil-marcellini
Copy link
Contributor Author

Since the tests above passed without most of these changes, I'm going to close this PR and add fc2f02d to #8736.

@neil-marcellini neil-marcellini deleted the neil-get-started branch April 26, 2022 23:05
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.

None yet

3 participants