Skip to content

[CP Staging] Fix - A Follow up on [CRITICAL] Multiple workspaces get created when someone either refreshes the page, or drops off and returns later.#53093

Merged
mountiny merged 6 commits intoExpensify:mainfrom
FitseTLT:fix-onboarding-policy-creation-bug
Nov 28, 2024

Conversation

@FitseTLT
Copy link
Copy Markdown
Contributor

@FitseTLT FitseTLT commented Nov 25, 2024

Details

Fixed Issues

$ #52894
PROPOSAL: #52894 (comment)

Tests

  1. Sign-up on expensify.com
  2. Choose the “1-9” option on the home page (signUpQualifier: vsb)
  3. Get redirected to new.expensify.com
  4. Observe a workspace is created
  5. Don’t complete the onboarding modal steps (hasCompletedGuidedSetupFlow: false)
  6. Refresh the page on web or close and re-open app on native
  7. Verify that another workspace is not created
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Same as above

  • Verify that no errors appear in the JS console

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 the expected offline behavior in the Offline steps 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • 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 is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review 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
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • 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 code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • 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.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
a.mp4
Android: mWeb Chrome
aw.mp4
iOS: Native
i.mp4
iOS: mWeb Safari
iw.mp4
MacOS: Chrome / Safari
w.mp4
MacOS: Desktop
2024-11-26.01-31-44.mp4

@FitseTLT FitseTLT requested a review from a team as a code owner November 25, 2024 22:19
@melvin-bot melvin-bot bot requested a review from jayeshmangwani November 25, 2024 22:19
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Nov 25, 2024

@jayeshmangwani Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@melvin-bot melvin-bot bot removed the request for review from a team November 25, 2024 22:19
@FitseTLT
Copy link
Copy Markdown
Contributor Author

@jayeshmangwani To reproduce on native I had to remove isVsb check here

if (!isVsb || !!onboardingPolicyID || isLoadingOnyxValue(onboardingPolicyIDResult) || isOnboardingPolicyIDCleared.current) {

and started the sign up flow in ND selecting Manage teams > 1 - 10 employees > and then closing and reopening the app
Hope it will be helpful 👍

@FitseTLT
Copy link
Copy Markdown
Contributor Author

@mountiny You can consider reviewing this if it is too critical to wait for @jayeshmangwani's review 👍

@github-actions
Copy link
Copy Markdown
Contributor

🚧 @mountiny has triggered a test build. You can view the workflow run here.

@ishpaul777
Copy link
Copy Markdown
Contributor

ishpaul777 commented Nov 26, 2024

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • 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 included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • 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 is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • 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.ts 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 */
    • 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 any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • 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(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • 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.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Android.mov
Android: mWeb Chrome
Android-chrome.mov
iOS: Native
Screen.Recording.2024-11-27.at.7.00.22.PM-1.mov
iOS: mWeb Safari
safari.mov
MacOS: Chrome / Safari
Screen.Recording.2024-11-27.at.5.53.32.PM.mov
MacOS: Desktop
Screen.Recording.2024-11-27.at.6.46.54.PM.mov

@github-actions
Copy link
Copy Markdown
Contributor

@ishpaul777
Copy link
Copy Markdown
Contributor

ishpaul777 commented Nov 26, 2024

Still not fixed on Desktop

1st it creates a workspace on web ND on which it is landed from OD, then when redirected of Desktop app it creates a workspace again

Screen.Recording.2024-11-27.at.12.07.18.AM.mov

@FitseTLT

@FitseTLT
Copy link
Copy Markdown
Contributor Author

FitseTLT commented Nov 26, 2024

Still not fixed on Desktop

1st it creates a workspace on web ND on which it is landed from OD, then when redirected of Desktop app it creates a workspace again

Screen.Recording.2024-11-27.at.12.07.18.AM.mov
@FitseTLT

Yeah @ishpaul777 unfortunately we are currently saving the onboardingPolicy in onyx only, so there is no way for the Desktop to know about the onboardingPolicy that was created in web.
@mountiny Do you think we should avoid creating onboarding policies if a user has a workspace already created ?? In that case we can avoid this bug without a need of BE changes.

@ishpaul777
Copy link
Copy Markdown
Contributor

i believe this is the case what are failing in QA test here otherwise i could not recreate issue even without these changes. 🤔

@FitseTLT
Copy link
Copy Markdown
Contributor Author

FitseTLT commented Nov 26, 2024

i believe this is the case what are failing in QA test here otherwise i could not recreate issue even without these changes. 🤔

But I did recreate it on IOS before the fix as it was also mentioned in #52899 (comment)

@mountiny
Copy link
Copy Markdown
Contributor

Do you think we should avoid creating onboarding policies if a user has a workspace already created ?? In that case we can avoid this bug without a need of BE changes.

Yes I think that we should not create a new policy if they already have one

@ishpaul777
Copy link
Copy Markdown
Contributor

ishpaul777 commented Nov 26, 2024

But I did recreate it on IOS before the fix as it was also mentioned in #52899 (comment)

@ jayeshmangwani To reproduce on native I had to remove isVsb check

When qa reproduced this they did not have the abilty make any changes in the code, right? so this should be reproducable as is no?

we should avoid creating onboarding policies if a user has a workspace already created

Regardless, i think this should be enough and we did not need the current changes anymore after adding this check

@FitseTLT
Copy link
Copy Markdown
Contributor Author

@ishpaul777 Fixed! U can proceed.

@ishpaul777
Copy link
Copy Markdown
Contributor

I have finished up for today, will test changes tmrw when i start

@FitseTLT FitseTLT requested a review from ishpaul777 November 27, 2024 12:44
@melvin-bot melvin-bot bot requested a review from mountiny November 27, 2024 13:39
@ishpaul777
Copy link
Copy Markdown
Contributor

LGTM 🚀

@FitseTLT FitseTLT changed the title Fix - [CRITICAL] Multiple workspaces get created when someone either refreshes the page, or drops off and returns later. Fix - A Follow up on [CRITICAL] Multiple workspaces get created when someone either refreshes the page, or drops off and returns later. Nov 28, 2024
@mountiny mountiny changed the title Fix - A Follow up on [CRITICAL] Multiple workspaces get created when someone either refreshes the page, or drops off and returns later. [CP Staging] Fix - A Follow up on [CRITICAL] Multiple workspaces get created when someone either refreshes the page, or drops off and returns later. Nov 28, 2024
@mountiny mountiny merged commit 3b832f8 into Expensify:main Nov 28, 2024
// So we need to create the new workspace in the accounting step
useEffect(() => {
if (!isVsb || !!onboardingPolicyID || isLoadingOnyxValue(onboardingPolicyIDResult)) {
const filteredPolicies = Object.values(allPolicies ?? {}).filter(PolicyUtils.isPaidGroupPolicy);
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Lets change this to some, we just need to know they have one paid policy we dont have to iterate over the entire list

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Should I raise another PR? because pushing the changes is not working because the pr is merged.

Copy link
Copy Markdown
Contributor Author

@FitseTLT FitseTLT Nov 28, 2024

Choose a reason for hiding this comment

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

@mountiny but it might not be much of a concern as the onboarding flow is displayed when the user has one or none workspaces WDYT

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

You can just add it in some future pr

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I can raise a quick one now and you can merge it. WDYT??

OSBotify pushed a commit that referenced this pull request Nov 28, 2024
…n-bug

[CP Staging] Fix - `A Follow up on` [CRITICAL] Multiple workspaces get created when someone either refreshes the page, or drops off and returns later.

(cherry picked from commit 3b832f8)

(CP triggered by mountiny)
@github-actions github-actions bot added the CP Staging marks PRs that have been CP'd to staging label Nov 28, 2024
@OSBotify
Copy link
Copy Markdown
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.

@github-actions
Copy link
Copy Markdown
Contributor

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 9.0.67-9 🚀

platform result
🤖 android 🤖 false ❌
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 success ✅
🍎🔄 iOS HybridApp 🍎🔄 success ✅

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

@github-actions
Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.67-9 🚀

platform result
🤖 android 🤖 skipped 🚫
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 failure ❌
🍎🔄 iOS HybridApp 🍎🔄 failure ❌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CP Staging marks PRs that have been CP'd to staging Ready To Build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants