Skip to content

Show a fullscreen 2fa required instead of modal#58071

Merged
Beamanator merged 11 commits intoExpensify:mainfrom
bernhardoj:feat/57684-improve-2fa-enablement-fllow
Mar 17, 2025
Merged

Show a fullscreen 2fa required instead of modal#58071
Beamanator merged 11 commits intoExpensify:mainfrom
bernhardoj:feat/57684-improve-2fa-enablement-fllow

Conversation

@bernhardoj
Copy link
Contributor

@bernhardoj bernhardoj commented Mar 10, 2025

Explanation of Change

Fixed Issues

$ #57684
PROPOSAL:

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Prerequisite: User A has a workspace connected to Xero accounting

As User A Invite User B to a workspace as Admin
As User B:

  1. Sign in to the app
  2. Verify a 2FA required page is shown
  3. Press the enable button
  4. Complete the 2FA flow
  5. Press the Got it/back button
  6. Verify a home screen (LHN) is shown
  • 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 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 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.ts 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(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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user 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.

Screenshots/Videos

Android: Native
android.mp4
Android: mWeb Chrome
android.mweb.mp4
iOS: Native
ios.mp4
iOS: mWeb Safari
ios.mweb.mp4
MacOS: Chrome / Safari
web.mp4
MacOS: Desktop
desktop.mp4

@bernhardoj bernhardoj requested review from a team as code owners March 10, 2025 05:23
@melvin-bot melvin-bot bot requested a review from dukenv0307 March 10, 2025 05:23
@melvin-bot
Copy link

melvin-bot bot commented Mar 10, 2025

@dukenv0307 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 March 10, 2025 05:23
@bernhardoj
Copy link
Contributor Author

Asked for translation verification here: https://expensify.slack.com/archives/C01GTK53T8Q/p1741584360196839

@dukenv0307
Copy link
Contributor

Bug:

Screen.Recording.2025-03-10.at.14.47.33.mov

@dukenv0307
Copy link
Contributor

I think this PR should be merged first

@dubielzyk-expensify
Copy link
Contributor

I think the visuals look good. Part of me wonders now if we should just tweak the copy to be less about Xero's accounting package and that "This workspaces requires two-factor authentication.." or something.

Keen to hear from @Expensify/design and @trjExpensify

@trjExpensify
Copy link
Contributor

Mhm yeah, the only reason for this is because of Xero though. They enforce it for admins in partner apps that connect to Xero.

@dubielzyk-expensify
Copy link
Contributor

I get that, I guess just for a new user being invited, it isn't really relevant info. I don't care too much so happy to move along 😄

@shawnborton
Copy link
Contributor

No strong feelings, though I totally see Jon's point.

@bernhardoj
Copy link
Contributor Author

Bug:

Screen.Recording.2025-03-10.at.14.47.33.mov

Checking

@bernhardoj
Copy link
Contributor Author

My account (WS owner) that has Xero connection is somehow suspended. I have asked for help on slack to unsuspend it.

@trjExpensify
Copy link
Contributor

My account (WS owner) that has Xero connection is somehow suspended. I have asked for help on slack to unsuspend it.

I took you off the email suppression list. 👍

@bernhardoj
Copy link
Contributor Author

@dukenv0307 I tried fixing the bug by using the reset action, but the browser history still contains the /2fa-require path. The react-navigation doc itself also mention that

the browser's history will still reflect the old navigation state

https://reactnavigation.org/docs/navigation-actions/#rewriting-the-history-with-reset

What if we change the behavior so that after the user enables the 2FA, both the 2FA required page and 2FA RHP are closed?

web2.mp4

cc: @trjExpensify

@dukenv0307
Copy link
Contributor

but the browser history still contains the /2fa-require path. The react-navigation doc itself also mention that

Can you check the behavior of onboarding feature?

@bernhardoj
Copy link
Contributor Author

We close the onboarding navigator after completing it, so we can't go back to it.

const navigateAfterOnboarding = (
isSmallScreenWidth: boolean,
canUseDefaultRooms: boolean | undefined,
onboardingPolicyID?: string,
activeWorkspaceID?: string,
onboardingAdminsChatReportID?: string,
) => {
Navigation.dismissModal();
// When hasCompletedGuidedSetupFlow is true, OnboardingModalNavigator in AuthScreen is removed from the navigation stack.
// On small screens, this removal redirects navigation to HOME. Dismissing the modal doesn't work properly,
// so we need to specifically navigate to the last accessed report.
if (!isSmallScreenWidth) {
if (onboardingAdminsChatReportID) {
Navigation.navigate(ROUTES.REPORT_WITH_ID.getRoute(onboardingAdminsChatReportID));
}
return;
}
const lastAccessedReport = findLastAccessedReport(!canUseDefaultRooms, shouldOpenOnAdminRoom(), activeWorkspaceID);
const lastAccessedReportID = lastAccessedReport?.reportID;
// we don't want to navigate to newly created workspaces after onboarding is completed.
if (!lastAccessedReportID || lastAccessedReport.policyID === onboardingPolicyID || isConciergeChatReport(lastAccessedReport)) {
return;
}
const lastAccessedReportRoute = ROUTES.REPORT_WITH_ID.getRoute(lastAccessedReportID);
Navigation.navigate(lastAccessedReportRoute);
};

@trjExpensify
Copy link
Contributor

What if we change the behavior so that after the user enables the 2FA, both the 2FA required page and 2FA RHP are closed?

Hm, I don't love losing the confirmation screen tbh. I think it's fine to close both after confirming. Your vid also looks like it takes quite a long time for the account to load, so the "added delay" in showing the confirmation screen with the blocking modal in the background still could prove to be beneficial. CC: @Expensify/design for thoughts, vid here.

@dannymcclain
Copy link
Contributor

Hm, I don't love losing the confirmation screen tbh. I think it's fine to close both after confirming.

Agree with this. It feels a little jarring to hit Next and then have the whole entire UI completely change. I would definitely down with closing both after clicking Got it on the confirmation screen though.

@shawnborton
Copy link
Contributor

Yeah, I agree with you both.

@bernhardoj
Copy link
Contributor Author

I think it's fine to close both after confirming.

Got it, I'll try and record this tomorrow.

@bernhardoj
Copy link
Contributor Author

Does this looks good?

web.mp4

(I pressed the browser back button to show the navigation bug is fixed, cc: @dukenv0307)

@dukenv0307
Copy link
Contributor

@bernhardoj Looks good

@shawnborton
Copy link
Contributor

Nice, that seems better to me.

@bernhardoj
Copy link
Contributor Author

Updated

@dukenv0307
Copy link
Contributor

@bernhardoj Lint are failing...

@dukenv0307
Copy link
Contributor

@bernhardoj Bug

  1. User B enables 2FA
  2. User A remove user B from WS
  3. User B disables 2FA

Actual result: 2fa-required page is shown

Expected result: 2fa-required page isn't shown

@bernhardoj
Copy link
Contributor Author

I believe it's the same bug as #58217.

Lint fixed.

@dukenv0307
Copy link
Contributor

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 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
    • 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
Screen.Recording.2025-03-14.at.23.13.13.mov
Android: mWeb Chrome
Screen.Recording.2025-03-14.at.23.03.36.mov
iOS: Native
Screen.Recording.2025-03-14.at.23.07.25.mov
iOS: mWeb Safari
Screen.Recording.2025-03-14.at.22.57.24.mov
MacOS: Chrome / Safari
Screen.Recording.2025-03-14.at.22.50.37.mov
MacOS: Desktop
Screen.Recording.2025-03-14.at.23.17.15.mov

Copy link
Contributor

@dukenv0307 dukenv0307 left a comment

Choose a reason for hiding this comment

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

LGTM

@melvin-bot melvin-bot bot requested a review from Beamanator March 14, 2025 16:21
@trjExpensify
Copy link
Contributor

Nice, that seems better to me.

+1, looks good!

@dannymcclain
Copy link
Contributor

Feels much better, nice!

Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

Overall looking great! Just a few lil comments!

selector: wasInvitedToNewDotSelector,
});
const [hasNonPersonalPolicy] = useOnyx(ONYXKEYS.HAS_NON_PERSONAL_POLICY);
const shouldShowRequire2FAPage = account?.needsTwoFactorAuthSetup && !account.requiresTwoFactorAuth;
Copy link
Contributor

Choose a reason for hiding this comment

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

Mind adding a comment here explaining exactly why this is the logic we want? I think this will confuse people in the future who read this

Comment on lines +1396 to +1398
twoFactorAuthIsRequiredForAdminsHeader: 'Two-factor authentication required',
twoFactorAuthIsRequiredForAdminsTitle: 'You need to enable two-factor authentication',
twoFactorAuthIsRequiredForAdminsDescription: 'The Xero accounting connection requires the use of two-factor authentication. To continue using Expensify, please enable it.',
Copy link
Contributor

Choose a reason for hiding this comment

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

Could be nice to remove the ForAdmins part of these keys since the text doesn't say anything about admins, what do y'all think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, it doesn't mention about admin, but the page will only show in a case where a workspace (connected to Xero) admin without 2FA enabled login.

};
}, [theme]);

useEffect(() => {
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should also add a comment here for these 2 new useEffects

@bernhardoj
Copy link
Contributor Author

For the comment, I don't think it's necessary. needsTwoFactorAuthSetup and requiresTwoFactorAuth already have a clear comment explaining what it is and the variable name (shouldShowRequire2FAPage) is already self-explanatory. (the logic is also been there for a long time)

Copy link
Contributor

@Beamanator Beamanator 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 updates & looks good 🚀

@Beamanator Beamanator merged commit 61a1941 into Expensify:main Mar 17, 2025
16 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.

@github-actions
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Beamanator in version: 9.1.15-0 🚀

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

@mountiny
Copy link
Contributor

@bernhardoj can you please check the failing cases?

@bernhardoj
Copy link
Contributor Author

I don't have access to hybrid app. From the video, the user stays on the OD, so the new page we add here isn't shown. It's the same issue as #58232 (comment)

@github-actions
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 9.1.15-9 🚀

platform result
🤖 android 🤖 true ❌
🖥 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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants