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 - User is able to disable 2FA when connected to Xero accounting #53948

Conversation

FitseTLT
Copy link
Contributor

@FitseTLT FitseTLT commented Dec 11, 2024

Details

Fixed Issues

#52850
PROPOSAL: #52850 (comment)

Tests

Precondition:

  • Workspace is connect to Xero accounting and 2FA is enabled

Test:

  1. Open workspace setting page with Xero 1connection.
  2. Go back and open security page
  3. Click on Two factor authentication
  4. Click Disable two-factor authentication
  5. Verify that: A blocking modal is shown stating Two-factor authentication (2FA) is required for your Xero connection and cannot be disabled.
  • Verify that no errors appear in the JS console

Offline tests

Cannot be tested

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
2024-12-11.18-29-34.mp4
Android: mWeb Chrome
2024-12-11.17-46-36.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 December 11, 2024 15:07
@melvin-bot melvin-bot bot requested a review from allgandalf December 11, 2024 15:07
Copy link

melvin-bot bot commented Dec 11, 2024

@allgandalf 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 December 11, 2024 15:07
@FitseTLT
Copy link
Contributor Author

FitseTLT commented Dec 11, 2024

@allgandalf and @neil-marcellini I want to mention that this treatment of determining if there is a workspace with xero connection from FE does have an uncovered edge case where when the user has just signed in and the necessary workspace data is not available in onyx we can't determine if there are xero connections. From my observation the policy.connections is only populated after you specifically open the workspace profile page so we need BE fix to make this solid and deal with the edge case.

2024-12-11.18-10-19.mp4

@allgandalf
Copy link
Contributor

umm, @neil-marcellini either ways i don't think so that should block our FE PR, do you agree ?

@allgandalf
Copy link
Contributor

waiting for a reply.,..

@FitseTLT
Copy link
Contributor Author

bump @neil-marcellini

@allgandalf
Copy link
Contributor

@neil-marcellini is OoO this week, we should hear back next week, i will still complete the checklist in the meantime

@allgandalf
Copy link
Contributor

bumped @neil-marcellini 1:1 so we should expect a reply soon

@neil-marcellini
Copy link
Contributor

neil-marcellini commented Dec 24, 2024

@allgandalf and @neil-marcellini I want to mention that this treatment of determining if there is a workspace with xero connection from FE does have an uncovered edge case where when the user has just signed in and the necessary workspace data is not available in onyx we can't determine if there are xero connections. From my observation the policy.connections is only populated after you specifically open the workspace profile page so we need BE fix to make this solid and deal with the edge case.

Yes that's a good point. I think we should update the backend for disabling 2FA so that it checks if there are any policy connections, and if so returns a helpful error message. I will remove the $ in front of the linked issue so it stays open, and I'll handle that part internally. We can still go ahead with this frontend fix.

@allgandalf
Copy link
Contributor

@FitseTLT please merge main

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Jan 7, 2025

@FitseTLT please merge main

Done @allgandalf

@FitseTLT FitseTLT requested a review from allgandalf January 13, 2025 13:15
src/libs/PolicyUtils.ts Outdated Show resolved Hide resolved
src/libs/PolicyUtils.ts Outdated Show resolved Hide resolved
@FitseTLT FitseTLT requested a review from allgandalf January 21, 2025 23:01
@FitseTLT
Copy link
Contributor Author

@allgandalf Updated

@allgandalf

This comment was marked as outdated.

@FitseTLT
Copy link
Contributor Author

@allgandalf you are going back to the start I had already informed that here that it needs a BE change.

@allgandalf
Copy link
Contributor

@allgandalf you are going back to the start I had already informed that here that it needs a BE change.

AHh, i almost forgot that one, thanks !

@allgandalf
Copy link
Contributor

allgandalf commented Jan 29, 2025

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
Screen.Recording.2025-01-29.at.6.44.46.PM.mov
Android: mWeb Chrome
Screen.Recording.2025-01-29.at.6.48.15.PM.mov
iOS: Native
Screen.Recording.2025-01-29.at.6.28.27.PM.mov
iOS: mWeb Safari
Screen.Recording.2025-01-29.at.6.29.53.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2025-01-29.at.6.24.50.PM.mov
MacOS: Desktop
Screen.Recording.2025-01-29.at.6.23.24.PM.mov

@allgandalf
Copy link
Contributor

@FitseTLT Please update testing steps to:

Precondition:

  • Workspace is connect to Xero accounting and 2FA is enabled

Test:

  1. Open workspace with `Xero 1connection.
  2. Go back and open security page
  3. Click on Two factor authentication
  4. Click Disable two-factor authentication

Verify that: A blocking modal is shown stating Two-factor authentication (2FA) is required for your Xero connection and cannot be disabled.

@FitseTLT
Copy link
Contributor Author

Updated

@allgandalf
Copy link
Contributor

@FitseTLT you cannot test this in offline mode, we get a blocking modal, so please also update the offline test to state that we cannot do this in offline mode:

Screenshot 2025-01-29 at 6 31 36 PM Screenshot 2025-01-29 at 6 31 26 PM

@FitseTLT
Copy link
Contributor Author

done

Copy link
Contributor

@allgandalf allgandalf left a comment

Choose a reason for hiding this comment

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

Lets get this merged 🚀

@@ -1357,6 +1357,8 @@ const translations = {
twoFactorAuthIsRequiredDescription: 'Por razones de seguridad, Xero requiere la autenticación de dos factores para conectar la integración.',
twoFactorAuthIsRequiredForAdminsDescription:
'La autenticación de dos factores es necesaria para los administradores del área de trabajo de Xero. Activa la autenticación de dos factores para continuar.',
twoFactorAuthCannotDisable: 'No se puede desactivar la autenticación de dos factores (2FA)',
twoFactorAuthRequired: 'La autenticación de dos factores (2FA) es obligatoria para tu conexión a Xero y no se puede desactivar.',
Copy link
Contributor

@allgandalf allgandalf Jan 29, 2025

Choose a reason for hiding this comment

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

These translations were confirmed here

Copy link

melvin-bot bot commented Jan 29, 2025

🎯 @allgandalf, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #55954.

@allgandalf
Copy link
Contributor

Yes that's a good point. I think we should update the backend for disabling 2FA so that it checks if there are any policy connections, and if so returns a helpful error message. I will remove the $ in front of the linked issue so it stays open, and I'll handle that part internally. We can still go ahead with this frontend fix.

@neil-marcellini , whats the status on the BE PR? I think we should merge that one first to cover the edge case, but happy if we still merge and come up with a follow up

Copy link
Contributor

@allgandalf allgandalf left a comment

Choose a reason for hiding this comment

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

approving for the tests to pass

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Great work thanks! Yes I'll add the backend check to fix that edge case after this.

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Jan 29, 2025

Great work thanks! Yes I'll add the backend check to fix that edge case after this.

@neil-marcellini the reason the modal is not shown on first sign in is because connections prop is not populated when we set policy list for example on OpenApp API (it only populates it when opening the workspace setting page). So don't you think we should start setting policy.connections so that the behavior of showing cannot-disable modal will be consistent whether or not the user has opened the workspace profile page? If I understood correctly you are planning to return error from the BE when there are xero connections. I think that should be implemented but on top of that shouldn't we ensure our modal is shown in both cases for consistency?

@neil-marcellini
Copy link
Contributor

Great work thanks! Yes I'll add the backend check to fix that edge case after this.

@neil-marcellini the reason the modal is not shown on first sign in is because connections prop is not populated when we set policy list for example on OpenApp API (it only populates it when opening the workspace setting page). So don't you think we should start setting policy.connections so that the behavior of showing cannot-disable modal will be consistent whether or not the user has opened the workspace profile page? If I understood correctly you are planning to return error from the BE when there are xero connections. I think that should be implemented but on top of that shouldn't we ensure our modal is shown in both cases for consistency?

We generally don't want to add any extra data to the OpenApp call because it's already too slow in many cases and it's critical that we work to keep it performant. I think we can make the same modal open after the backend returns an error. I might implement that frontend behavior myself along side the backend work so it's easy for me to test.

@neil-marcellini neil-marcellini merged commit 3cfb4fe into Expensify:main Jan 29, 2025
20 of 22 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.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.92-0 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.92-6 🚀

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

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