Add focus trap to the RHP

[kosmydel]

Details

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

• Verify that no errors appear in the JS console
• 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.
• 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.

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
  • 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(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

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

mWeb-android.mov

Mobile Web - Safari

mWeb-iOS.mp4

Desktop

desktop-2.mov

Workspace creation:

desktop-fix.mov

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

iOS

iOS.mp4

Android

android.mov

[kosmydel]

Created a discussion on slack for this PR.
cc @fedirjh

[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]

[kosmydel]

Friendly bump, it is ready to review @fedirjh

[fedirjh]

cc @kosmydel Reviewing in a few moments.

[fedirjh]

cc @kosmydel the code looks solid, I left small comments about props.

[kosmydel]

Hey @fedirjh, do you have any update for this PR?

I've resolved conflicts and merged the main.

[fedirjh]

BUG: Deeplink to page within RHP and notice the modal is outlined:

CleanShot.2023-08-19.at.12.05.09.mp4

[kosmydel]

@roryabraham
I've resolved conflicts :)

[roryabraham]

I think we should hold off on this, more context in the issue

[roryabraham]

As stated in the linked issue, I'm going to put this on HOLD for the merge freeze.

@kosmydel please take this off HOLD when the merge freeze is lifted

[roryabraham]

@kosmydel I think it would be a good time to resolve conflicts here and get this re-tested and back into a mergeable state.

[kosmydel]

Hey @roryabraham, I've resolved the conflicts and tested it, it looks like everything works.

cc @fedirjh for another look

[fedirjh]

@kosmydel I have tested the attachment modal and it seems it has the same bug, can we fix that?

Open any attachment then press the space and the report scroll 💥

CleanShot.2023-09-12.at.15.08.31.mp4

---

@roryabraham @kosmydel Unrelated to this PR, I noticed that keyboard navigation is broken in staging and production, I found some bugs that may have been deployed recently :

These bugs are recorded in staging v1.3.67-3 :

Bug 1: When you navigate from the main setting menu to any sub-menu page and then navigate back to the main menu, the menu is disabled

1. Open the main Settings page
2. Using the Tab navigate to any sub page: e.g. Workspaces
3. Using the Tab navigate back to the main Settings page
4. All menu items are disabled 💥

CleanShot.2023-09-12.at.14.34.25.mp4

Bug 2: The back button inside Contact methods page have some weird behaviour

1. Open the main Settings page
2. Using the Tab navigate to Profile -> Contact methods -> Main contact method
3. Using the Tab when you navigate back to contact methods -> will navigate you to a new contact page 💥
4. Using the Tab, navigate back to contact methods -> will navigate you back to contact methods
5. At this point the back button stops working it just reloads the same page 💥

CleanShot.2023-09-12.at.14.35.24.mp4

Bug 3: Inside the wallet page, use the Tab to add a new payment method, The popover is displayed on the top of the screen

CleanShot.2023-09-12.at.14.46.17-converted.mp4

[kosmydel]

@kosmydel I have tested the attachment modal and it seems it has the same bug, can we fix that?

Open any attachment then press the space and the report scroll 💥

Hey @fedirjh, thanks for pointing this out!

---

I've investigated it, and for AttachmentModal the root cause is probably different.
The Modal component which AttachmentModal uses already implements a focus trap from the react-native-web library. So adding another one doesn't make sense, and theoretically, it should work.

But it doesn't. Here is my guess what is the reason for it:

1. when a user opens the attachment we navigate to its route,
2. after first navigation, the focus trap correctly traps the user in the modal (focuses on some element inside the modal),
3. when the modal is actually opened, this line below tries to navigate again to the same route
   

   App/src/pages/home/report/ReportAttachments.js

   Line 36 in 4d104f5

   Navigation.navigate(route);

4. the second call of the .navigation blurs the focus, that the focus trap set, leading to the ability to scroll in the background
   

   App/src/libs/Navigation/Navigation.js

   Line 90 in 4d104f5

   DomUtils.blurActiveElement();

So we can fix it without adding another focus trap: we should prevent calling the .navigate method twice with the same route.

---

However, I think that it should be a different issue, as this has a completely different root cause of the problem.

cc @roryabraham

[fedirjh]

4. the second call of the .navigation blurs the focus, that the focus trap set, leading to the ability to scroll in the background

App/src/libs/Navigation/Navigation.js

Line 90 in 4d104f5

DomUtils.blurActiveElement();

@kosmydel That makes sense, removing that line fixes the issue. However, that line was added to fix this issue #13146 .

I totally agree that we should handle it separately.

All yours @roryabraham

[kosmydel]

@kosmydel That makes sense, removing that line fixes the issue. However, that line was added to fix this issue #13146 .

I was rather thinking of adding an extra check to this line like this:

  if (Navigation.isActiveRoute(route)) {
      return;
  }
  Navigation.navigate(route);

However, I'm not sure, if this is the best solution.

[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.3.70-0 🚀

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

[bernhardoj]

@fedirjh @kosmydel This code can be safely removed.

App/src/libs/Navigation/Navigation.js

Line 90 in 4d104f5

DomUtils.blurActiveElement();

For context, the above code is introduced to fix #13146 but deleted in this PR because we are "reverting" it, but somehow other PR reintroduced it (bad merge).

[joelbettner]

@kosmydel this caused two deploy blockers:
#27519
#27516

We are planning reverting this PR for the sake of not holding up a deploy. I just wanted to give you the heads up so you were aware and can start working on #15631 again.

[kosmydel]

@kosmydel this caused two deploy blockers: #27519 #27516

We are planning reverting this PR for the sake of not holding up a deploy. I just wanted to give you the heads up so you were aware and can start working on #15631 again.

Sure, thanks for handling that when I wasn't available!

[OSBotify]

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.70-8 🚀

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