[$500] Compose Box - Focus not lost from composer on LHN popup open

@mallenexpensify

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

Version Number: 1.4.11-6
Reproducible in staging?: Y
Reproducible in production?: Y
If this was caught during regression testing, add the test name, ID and link from TestRail:
Email or phone of affected tester (no customers):
Logs: https://stackoverflow.com/c/expensify/questions/4856
Expensify/Expensify Issue URL:
Issue reported by: Applause - Internal Team
Slack conversation:

Action Performed:

Open the app
Open any report and send any message
Focus on composer
Click on plus besides the composer to open Actions popup
Right on any chat in LHN to open popup on LHN
Observe that even though popup is open in LHN, app still focuses on composer

Expected Result:

App should not focus back on composer whenever any popup is open

Actual Result:

App focuses back on composer when we open actions popup and open any right click popup in LHN

Workaround:

Unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

Screenshots/Videos

Add any screenshot/video evidence

Bug6310077_1702365494694.windows_chrome_-_focus_back_cursor_issue.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

Upwork Job URL: https://www.upwork.com/jobs/~0123ed583fdc5774f0
Upwork Job ID: 1734947870117650432
Last Price Increase: 2023-12-13
Automatic offers:

bernhardoj | Contributor | 28067465

Issue Owner

Current Issue Owner: @mallenexpensify

@mallenexpensify

Triggered auto assignment to @mallenexpensify (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

Job added to Upwork: https://www.upwork.com/jobs/~0123ed583fdc5774f0

Bug0 Triage Checklist (Main S/O)

This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
This bug is not a duplicate report (check E/App issues and #expensify-bugs)
- If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead
This bug is reproducible using the reproduction steps in the OP. S/O
- If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
- If the reproduction steps aren't clear and you determine the correct steps, please update the OP.
This issue is filled out as thoroughly and clearly as possible
- Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

@mananjadhav

Triggered auto assignment to Contributor-plus team member for initial proposal review - @mananjadhav (External)

Proposal

Please re-state the problem that we are trying to solve in this issue.

App focuses back on composer when we open actions popup and open any right click popup in LHN

What is the root cause of that problem?

When popover is closed, onPopoverMenuClose is called.

App/src/pages/home/report/ReportActionCompose/AttachmentPickerWithMenuItems.js

Line 166 in d6755d6

onMenuClosed();

And then restoreKeyboardState is called which makes the composer focused.

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

Line 193 in d6755d6

const restoreKeyboardState = useCallback(() => {

We already the logic here to blur the active element but the time this function is called, the active element isn't composer.

App/src/components/LHNOptionsList/OptionRowLHN.js

Line 195 in 8fa65ec

if (DomUtils.getActiveElement()) {

What changes do you think we should make in order to solve the problem?

We should pass event to onPopoverMenuClose and pass it to onMenuClosed. And then in restoreKeyboardState, we should check if the event.target is a clickable element, we will not focus the composer.

What alternative solutions did you explore? (Optional)

We can add InteractionManager.runAfterInteractions here to wait the composer focus and then blur it.

App/src/components/LHNOptionsList/OptionRowLHN.js

Line 195 in 8fa65ec

if (DomUtils.getActiveElement()) {

Proposal

Please re-state the problem that we are trying to solve in this issue.

The composer is focused if we close the add action popover by opening another popover.

What is the root cause of that problem?

Every time the add action popover closes, we call restoreKeyboardState which will refocus the keyboard.

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

Lines 193 to 199 in d6755d6

    
           const restoreKeyboardState = useCallback(() => { 
        
               if (!isKeyboardVisibleWhenShowingModalRef.current || isNextModalWillOpenRef.current) { 
        
                   return; 
        
               } 
        
               focus(); 
        
               isKeyboardVisibleWhenShowingModalRef.current = false; 
        
           }, []);

When we right-click the LHN item or chat report message, it will:

Close the add action popover
Open the lhn or report popover
Refocus the composer

The composer focus will call focusComposerWithDelay

App/src/pages/home/report/ReportActionCompose/ComposerWithSuggestions/ComposerWithSuggestions.js

Lines 399 to 401 in d6755d6

    
           const focus = useCallback((shouldDelay = false) => { 
        
               focusComposerWithDelay(textInputRef.current)(shouldDelay); 
        
           }, []);

In focusComposerWithDelay, we already have a logic to prevent the focus from happening if the emoji picker is visible. That's why this doesn't happen when we open the emoji picker and then open the report popover.

App/src/libs/focusComposerWithDelay.ts

Lines 14 to 19 in d6755d6

    
           return (shouldDelay = false) => { 
        
               // There could be other animations running while we trigger manual focus. 
        
               // This prevents focus from making those animations janky. 
        
               if (!textInput || EmojiPickerAction.isEmojiPickerVisible()) { 
        
                   return; 
        
               }

What changes do you think we should make in order to solve the problem?

Don't focus if the report/LHN popover is visible. Both use the same component, PopoverReportActionContextMenu.

Expose a new variable from PopoverReportActionContextMenu called isVisible

App/src/pages/home/report/ContextMenu/PopoverReportActionContextMenu.js

Lines 272 to 282 in d6755d6

    
           useImperativeHandle(ref, () => ({ 
        
               showContextMenu, 
        
               hideContextMenu, 
        
               showDeleteModal, 
        
               hideDeleteModal, 
        
               isActiveReportAction, 
        
               instanceID, 
        
               runAndResetOnPopoverHide, 
        
               clearActiveReportAction, 
        
               contentRef, 
        
           }));

isVisible: isPopoverVisible

In focusComposerWithDelay, early return if PopoverReportActionContextMenu.isVisible() is true.

import * as ReportActionContextMenu from '@pages/home/report/ContextMenu/ReportActionContextMenu';

if (!textInput || EmojiPickerAction.isEmojiPickerVisible() || ReportActionContextMenu.isVisible()) {
    return;
}

What alternative solutions did you explore? (Optional)

I notice that this also happens if we:

Open add action (+) popover
Press the three-dots menu
The composer will be focused

To solve this for all popover, we can prevent the focus if any of the popover is showing.

To do that, in ComposerWithSuggestions, get the popover context visible state.

const {isOpen} = React.useContext(PopoverContext);

const focus = useCallback((shouldDelay = false) => {
    if (isOpen) {
        return;
    }

@bernhardoj

I liked @bernhardoj's proposal to fix this with ComposerWithSuggestions's popover context visible state.

🎀 👀 🎀 C+ reviewed

The PR we were holding on closed without being fixed. I threw a retest-weekly on here to see if the bug exists six months later.

Try to refactor the logic regarding refocusing when the modal is closed

@mallenexpensify

@mallenexpensify @lanitochka17 Are we still retesting this on weekly cadence?

This bug still exists. I remember there was another PR that added a focus trap feature, which confines the focus within the popover(or RHP?), but it seems to be ineffective in this situation. 🤔

test.mp4

@jasperhuangg

@jasperhuangg retests take a weekish. @ntdiary and I are both able to reproduce so the bug still exists. I think we need to decide between

Close it cuz it's a minor bug that doesn't affect functionality (I might actually prefer to be able to type and have the text fill the compose box vs nothing happening if I type)
Review existing proposals to see if we want to accept any
Add Help Wanted to get more proposals
Something.

I don't think we need/want to increase the price though

I remember our app has an interesting feature: even if the main input box isn't focused, pressing the keyboard will still automatically focus it, allowing for smooth typing. 😄

demo.mp4

@ntdiary

Thanks @ntdiary , I'm going to close, comment/reopen if you disagree.

Navigation Menu

Repository navigation

[$500] Compose Box - Focus not lost from composer on LHN popup open #32970

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

Screenshots/Videos

Bug0 Triage Checklist (Main S/O)

Proposal

Please re-state the problem that we are trying to solve in this issue.

What is the root cause of that problem?

What changes do you think we should make in order to solve the problem?

What alternative solutions did you explore? (Optional)

Proposal

Please re-state the problem that we are trying to solve in this issue.

What is the root cause of that problem?

What changes do you think we should make in order to solve the problem?

What alternative solutions did you explore? (Optional)

96 remaining items

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	const restoreKeyboardState = useCallback(() => {
	if (!isKeyboardVisibleWhenShowingModalRef.current \|\| isNextModalWillOpenRef.current) {
	return;
	}
	focus();
	isKeyboardVisibleWhenShowingModalRef.current = false;
	}, []);

	const focus = useCallback((shouldDelay = false) => {
	focusComposerWithDelay(textInputRef.current)(shouldDelay);
	}, []);

	return (shouldDelay = false) => {
	// There could be other animations running while we trigger manual focus.
	// This prevents focus from making those animations janky.
	if (!textInput \|\| EmojiPickerAction.isEmojiPickerVisible()) {
	return;
	}

	useImperativeHandle(ref, () => ({
	showContextMenu,
	hideContextMenu,
	showDeleteModal,
	hideDeleteModal,
	isActiveReportAction,
	instanceID,
	runAndResetOnPopoverHide,
	clearActiveReportAction,
	contentRef,
	}));

[$500] Compose Box - Focus not lost from composer on LHN popup open #32970

Description

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

Screenshots/Videos

Activity

melvin-bot commented on Dec 13, 2023

melvin-bot commented on Dec 13, 2023

melvin-bot commented on Dec 13, 2023

Bug0 Triage Checklist (Main S/O)

melvin-bot commented on Dec 13, 2023

dukenv0307 commented on Dec 13, 2023

Proposal

Please re-state the problem that we are trying to solve in this issue.

What is the root cause of that problem?

What changes do you think we should make in order to solve the problem?

What alternative solutions did you explore? (Optional)

bernhardoj commented on Dec 13, 2023

Proposal

Please re-state the problem that we are trying to solve in this issue.

What is the root cause of that problem?

What changes do you think we should make in order to solve the problem?

What alternative solutions did you explore? (Optional)

mananjadhav commented on Dec 17, 2023

96 remaining items

mallenexpensify commented on Jun 19, 2024

jasperhuangg commented on Jul 1, 2024

ntdiary commented on Jul 2, 2024

mallenexpensify commented on Jul 3, 2024

ntdiary commented on Jul 3, 2024

mallenexpensify commented on Jul 5, 2024

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions