[CP Staging] Disable initial focus in modals #43743

jnowakow · 2024-06-14T07:18:20Z

Details

This PR fixes regression with Focus Trap

Fixed Issues

$ #43659
$ #43736
PROPOSAL: N/A

Tests

Open modal (click green plus button in LHP)
Verify that first element is not highlighted initially

Go to staging.new.expensify.com
Go to workspace settings > Categories
Select all the categories via checkbox
Click Select
Unselect all the categories
Select all the categories
Click Select
The Categories header will not jump when clicking Select

Verify that no errors appear in the JS console

Offline tests

Same as in Tests

QA Steps

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

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

android-web.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-06-14T07:18:25Z

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

jnowakow · 2024-06-14T07:23:34Z

src/components/FocusTrap/FocusTrapForModal/index.web.tsx

@@ -10,7 +10,7 @@ function FocusTrapForModal({children, active}: FocusTrapForModalProps) {
            focusTrapOptions={{
                trapStack: sharedTrapStack,
                allowOutsideClick: true,
-                fallbackFocus: document.body,


According to documentation if initialFocus is set to false fallbackFocus option is not used:

Setting this option to false (or a function that returns false) will prevent the fallbackFocus option from being used.

mountiny

@parasharrajat Lets try to see if this is not causing regressions elsewhere

parasharrajat · 2024-06-14T12:24:12Z

Sure

mountiny · 2024-06-14T14:08:17Z

@parasharrajat do you have an ETA for this checklist? I wonder if we would need to CP this as I feel like this might cause some other regressions

parasharrajat · 2024-06-14T14:14:58Z

It will be done in 1:30 minutes.

parasharrajat · 2024-06-14T14:15:34Z

I see there are a few more issues on the APP which might be related to the original PR so I am trying to see if this PR affects them in anyway.

parasharrajat · 2024-06-14T17:46:43Z

Screenshots

🔲 iOS / native

14.06.2024_23.36.06_REC.mp4

🔲 iOS / Safari

14.06.2024_23.32.19_REC.mp4

🔲 MacOS / Desktop

14.06.2024_23.28.42_REC.mp4

🔲 MacOS / Chrome

14.06.2024_23.25.47_REC.mp4

🔲 Android / Chrome

14.06.2024_23.27.13_REC.mp4

🔲 Android / native

14.06.2024_23.38.01_REC.mp4

parasharrajat

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.

🎀 👀 🎀 C+ reviewed

mountiny

Thanks @parasharrajat

…irst-element-in-modal [CP Staging] Disable initial focus in modals (cherry picked from commit cda6733)

OSBotify · 2024-06-14T21:24:36Z

✋ 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 · 2024-06-14T21:52:32Z

🚀 Cherry-picked to staging by https://github.com/AndrewGable in version: 1.4.83-3 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-06-14T23:04:31Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.83-3 🚀

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

rojiphil · 2024-08-03T12:22:07Z

src/components/FocusTrap/FocusTrapForModal/index.web.tsx

@@ -10,7 +10,7 @@ function FocusTrapForModal({children, active}: FocusTrapForModalProps) {
            focusTrapOptions={{
                trapStack: sharedTrapStack,
                allowOutsideClick: true,
-                fallbackFocus: document.body,
+                initialFocus: false,


Since we did not have a configurable initialFocus, we ran into initial focus issues for AttachmentModal in #43726

Since we removed initial focus and fallbackFocus on document body, it introduced this bug on mSafari: #50661

More details in here: #50661 (comment)

Disable initial focus in modals

91fecc1

jnowakow requested a review from a team as a code owner June 14, 2024 07:18

melvin-bot bot requested review from parasharrajat and removed request for a team June 14, 2024 07:18

jnowakow mentioned this pull request Jun 14, 2024

[HOLD for payment 2024-06-28] [HOLD for payment 2024-06-24] Chat - First menu item in the composer is highlighted #43659

Closed

6 tasks

jnowakow commented Jun 14, 2024

View reviewed changes

staszekscp approved these changes Jun 14, 2024

View reviewed changes

jnowakow mentioned this pull request Jun 14, 2024

[$250] Chat - cursor isn't moved to the end of the pasted text while context menu is open #43717

Closed

6 tasks

Kicu approved these changes Jun 14, 2024

View reviewed changes

filip-solecki mentioned this pull request Jun 14, 2024

[HOLD for payment 2024-06-28] [HOLD for payment 2024-06-24] Categories - Categories header jumps when clicking Select after selecting categories #43736

Closed

6 tasks

jnowakow force-pushed the dont-highlight-first-element-in-modal branch from 3fb50bf to 91fecc1 Compare June 14, 2024 10:48

mountiny assigned jnowakow Jun 14, 2024

mountiny changed the title ~~Disable initial focus in modals~~ [CP Staging] Disable initial focus in modals Jun 14, 2024

mountiny approved these changes Jun 14, 2024

View reviewed changes

parasharrajat approved these changes Jun 14, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny June 14, 2024 18:09

mountiny approved these changes Jun 14, 2024

View reviewed changes

mountiny merged commit cda6733 into Expensify:main Jun 14, 2024
30 of 44 checks passed

OSBotify pushed a commit that referenced this pull request Jun 14, 2024

Merge pull request #43743 from software-mansion-labs/dont-highlight-f…

d164817

…irst-element-in-modal [CP Staging] Disable initial focus in modals (cherry picked from commit cda6733)

github-actions bot mentioned this pull request Jun 14, 2024

Deploy Checklist: New Expensify 2024-06-13 #43655

Closed

64 tasks

bernhardoj mentioned this pull request Jun 18, 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

rojiphil reviewed Aug 3, 2024

View reviewed changes

rojiphil mentioned this pull request Aug 3, 2024

[PAID] [$500] Keyboard focus is on the "close" button when uploading an attachment #43726

Closed

6 tasks

bernhardoj mentioned this pull request Oct 18, 2024

[HOLD for payment 2024-11-05] [$250] mWeb -Chat - Cursor of compose box appears through options after long pressing message #50661

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CP Staging] Disable initial focus in modals #43743

[CP Staging] Disable initial focus in modals #43743

jnowakow commented Jun 14, 2024 •

edited by mountiny

Loading

melvin-bot bot commented Jun 14, 2024

jnowakow Jun 14, 2024

mountiny left a comment

parasharrajat commented Jun 14, 2024

mountiny commented Jun 14, 2024

parasharrajat commented Jun 14, 2024

parasharrajat commented Jun 14, 2024

parasharrajat commented Jun 14, 2024 •

edited

Loading

parasharrajat left a comment •

edited

Loading

mountiny left a comment

OSBotify commented Jun 14, 2024

OSBotify commented Jun 14, 2024

OSBotify commented Jun 14, 2024

rojiphil Aug 3, 2024

hungvu193 Nov 6, 2024

[CP Staging] Disable initial focus in modals #43743

[CP Staging] Disable initial focus in modals #43743

Conversation

jnowakow commented Jun 14, 2024 • edited by mountiny Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 14, 2024

jnowakow Jun 14, 2024

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

parasharrajat commented Jun 14, 2024

mountiny commented Jun 14, 2024

parasharrajat commented Jun 14, 2024

parasharrajat commented Jun 14, 2024

parasharrajat commented Jun 14, 2024 • edited Loading

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

parasharrajat left a comment • edited Loading

Choose a reason for hiding this comment

Reviewer Checklist

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 14, 2024

OSBotify commented Jun 14, 2024

OSBotify commented Jun 14, 2024

rojiphil Aug 3, 2024

Choose a reason for hiding this comment

hungvu193 Nov 6, 2024

Choose a reason for hiding this comment

jnowakow commented Jun 14, 2024 •

edited by mountiny

Loading

parasharrajat commented Jun 14, 2024 •

edited

Loading

parasharrajat left a comment •

edited

Loading