[Hold for payment 12-14-2023][$1000] Mention options are not displayed on focus if we cancel add attachment

[kavimuru]

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. Open the app
2. Open any report
3. Type @ to trigger mention options
4. Click on plus and click on add attachment
5. Click on cancel and observe that focus is still in compose box but mention options are not displayed

Expected Result:

App should display mention options (for eligible text) when focus is on compose box

Actual Result:

App does not display mention options when we click on add attachment and cancel it even though focus is on compose box

Workaround:

Can the user still use Expensify without this being fixed? Have you informed them of the workaround?

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: 1.3.38-3
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

mention.option.not.displayed.on.attachment.cancel.mp4

Recording.1216.mp4

Expensify/Expensify Issue URL:
Issue reported by: @dhanashree-sawant
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1688751437804389

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01b41000cdf4fb45bb
• Upwork Job ID: 1677463484044013568
• Last Price Increase: 2023-11-14
• Automatic offers:
• s-alves10 | Contributor | 27685494
• dhanashree-sawant | Reporter | 27685495

[melvin-bot]

Triggered auto assignment to @lschurr (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

[ahmdshrif]

Proposal

Root Cause:

The app currently checks for mention options only when there is a selection change. However, it does not trigger this listener because we focus the text input when the image picker is opened and refocus the text input when the picker loses focus, which will not trigger a selection change because it's already focused.

Proposed Solution:

The proposed solution is simple: we need to avoid focusing the Composer when the image picker is open and only focus it when the picker is closed.

To achieve this, we can implement a picker lifecycle using the following steps:

1. onPickerWillOpen: This event occurs when we click on "add attachment" (sometimes the composer is focused between the click and the picker opening).

2. onPickerDidOpen: This event happens when the window loses focus and the state is "Picker will open."

3. onPickerGetFile: This event triggers if we get a valid file from the picker.

4. onPickerCancel : This event occurs when the window regains focus, indicating that the Picker has been canceled.
   This event also triggers if we receive an invalid file.

I try to implement this in AttachmentPicker so we can use them in other components.
i think we also can now remove the old logic of shouldBlockEmojiCalc this.shouldBlockMentionCalc because we prevent the input form focus in the time of picker open.

the code first implementing can be something like that https://github.com/Expensify/App/compare/main...ahmdshrif:App:fix/calc-mention?expand=1 we can improve it like create a custom hook or HOC to handle picker state but this just POC.

By following this sequence and adding a flag to block the focus in onPickerWillOpen, we ensure that the input won't be focused during the picker cycle. This approach allows the input focus to be triggered correctly when the picker is canceled and no file is obtained from the picker.

Additionally, there is a known issue in Chrome where the onChange event for the file input triggers after the window gets blurred. To address this, we can implement a simple timeout solution. However, an alternative solution for Chrome is to use the showOpenFilePicker API (more information can be found here). This API returns a resolved promise if an image is picked and rejected if the user cancels the picker. but we will need to implement specific code for chrome.

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~01b41000cdf4fb45bb

[melvin-bot]

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

[melvin-bot]

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

[dummy-1111]

Proposal

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

Mention suggestions are not shown on focus if we cancel adding attachment.

What is the root cause of that problem?

Mention suggestions are calculated in onSelectionChange event handler. This event happens when the selection of the text input changes or blurred input gets focused.

When opening the file picker, onTriggerAttachmentPicker is called and isKeyboardVisibleWhenShowingModalRef is set to true.

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

Lines 274 to 282 in e8cb124

	const onTriggerAttachmentPicker = useCallback(() => {
	// Set a flag to block suggestion calculation until we're finished using the file picker,
	// which will stop any flickering as the file picker opens on non-native devices.
	if (willBlurTextInputOnTapOutside) {
	suggestionsRef.current.setShouldBlockSuggestionCalc(true);
	}
	isNextModalWillOpenRef.current = true;
	isKeyboardVisibleWhenShowingModalRef.current = true;
	}, []);

And the popup menu is closed and restoreKeyboardState is called and the input gets focused and isKeyboardVisibleWhenShowingModalRef is set to false

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

Lines 197 to 203 in e8cb124

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

And then the file dialog is opened the input gets blurred. If we cancel the file picker, restoreKeyboardState is called again, but isKeyboardVisibleWhenShowingModalRef is false and the function early returns and focus() is not called.

This is the root cause

Note: I mentioned that focus() isn't called in our case but we can see that the input gets focused after the file dialog is cancelled. How it can be? When the input gets blurred by other window(for instance, a system file dialog in our issue or file browser), the input gets focused when the browser window becomes active again, but onSelectionChange isn't called in this case.

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

This isn't an issue specific to mentions. The same problem exists for emojis. We need to fix both.

1. When menu is closed by selecting Add attachment, don't refocus the text input.
   Update
   

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

   Line 198 in e8cb124

   if (!isKeyboardVisibleWhenShowingModalRef.current) {

   
   to

        if (!isKeyboardVisibleWhenShowingModalRef.current || isNextModalWillOpenRef.current) {

By doing this, we can prevent isKeyboardVisibleWhenShowingModalRef being set to false and the text input getting focused.

2. When file picker is cancelled, we need to set isNextModalWillOpenRef to false
   

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

   Line 386 in e8cb124

   onCanceledAttachmentPicker={restoreKeyboardState}

   
   to

        onCanceledAttachmentPicker={() => {
            isNextModalWillOpenRef.current = false;
            restoreKeyboardState();
        }}

3. We don't need the below code because we don't set focus when opening file picker with step 1. Remove them
   

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

   Lines 275 to 279 in e8cb124

   	// Set a flag to block suggestion calculation until we're finished using the file picker,
   	// which will stop any flickering as the file picker opens on non-native devices.
   	if (willBlurTextInputOnTapOutside) {
   	suggestionsRef.current.setShouldBlockSuggestionCalc(true);
   	}

This works as expected.

Result

22447.mp4

What alternative solutions did you explore? (Optional)