[HOLD for payment 2023-09-20] [$1000] FAB menu - Pressing Enter doesn't open the selected option page

[izarutskaya]

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

---

Action Performed:

1. Click plus button.
2. Use arrow up to select the option, press Enter.
3. Notice that sometimes it doesn't open the page after pressing Enter.

Expected Result:

After pressing Enter, it should open selected option.

Actual Result:

Pressing Enter doesn't open the selected option page

Workaround:

Unknown

Platforms:

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

• Android / native
• Android / Chrome
• iOS / native
• iOS / Safari
• MacOS / Chrome / Safari
• MacOS / Desktop

Version Number: v1.3.57-5

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

Notes/Photos/Videos: Any additional supporting documentation

Screen.Recording.2023-08-22.At.15.43.41.mp4

bandicam.2023-08-29.01-40-15-309.mp4

Expensify/Expensify Issue URL:

Issue reported by: @hungvu193

Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1692694374144279

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~013ca232e37db3db0d
• Upwork Job ID: 1696891737295454208
• Last Price Increase: 2023-08-30
• Automatic offers:
• jjcoffee | Reviewer | 26517050
• dukenv0307 | Contributor | 26517052
• hungvu193 | Reporter | 26517053

[melvin-bot]

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

[melvin-bot]

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

[dukenv0307]

Proposal

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

FAB menu - Pressing Enter doesn't open the selected option page

What is the root cause of that problem?

we're updating we're updating selectedItemIndex state here

App/src/components/PopoverMenu/index.js

Line 57 in 9398754

setSelectedItemIndex(index);

And when the modal hides, we should execute the onSelected of the corresponding item

App/src/components/PopoverMenu/index.js

Lines 79 to 85 in 9398754

	onModalHide={() => {
	setFocusedIndex(-1);
	if (selectedItemIndex !== null) {
	props.menuItems[selectedItemIndex].onSelected();
	setSelectedItemIndex(null);
	}
	}}

But at that time, the selectedItemIndex is not updated yet, so we can't open the RHP

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

We don't use selectedItemIndex for rendering purpose, so we just need to use useRef

    const selectedItemIndex = useRef(null);

and update other places to use selectedItemIndex.current

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~013ca232e37db3db0d

[melvin-bot]

Current assignee @flaviadefaria is eligible for the External assigner, not assigning anyone new.

[melvin-bot]

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

[joh42]

Proposal

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

The first time we press enter with the FAB menu, the page of the selected option is not opened.

What is the root cause of that problem?

The root cause of this is that when an option has been selected, we first set selectedItemIndex in the selectItem function:

App/src/components/PopoverMenu/index.js

Lines 54 to 58 in a644050

	const selectItem = (index) => {
	const selectedItem = props.menuItems[index];
	props.onItemSelected(selectedItem, index);
	setSelectedItemIndex(index);
	};

And then we actually open the selected item when the modal closes:

App/src/components/PopoverMenu/index.js

Lines 79 to 85 in a644050

	onModalHide={() => {
	setFocusedIndex(-1);
	if (selectedItemIndex !== null) {
	props.menuItems[selectedItemIndex].onSelected();
	setSelectedItemIndex(null);
	}
	}}

But the selectedItemIndex does not have time to update before the modal closes. This is why the wrong option is opened if we select another option and press enter - selectedItemIndex has been set to the old index but not the new one.

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

Unless I have missed something, there is no reason to split the code this way.

selectedItemIndex is only used by the selectItem function and onModalHide. And selectItem is always called when an item is selected (IE both when we select by pressing enter and when a MenuItem fires onPress).

We can clean things up quite a bit by calling the selected option's onSelected method right in the selectItem function.

This way, we do not have to worry about if selectedItemIndex has been updated to the correct value, because we can remove selectedItemIndex altogether.

The steps to implement this would be:

1. Remove the definition of selectedItemIndex
2. Replace setSelectedItemIndex with selectedItem.onSelected() in the selectItem function
3. Remove the conditional checking if selectedItemIndex is not equal to null in onModalHide

It's worth noting that we still want to clear the focused index in onModalHide, in case the user closed the FAB without selecting any of the options.

selectItem would now look like this:

const selectItem = (index) => {
    const selectedItem = props.menuItems[index];
    props.onItemSelected(selectedItem, index);
    selectedItem.onSelected();
};

And onModalHide like this:

onModalHide={() => {
    setFocusedIndex(-1);
}}

What alternative solutions did you explore? (Optional)

[davewish]

Proposal

---

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

In the FAB menu , when Enter is pressed , it does not open selected Item

What is the root cause of that problem?

The root cause of the issue is in the selectItem function , onSelectedItem Prop , which call hideCreateMenu but it does not call onSelect function , then selectedItemIndex is set .

App/src/components/PopoverMenu/index.js

Lines 54 to 58 in c20c387

	const selectItem = (index) => {
	const selectedItem = props.menuItems[index];
	props.onItemSelected(selectedItem, index);
	setSelectedItemIndex(index);
	};

App/src/pages/home/sidebar/SidebarScreen/FloatingActionButtonAndPopover.js

Lines 128 to 129 in c20c387

	const hideCreateMenu = useCallback(
	() => {

when second time enter is pressed , onModalHide is executed ,selectedItemIndex with previous item .

App/src/components/PopoverMenu/index.js

Lines 79 to 85 in c20c387

	onModalHide={() => {
	setFocusedIndex(-1);
	if (selectedItemIndex !== null) {
	props.menuItems[selectedItemIndex].onSelected();
	setSelectedItemIndex(null);
	}
	}}

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

we should update the selectItem function as follow , selectedItemIndex state is no needed .

 const selectItem = (index) => {
        const selectedItem = props.menuItems[index];
        selectedItem.onSelected()
        
    };

and update the on onModalHide

   onModalHide={() => {
                setFocusedIndex(-1);
            }}

What alternative solutions did you explore? (Optional)

N/A

[jjcoffee]

Reviewing tomorrow!

[jjcoffee]

Sorry higher priority PR review got in the way, will come back to this on Monday.

[flaviadefaria]

Waiting for @jjcoffee's review today/tomorrow.

[jjcoffee]

Happy to go with @dukenv0307's proposal! It has the correct RCA and a good solution that cuts back usage of useState which we like!

🎀👀🎀 C+ reviewed

[melvin-bot]

Triggered auto assignment to @Beamanator, see https://stackoverflow.com/c/expensify/questions/7972 for more details.

[melvin-bot]

📣 @jjcoffee 🎉 An offer has been automatically sent to your Upwork account for the Reviewer role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job

[melvin-bot]

📣 @dukenv0307 🎉 An offer has been automatically sent to your Upwork account for the Contributor role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job
Please accept the offer and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Keep in mind: Code of Conduct | Contributing 📖

[melvin-bot]

📣 @hungvu193 🎉 An offer has been automatically sent to your Upwork account for the Reporter role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job

[dukenv0307]

@jjcoffee The PR is ready for review

[jjcoffee]

Thanks, reviewing tomorrow!

[melvin-bot]

Based on my calculations, the pull request did not get merged within 3 working days of assignment. Please, check out my computations here:

• when @dukenv0307 got assigned: 2023-09-06 00:35:27 Z
• when the PR got merged: 2023-09-11 03:29:51 UTC
• days elapsed: 3

On to the next one 🚀

[melvin-bot]

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

[melvin-bot]

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

• fix: pressing enter doesn't open the selected option page #26743

If no regressions arise, payment will be issued on 2023-09-20. 🎊

After the hold period is over and BZ checklist items are completed, please complete any of the applicable payments for this issue, and check them off once done.

• External issue reporter
• Contributor that fixed the issue
• Contributor+ that helped on the issue and/or PR

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

• @jjcoffee requires payment offer (Reviewer)
• @dukenv0307 requires payment offer (Contributor)
• @hungvu193 requires payment offer (Reporter)

As a reminder, here are the bonuses/penalties that should be applied for any External issue:

• Merged PR within 3 business days of assignment - 50% bonus
• Merged PR more than 9 business days after assignment - 50% penalty

[melvin-bot]

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@jjcoffee] The PR that introduced the bug has been identified. Link to the PR:
• [@jjcoffee] 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:
• [@jjcoffee] A discussion in #expensify-bugs 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:
• [@jjcoffee] Determine if we should create a regression test for this bug.
• [@jjcoffee] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.
• [@flaviadefaria] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[jjcoffee]

• The PR that introduced the bug has been identified. Link to the PR: Fix: Add attachments and Delete workspace buttons are not responsive #19339
• 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: Fix: Add attachments and Delete workspace buttons are not responsive #19339 (comment)
• A discussion in #expensify-bugs 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
• Determine if we should create a regression test for this bug. Yes
• If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.
  Fix: Add attachments and Delete workspace buttons are not responsive #19339

[jjcoffee]

Regression Test Proposal

1. Open the FAB.
2. Use the keyboard arrows to select an option, and press Enter.
3. Verify that the correct page opens in the RHP.

Do we agree 👍 or 👎

[jjcoffee]

Just noting that this one was approved within 3WD, so technically due the timeliness bonus (slight extra delay was due to the merge freeze). cc @flaviadefaria

[melvin-bot]

@Beamanator, @jjcoffee, @flaviadefaria, @dukenv0307 Huh... This is 4 days overdue. Who can take care of this?

[flaviadefaria]

For reference, here are some details about the assignees on this issue:
@jjcoffee requires payment offer (Reviewer)
@dukenv0307 requires payment offer (Contributor)
@hungvu193 requires payment offer (Reporter)

Payment details:
@jjcoffee = $1000 + 50% = $1500
@dukenv0307 =$1000 + 50% = $1500
@hungvu193 = $50

[flaviadefaria]

Everyone has been paid.

[hungvu193]

Everyone has been paid.

@flaviadefaria Can you please update the reporting bonus to 250$?

[flaviadefaria]

But the offer was initially sent and accepted with $50, which is the new amount we're paying.

[hungvu193]

Yup, that's the bot mistake, this issue was opened on 29 Aug, the bounty was adjust after 31 Aug. So it should be 250$ for the bounty.

[flaviadefaria]

Got it, I have paid $50 already so sent you a new offer fo the remaining $200.

[hungvu193]

Got it, I have paid $50 already so sent you a new offer fo the remaining $200.

Thank you 😄

[flaviadefaria]

Everyone has been paid, so closing this!