Add focus trap to the RHP (v3) #32800

kosmydel · 2023-12-11T11:41:49Z

Details

The third version of the PR as previous versions got reverted (here, and here).

It fixed the following regressions:
#31687
#31725

The issue below was fixed by another PR but was also treated as a regression to this PR.
#31734

Fixed Issues

$ #15631
PROPOSAL: #15631 (comment)

Tests

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

mweb-android.mov

iOS: Native

ios.mp4

iOS: mWeb Safari

mweb-ios.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

This reverts commit d24deb5.

kosmydel · 2023-12-18T10:35:52Z

I ran the tests on all platforms but Android, as it crashes on main. Will test it, when it works.

Can we do the QA tests after the C+ approves and before merging?
Since focus trap changes affect almost every screen in the App, there is a high risk of regression. So it might be a good idea, especially since it was reverted two times.

cc @fedirjh, @roryabraham, @luacmartins

kosmydel · 2023-12-21T14:08:58Z

Hey, sorry for the delay. The android was crashing, and then I had a busy week. This is ready for a review.

Can we run QA here before merging it into the main? cc @roryabraham

melvin-bot · 2023-12-21T14:09:07Z

@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 · 2024-01-02T09:19:32Z

I've resolved conflicts and retested.
Friendly bump @fedirjh :)

kosmydel · 2024-01-08T16:15:53Z

I've resolved the conflicts once again. Another bump @fedirjh for review :)

fedirjh · 2024-01-09T17:07:55Z

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 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 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 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.
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

CleanShot.2024-01-09.at.22.15.39.mp4

iOS: Native

CleanShot.2024-01-09.at.21.07.20.mp4

iOS: mWeb Safari

CleanShot.2024-01-09.at.21.14.34.mp4

MacOS: Chrome / Safari

CleanShot.2024-01-09.at.16.24.49.mp4

CleanShot.2024-01-09.at.18.02.54.mp4

CleanShot.2024-01-09.at.18.05.18.mp4

MacOS: Desktop

CleanShot.2024-01-09.at.18.21.49.mp4

fedirjh

Left minor feedback about the code.

src/components/ScreenWrapper.tsx

src/pages/home/ReportScreen.js

src/pages/home/sidebar/SidebarScreen/BaseSidebarScreen.js

kosmydel · 2024-01-10T15:00:07Z

I've addressed the review and quickly tested it. cc @fedirjh

fedirjh

Looks good to me and tests well

kosmydel · 2024-01-11T09:00:28Z

Thanks @fedirjh!

Can we please do the QA before merging? Those changes got reverted two times, so it would be safer this way. cc @roryabraham

roryabraham · 2024-01-14T05:17:27Z

Kicked off an AdHoc build, requested regression run here

github-actions · 2024-01-14T05:41:01Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/32800/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/32800/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/32800/NewExpensify.dmg	https://32800.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

kosmydel · 2024-01-18T11:34:43Z

I've pulled the main and resolved conflicts.
cc @fedirjh for another look, to be safe

kosmydel · 2024-01-22T13:46:23Z

Kicked off an AdHoc build, requested regression run here

Hey @roryabraham, do we have any results of the regression test?

roryabraham · 2024-01-24T08:40:20Z

Good question @kosmydel, sorry I didn't follow up. I didn't hear back from Applause after my initial request, so I just pinged them again for confirmation. Will let you know.

mvtglobally · 2024-01-24T20:30:42Z

Regression is completed. No issues

kosmydel · 2024-01-25T12:08:30Z

Regression is completed. No issues

Great! Thanks!

I'm unsure if I can merge conflicts and test it this week.

kosmydel · 2024-01-30T10:40:22Z

I've resolved conflicts again.

However, there is an issue (both on main and staging) related to navigation using the tab in the manual request flow.

Steps:

FAB -> Request money -> Manual
Type any amount, press next
Try using tab

Anyway, could you have a final look, as after the regression test I resolved conflicts three times? cc @fedirjh

fedirjh · 2024-01-31T22:56:56Z

However, there is an issue (both on main and staging) related to navigation using the tab in the manual request flow.

@kosmydel Yes I reproduced this issue on staging as well.

Edit: This bug is already in production.

fedirjh

Looks good.

cc @roryabraham Let's get this merged once @kosmydel resolves the conflicts

roryabraham

otherwise LGTM, ready to merge after conflicts are resolved and this one comment is addressed

roryabraham · 2024-02-01T20:19:46Z

src/components/FocusTrapView/index.tsx

+            focusTrapOptions={{
+                initialFocus: () => (shouldEnableAutoFocus && ref.current) ?? false,
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                fallbackFocus: () => ref.current!,


Let's avoid disabling this lint rule

This change was discussed here. I'm not sure if we can find a better approach. We need to pass here a function (which can't return null/undefined), but during the initial function call the ref.current is null.

An alternative is, passing an empty string, but not sure if we have any gain from this approach:

fallbackFocus: () => ref.current ?? '',

kosmydel · 2024-02-02T10:26:52Z

The ideal nav has been merged and it affected the FocusTrap behavior. The reported issue is solved.

If we want to change anything in terms of the navigation using the Tab button, please let me know.

cc @roryabraham, @fedirjh

roryabraham · 2024-02-02T17:14:05Z

The reported issue is solved.

Great, sounds like we can just close this then?

roryabraham · 2024-02-26T20:58:23Z

@kosmydel can we close this and create a new PR in association with #36476? I also think that we have a new process for adding new external libs to the codebase that we would want to follow if we are going to proceed with adding react-focus-trap

kosmydel added 3 commits December 11, 2023 11:19

Revert "Revert "Add focus trap to the RHP (v2)""

9de54e5

This reverts commit d24deb5.

update focus-trap-react

dff444b

fix regressions

e1691d1

kosmydel mentioned this pull request Dec 11, 2023

[$1000] Pressing space bar while details page is opened, scrolls up the reports #15631

Closed

6 tasks

kosmydel added 3 commits December 15, 2023 16:08

Merge branch 'main' into @kosmydel/lottie-prefetching

09989cb

Merge branch 'main' into @kosmydel/add-focus-trap-3

b6a31da

fix another issues

f3817cf

Merge branch 'main' into @kosmydel/add-focus-trap-3

7caaffa

kosmydel marked this pull request as ready for review December 21, 2023 14:09

kosmydel requested a review from a team as a code owner December 21, 2023 14:09

melvin-bot bot requested review from fedirjh and removed request for a team December 21, 2023 14:09

Merge branch 'main' into @kosmydel/add-focus-trap-3

6d3d5e9

situchan mentioned this pull request Jan 8, 2024

[HOLD for payment 2024-07-17] [$500] Web – Chat – Blue frame appears around message Reply when open context menu & use keyboard arrow #32279

Closed

6 tasks

kosmydel added 2 commits January 8, 2024 16:54

Merge branch 'main' into @kosmydel/add-focus-trap-3

3dc8501

fix types

469188d

situchan mentioned this pull request Jan 9, 2024

[HOLD #32800] [$500] Compose Box - User is able to access compose box while side panel is open #34139

Closed

6 tasks

fedirjh reviewed Jan 9, 2024

View reviewed changes

address review

b9ec1e8

roryabraham requested a review from fedirjh January 11, 2024 00:39

fedirjh approved these changes Jan 11, 2024

View reviewed changes

melvin-bot bot requested a review from roryabraham January 11, 2024 08:17

roryabraham added the Ready To Build label Jan 14, 2024

Merge branch 'main' into @kosmydel/add-focus-trap-3

59332b3

Merge branch 'main' into @kosmydel/add-focus-trap-3

49a2bbe

situchan mentioned this pull request Jan 25, 2024

[$500] Web - Chat - You can't scroll the PDF right after opening it with the "down arrow" button #34816

Closed

6 tasks

Merge branch 'main' into @kosmydel/add-focus-trap-3

cebcb83

fedirjh approved these changes Jan 31, 2024

View reviewed changes

roryabraham requested changes Feb 1, 2024

View reviewed changes

kosmydel added 2 commits February 2, 2024 10:54

Merge branch 'main' into @kosmydel/add-focus-trap-3

7af15e6

fix merge

14799fc

kosmydel mentioned this pull request Feb 14, 2024

[$500] Improve Tab Navigation & Accessibility #36476

Closed

6 tasks

kosmydel closed this Feb 27, 2024

Add focus trap to the RHP (v3) #32800

Add focus trap to the RHP (v3) #32800

Uh oh!

Conversation

kosmydel commented Dec 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

kosmydel commented Dec 18, 2023

Uh oh!

kosmydel commented Dec 21, 2023

Uh oh!

melvin-bot bot commented Dec 21, 2023

Uh oh!

kosmydel commented Jan 2, 2024

Uh oh!

kosmydel commented Jan 8, 2024

Uh oh!

fedirjh commented Jan 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

fedirjh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kosmydel commented Jan 10, 2024

Uh oh!

fedirjh left a comment

Choose a reason for hiding this comment

Uh oh!

kosmydel commented Jan 11, 2024

Uh oh!

roryabraham commented Jan 14, 2024

Uh oh!

github-actions bot commented Jan 14, 2024

Uh oh!

kosmydel commented Jan 18, 2024

Uh oh!

kosmydel commented Jan 22, 2024

Uh oh!

roryabraham commented Jan 24, 2024

Uh oh!

mvtglobally commented Jan 24, 2024

Uh oh!

kosmydel commented Jan 25, 2024

Uh oh!

kosmydel commented Jan 30, 2024

Uh oh!

fedirjh commented Jan 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fedirjh left a comment

Choose a reason for hiding this comment

Uh oh!

roryabraham left a comment

Choose a reason for hiding this comment

Uh oh!

roryabraham Feb 1, 2024

Choose a reason for hiding this comment

Uh oh!

kosmydel Feb 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kosmydel commented Feb 2, 2024

Uh oh!

roryabraham commented Feb 2, 2024

Uh oh!

kosmydel commented Dec 11, 2023 •

edited

Loading

fedirjh commented Jan 9, 2024 •

edited

Loading

fedirjh commented Jan 31, 2024 •

edited

Loading

kosmydel Feb 2, 2024 •

edited

Loading