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

Fix - [CRITICAL] Multiple workspaces get created when someone either refreshes the page, or drops off and returns later. #52899

Conversation

FitseTLT
Copy link
Contributor

@FitseTLT FitseTLT commented Nov 21, 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
d.mp4

@FitseTLT FitseTLT requested a review from a team as a code owner November 21, 2024 13:09
@melvin-bot melvin-bot bot requested review from jayeshmangwani and removed request for a team November 21, 2024 13:09
Copy link

melvin-bot bot commented Nov 21, 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]

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Nov 21, 2024

Working on uploading screenshots ...

@FitseTLT
Copy link
Contributor Author

Upload finished

@jayeshmangwani
Copy link
Contributor

jayeshmangwani commented Nov 21, 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.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 */
    • 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.
  • 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: mWeb Chrome
mweb-chrome.mov
iOS: Native
iOS.mov
iOS: mWeb Safari
mweb-safari.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@jayeshmangwani
Copy link
Contributor

@FitseTLT I'm not sure why, but on Android, a workspace is created twice if it comes from a closed app on onboarding flow.

Android.mov

@FitseTLT
Copy link
Contributor Author

I don't think so @jayeshmangwani Maybe you were on a wrong branch. I tried to exactly do what is on your video but couldn't reproduce

2024-11-21.18-09-47.mp4

@jayeshmangwani
Copy link
Contributor

Maybe you were on a wrong branch

No, thats not the case, I am on right branch

@jayeshmangwani
Copy link
Contributor

I am checking on real device, let's see if that my emulator thing

@jayeshmangwani
Copy link
Contributor

For me, it's still creating two workspaces

@jayeshmangwani
Copy link
Contributor

@mountiny Can we please generate build here so that we can test it on an Android device?"

@jayeshmangwani
Copy link
Contributor

@FitseTLT Do you have any idea, How can we open the OD web link in the ND staging version of the app? We are testing locally using npx uri-scheme open, but how can we verify it on the staging version?

@FitseTLT
Copy link
Contributor Author

@FitseTLT Do you have any idea, How can we open the OD web link in the ND staging version of the app? We are testing locally using npx uri-scheme open, but how can we verify it on the staging version?

@jayeshmangwani Sorry but I am totally not understanding what you meant.

@jayeshmangwani
Copy link
Contributor

I am totally not understanding what you meant.

Sorry about that! Let me simplify it: how have you tested this PR on Android?

@FitseTLT
Copy link
Contributor Author

npm run android

@jayeshmangwani
Copy link
Contributor

Sorry, I didn’t quite get you. npm run android doesn’t work for me with this PR. Can you please at least show me on video how you trigger the Choose the “1-9” option on the home page (signUpQualifier: vsb) step on Android?

Copy link
Contributor

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

Copy link
Contributor

@mountiny
Copy link
Contributor

@jayeshmangwani here is the build

@jayeshmangwani
Copy link
Contributor

Thanks, I’m checking it now

@jayeshmangwani
Copy link
Contributor

@mountiny , I am trying to test the transition link from OldDot to NewDot on a native Android device for the signup flow when we select the VSB option on OD, but for me, it is always opening in mobile web. Is there any way you are aware of to test on a native Android device? Otherwise, this issue cannot be tested in a real scenario.

@mountiny
Copy link
Contributor

I am not sure how to test the short-lived token in your dev setup, sorry 😬 its probably not possible as the deeplinks will be picked up in the actual app, not your dev apk

@jayeshmangwani
Copy link
Contributor

I think we can proceed with this PR and merge it, as testing on both the production web and mobile app shows that we are not opening the transition deep link on mobile (when creating a new account and selecting the VSB option).

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Thanks for the changes. I think we should still improve this logic eventually, if someone leaves the page mid onboarding without completing and comes back to it in another browser or client, they will get another workspace created afaik

@mountiny mountiny merged commit c32ad42 into Expensify:main Nov 21, 2024
17 checks passed
@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.

@jayeshmangwani
Copy link
Contributor

if someone leaves the page mid onboarding without completing and comes back to it in another browser or client

If the user skips the onboarding midway, we currently do not display the onboarding modal on another browser. Instead, they are directly taken to the sidebar screen.

@jayeshmangwani
Copy link
Contributor

We only show the uncompleted onboarding flow if the user is on the same browser

@mountiny
Copy link
Contributor

If they do not complete the flow though they would still have the onboarding nvp set as not completed so we should show the flow, right?

@jayeshmangwani
Copy link
Contributor

Technically, we should, yes. However, what I'm trying to highlight is that currently:

  1. If a new user starts the NVP onboarding flow on Device/Browser A but hasn't completed it, and then opens the same user account on Device/Browser B, there is no onboarding flow initiated for Device B.
  2. Additionally, when returning to Device A, the user gets logged out on the current staging version.

In the above two scenarios, multiple workspaces will not be created.

If we need a discussion on the existing flow—specifically why a user cannot see the onboarding flow on another device if flow hasn't been completed on the first device, and why the user gets logged out on Device A where the onboarding flow was initiated, we can open a Slack discussion to get more 👀

@mountiny
Copy link
Contributor

If we need a discussion on the existing flow—specifically why a user cannot see the onboarding flow on another device if flow hasn't been completed on the first device, and why the user gets logged out on Device A where the onboarding flow was initiated, we can open a Slack discussion to get more 👀

This certainly feels like a bug, eny time the onboarding nvp says hasCompletedGuidedFlow: false it should show the onboarding modal

Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.66-0 🚀

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

@mountiny
Copy link
Contributor

cc @FitseTLT @jayeshmangwani this is failing in desktop and in iOS in QA testing, can you please have a look?

Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.66-8 🚀

platform result
🤖 android 🤖 success ✅
🖥 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants