[C+ Checklist Needs Completion] [$250] [Search v2.5] - Unable to perform search by hitting Enter on search bar when expense is selected

@eh2077

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: 9.0.53-1
Reproducible in staging?: Y
Reproducible in production?: Y
If this was caught on HybridApp, is this reproducible on New Expensify Standalone?: N/A
If this was caught during regression testing, add the test name, ID and link from TestRail: N/A
Email or phone of affected tester (no customers): applausetester+kh1610015@applause.expensifail.com
Issue reported by: Applause - Internal Team

Action Performed:

Go to staging.new.expensify.com
Go to Search
Click Filters
Apply any filter that will return results
Select an expense via checkbox
Click on the search input field
Type anything and hit Enter

Expected Result:

App will perform a new search

Actual Result:

The dropdown button is expanded

Workaround:

Unknown

Platforms:

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

Screenshots/Videos

Add any screenshot/video evidence

Bug6644670_1729784811459.20241024_234027.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

Upwork Job URL: https://www.upwork.com/jobs/~021854660565820716226
Upwork Job ID: 1854660565820716226
Last Price Increase: 2024-11-07
Automatic offers:

Krishna2323 | Contributor | 104870980

Issue Owner

Current Issue Owner: @eh2077

@anmurali

Triggered auto assignment to @anmurali (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

@anmurali

@anmurali FYI I haven't added the External label as I wasn't 100% sure about this issue. Please take a look and add the label if you agree it's a bug and can be handled by external contributors

Edited by proposal-police: This proposal was edited at 2024-10-24 19:31:51 UTC.

Proposal 

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

Search - Unable to perform search by hitting Enter on search bar when expense is selected

What is the root cause of that problem?

pressOnEnter prop is passed, so the enter press is caught by the button.

App/src/components/Search/SearchPageHeader.tsx

Line 367 in 476ad6b

pressOnEnter

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

We have several options to solve this.

We can remove the pressOnEnter prop.
We can use useActiveElementRole and pass false to pressOnEnter when activeElementRole is presentation.

    const activeElementRole = useActiveElementRole();
    const disableEnterShortcut = activeElementRole && [CONST.ROLE.PRESENTATION].includes(activeElementRole as 'presentation');

Through ref forwarding, we can get the input ref of the input in SearchRouterInput and then we can use textInputRef.current?.isFocused() to disabled the pressOnEnter prop. We might also need to use useEffect to keep the updated value of textInputRef.current?.isFocused().
If needed, we can also remove pressOnEnter prop from other pages like workspace categories, tags, etc.

What alternative solutions did you explore? (Optional)

In the useKeyboardShortcut config we can add captureOnInputs: false.

App/src/components/Button/index.tsx

Lines 175 to 184 in 32d4ddf

    
           const config = useMemo( 
        
               () => ({ 
        
                   isActive: pressOnEnter && !shouldDisableEnterShortcut && (isFocused || isPressOnEnterActive), 
        
                   shouldBubble: allowBubble, 
        
                   priority: enterKeyEventListenerPriority, 
        
                   shouldPreventDefault: false, 
        
               }), 
        
               // eslint-disable-next-line react-compiler/react-compiler, react-hooks/exhaustive-deps 
        
               [shouldDisableEnterShortcut, isFocused], 
        
           );

Or we can introduce a new prop captureOnInputs and then pass it from SearchPageHeader > ButtonWithDropdownMenu > Button.
Else we can make the default value false.

App/src/hooks/useKeyboardShortcut.ts

Line 31 in 32d4ddf

captureOnInputs = true,

Result

Proposal

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

Search - Unable to perform search by hitting Enter on search bar when expense is selected

What is the root cause of that problem?

We have set pressOnEnter on the drop down button and in side the button we already have a code that disable the shortcut based on the active element role but it only disables it if the active element is presentation, which is correct

App/src/components/Button/index.tsx

Line 163 in f46bce0

    
           const shouldDisableEnterShortcut = useMemo(() => accessibilityRoles.includes(activeElementRole ?? '') && activeElementRole !== CONST.ROLE.PRESENTATION, [activeElementRole]);

but we set our text inputs role as presentation

App/src/components/Search/SearchRouter/SearchRouterInput.tsx

Line 99 in f46bce0

role={CONST.ROLE.PRESENTATION}

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

I propose two options

We can give the text input a proper role like textbox
We will need to add the role here

        TEXTBOX: 'textbox',

Along with active role element management we can keep track of whether a text input is focused. Here

App/src/components/ActiveElementRoleProvider/index.tsx

Lines 9 to 11 in f46bce0

    
           const [activeRoleRef, setRole] = useState<string | null>(document?.activeElement?.role ?? null); 
        
           const handleFocusIn = () => {

const [isTextInputFocused, setIsTextInputFocused] = useState<boolean | null>(null);
    const handleFocusIn = () => {
        setRole(document?.activeElement?.role ?? null);
        setIsTextInputFocused(['INPUT', 'TEXTAREA'].includes(document.activeElement?.nodeName ?? ''));
    };

....


    const value = React.useMemo(
        () => ({
            role: activeRoleRef,
            isTextInputFocused,
        }),
        [activeRoleRef, isTextInputFocused],

then

const useIsTextInputFocused = () => {
    const {isTextInputFocused} = useContext(ActiveElementRoleContext);
    return isTextInputFocused;
};

App/src/components/Button/index.tsx

Line 163 in f46bce0

    
           const shouldDisableEnterShortcut = useMemo(() => accessibilityRoles.includes(activeElementRole ?? '') && activeElementRole !== CONST.ROLE.PRESENTATION, [activeElementRole]);

const isTextInputFocused = useIsTextInputFocused();
    const shouldDisableEnterShortcut = useMemo(
        () => isTextInputFocused || (accessibilityRoles.includes(activeElementRole ?? '') && activeElementRole !== CONST.ROLE.PRESENTATION),
        [activeElementRole, isTextInputFocused],
    );

What alternative solutions did you explore? (Optional)

PROPOSAL UPDATED

Added alternative solution

@anmurali

@anmurali Eep! 4 days overdue now. Issues have feelings too...

@luacmartins

I don't think it's very clear how this should behave. You are changing the filter criteria, but there is a selected expense. Should the filter results update? What if the selected expense no longer matches the criteria? cc @luacmartins @trjExpensify @JmillsExpensify

@JmillsExpensify

I imagine we'd just clear the selection and perform the new Search. cc @JmillsExpensify for your input as well.

Reviewing label has been removed, please complete the "BugZero Checklist".

@Krishna2323

The solution for this issue has been 🚀 deployed to production 🚀 in version 9.0.62-4 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

fix: Search - Unable to perform search by hitting Enter on search bar when expense is selected. #52451

If no regressions arise, payment will be issued on 2024-11-22. 🎊

For reference, here are some details about the assignees on this issue:

@Krishna2323 requires payment automatic offer (Contributor)
@eh2077 requires payment through NewDot Manual Requests

@eh2077

@eh2077 @greg-schroeder @eh2077 The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed. Please copy/paste the BugZero Checklist from here into a new comment on this GH and complete it. If you have the K2 extension, you can simply click: [this button]

@Krishna2323

Payment summary:

Contributor: @Krishna2323 - $250 - Upwork
C+: @eh2077 - $250 - Paid via NewDot manual request

Next up @eh2077 can you complete the checklist? Thank you!

BugZero Checklist:

[Contributor] Classify the bug:

Bug classification

Source of bug:

1a. Result of the original design (eg. a case wasn't considered)
1b. Mistake during implementation
1c. Backend bug
1z. Other:

Where bug was reported:

2a. Reported on production
2b. Reported on staging (deploy blocker)
2c. Reported on both staging and production
2d. Reported on a PR
2z. Other:

Who reported the bug:

[Contributor] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake.

Link to comment: https://github.com/Expensify/App/pull/49462/files#r1855460915
[Contributor] If the regression was CRITICAL (e.g. interrupts a core flow) A discussion in #expensify-open-source has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner.

Link to discussion: N/A
[Contributor] If it was decided to create a regression test for the bug, please propose the regression test steps using the template below to ensure the same bug will not reach production again.

Regression Test Proposal Template

[BugZero Assignee] Create a GH issue for creating/updating the regression test once above steps have been agreed upon.

Link to issue:

Regression Test Proposal

Precondition:

N/A

Test:

Go to Search
Click Filters
Apply any filter that will return results
Select an expense via checkbox
Click on the search input field
Type anything and hit Enter
Verify search is submitted

Do we agree 👍 or 👎

We're adding tests as part of the project wrap up, so no need to do that now,

@luacmartins

Okay, thanks @luacmartins

Requested payment in NewDot

@eh2077

$250 approved for @eh2077

Navigation Menu

Repository navigation

[C+ Checklist Needs Completion] [$250] [Search v2.5] - Unable to perform search by hitting Enter on search bar when expense is selected #51427

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

Screenshots/Videos

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)

Result

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 UPDATED

40 remaining items

BugZero Checklist:

Regression Test Proposal

Precondition:

Test:

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	const config = useMemo(
	() => ({
	isActive: pressOnEnter && !shouldDisableEnterShortcut && (isFocused \|\| isPressOnEnterActive),
	shouldBubble: allowBubble,
	priority: enterKeyEventListenerPriority,
	shouldPreventDefault: false,
	}),
	// eslint-disable-next-line react-compiler/react-compiler, react-hooks/exhaustive-deps
	[shouldDisableEnterShortcut, isFocused],
	);

	const [activeRoleRef, setRole] = useState<string \| null>(document?.activeElement?.role ?? null);

	const handleFocusIn = () => {

[C+ Checklist Needs Completion] [$250] [Search v2.5] - Unable to perform search by hitting Enter on search bar when expense is selected #51427

Description

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

Screenshots/Videos

Activity

melvin-bot commented on Oct 24, 2024

lanitochka17 commented on Oct 24, 2024

Krishna2323 commented on Oct 24, 2024

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)

Result

FitseTLT commented on Oct 24, 2024

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)

Krishna2323 commented on Oct 24, 2024

PROPOSAL UPDATED

melvin-bot commented on Oct 29, 2024

anmurali commented on Oct 29, 2024

luacmartins commented on Nov 4, 2024

40 remaining items

melvin-bot commented on Nov 15, 2024

melvin-bot commented on Nov 15, 2024

melvin-bot commented on Nov 15, 2024

greg-schroeder commented on Nov 21, 2024

eh2077 commented on Nov 24, 2024

BugZero Checklist:

Regression Test Proposal

Precondition:

Test:

luacmartins commented on Nov 25, 2024

greg-schroeder commented on Nov 26, 2024

eh2077 commented on Nov 26, 2024

JmillsExpensify commented on Nov 27, 2024

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions

Proposal 

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