Add focus trap to the RHP (v2)

[kosmydel]

Details

This is a new version of this PR. The previous one was reverted due to two bugs:

• [$500] [HOLD for payment 2023-09-27] Web – 2FA – App with 2FA installed crashes when trying to access 2FA menu #27519
• [HOLD for payment 2023-09-27] Web - search field or new group field remain focused after CTRL + K, CTRL + J or CTRL + SHIFT + K, CTRL + J #27516

This PR addresses the above issues and reintroduces the FocusTrap. I've updated the test plan and posted new videos to cover the above issues.

Fixed Issues

$ #15631
PROPOSAL: #15631 (comment)

Tests

• All the QA Steps listed below.
• Remove children elements from the RHP panel (in the InitialSettingsPage), verify that the focus trap works without focusable elements inside

Offline tests

Doesn't change anything network-related.

QA Steps

• Open RHP modals:
  • Open Settings (press user avatar in the top left corner, above the report's list),
  • In the report press user avatar to open user details
  • In the report press the header (name of the report) to open report details
  • In Settings go to Workspaces, and then press "New workspace" button.
  • Try to cover as many RHP panels as possible.
• Verify that no errors appear in the JS console
• On each modal listed above verify (web + desktop):
  • Press Space - verify that you can't scroll in the background
  • Navigate using Tab and Shift+Tab, verify that you can't focus outside the modals.
  • Verify that you can select the focused element using Enter.
  • Do the above points for subpages (i.g. enter Settings -> Profile).
  • Refresh the page with the RHP opened, and verify that everything works.
  • Click outside the modal to check if it closes.
  • Click Escape and check if the modal closes (and everything works).
• Other tests (web + desktop):
  • With the RHP panel hidden verify that you can change focus using the (Shift+)Tab correctly.
  • On the Settings RHP resize windows so it is small enough so the scroll bar appears. Now focus on some button in the scroll view, and then try to scroll using the (Shift+)Space.
  • Verify focus trap behavior for accessibility.
• On each modal (all platforms):
  • Verify that you can scroll the modals
  • Navigate in modals, go to subpages, and verify that everything works
• Open the search panel:
  • Verify that the autofocus works, and the input bar is automatically focused.
• Go around the app, and check if everything works.
• Test 2FA page crashing issue:
  • Log in to an account with the 2FA configured
  • Go to Settings -> Security -> Two-factor authentication
  • Verify that the App doesn't crash
  • Test full 2FA flow:
    • add 2FA to the account,
    • remove 2FA from the account.
  • Especially verify the pages with AnimatedStepProvider, currently it is only the TwoFactorAuthPage.
• Test search field remain focused after CTRL + K and CTRL + J issue
  • Press CTRL + K, then CTRL + J - check if focus trap works as expected:
    • The search field in the background shouldn't remain focused,
    • After pressing escape with the modal open the search field should focus again
    • After clicking outside the modal the search field should focus again
  • Do the same tests from the above in CTRL + SHIFT + K, CTRL + J
  • Check Settings:
    • Open Settings
    • With tab focus on some button (e.g.. Profile)
    • Press CTRL + J to open the modal
    • The background button should blur (the modal was changed)
    • Exit the modal
    • Verify that the button is focused again
  • Verify other modals, check if work:
    • Add attachment to the report,
    • Go to Settings -> Profile -> Personal details -> Home Address -> Country, press CTRL + J, check if everything is as expected
    • Go to Settings -> Profile -> Upload new avatar (modal) -> Open CTRL + J, check if works
    • Press the "New" button (green cross at the bottom), then CTRL + J
  • Create a new account. Go to Settings. Verify everything works.
  • Go to the Settings -> Security -> Close account -> enter default contact -> Click Close acctount. Verify if the focus trap is working in the confirmation modal

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 / Chrome
  • iOS / native
  • iOS / 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 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
  • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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(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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Fixed:

fix-web.mov

web-2.mov

Workspace creation:

web-fix.mov

Old version:
https://github.com/Expensify/App/assets/104823336/4521b3e2-b25c-427c-a1e6-5294242e39e1

Mobile Web - Chrome

Fixed:

fix-mWeb-android.mov

mWeb-android.mov

Mobile Web - Safari

Fixed:

fix-mWeb-ios.MP4

mWeb-iOS.mp4

Desktop

Fixed:

fix-desktop.mov

desktop-2.mov

Workspace creation:

desktop-fix.mov

Old version:
https://github.com/Expensify/App/assets/104823336/43e3570d-5293-4804-890d-c8675f25d934

iOS

Fixed:

fix-ios.mp4

iOS.mp4

Android

Fixed:

fix-android.mov

android.mov

[melvin-bot]

@fedirjh 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]

[mountiny]

I want to flag with this PR #27230 (comment) we faced some issues with the focusTrap. Lets make sure we wait for that and we address it here.

[kosmydel]

Hey @mountiny, can we remove HOLD from this as the other PR was merged?

I merged the main and resolved conflicts but didn't thoroughly test it yet (as it is on hold).

[mountiny]

@kosmydel thank you! Please go ahead and test away

[kosmydel]

Hey @fedirjh, I tested it locally (including testing two regressions fixed) and it looks like everything works. I think we can proceed with the review.

cc @mountiny

[mountiny]

All yours @fedirjh

[kosmydel]

I've resolved merged & resolved conflicts. I have to test it thoroughly again but will do it tomorrow. Marking as draft

[kosmydel]

Hey, @fedirjh I've tested it, and it looks like it is ready for review

[fedirjh]

Re-tested and everything is working fine. Not sure what to do about the failing tests.

[kosmydel]

I've addressed TS review comments.
I've also found two more screens to fix and fixed those here. cc @fedirjh

[roryabraham]

I'm not sure what can I do about the failing Snyk tests

We have an open support ticket with snyk as these tests are failing on all PRs (at least, all PRs from forks)

[OSBotify]

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

[OSBotify]

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.2-0 🚀

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

[situchan]

This PR caused above deploy blockers with the same root cause.

[luacmartins]

@kosmydel @roryabraham @blazejkustra we're reverting this PR since it caused the following blockers:

• [$500] IOU - Blue box surrounding the currency after the currency selection #31687
• Workspace - Blue focus is shown when changing workspace name #31725
• BA - Error message doesn't stop displaying instantly after valid data is entered in date field #31734

Could you please work on the PR and a fix for the issues above?

[shubham1206agra]

Please use v10.2.3 to include focus-trap/focus-trap#1068

[OSBotify]

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.2-3 🚀

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

[kosmydel]

@kosmydel @roryabraham @blazejkustra we're reverting this PR since it caused the following blockers:

• [$500] IOU - Blue box surrounding the currency after the currency selection #31687
• Workspace - Blue focus is shown when changing workspace name #31725
• BA - Error message doesn't stop displaying instantly after valid data is entered in date field #31734

Could you please work on the PR and a fix for the issues above?

Hey, sure I will check it. However, currently, I am focusing on the ideal nav project, as it has the highest priority.

[luacmartins]

Sure, no rush

[fedirjh]

@kosmydel any new updates ?

[kosmydel]

@kosmydel any new updates ?

Hey, I hope that next week I will have some more time to look at this.