[HOLD for payment 2023-08-24] [$1000] Web - Pressing space key applies focus to composer & scrolls comments at the same time

[kbecciv]

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 a report that has multiple, scrollable comments
2. Scroll to the bottom of comments
3. Remove focus from the main composer
4. Press 'Space' key

Expected Result:

The composer should not be focused and the report page should be scrolled.

Actual Result:

Composer is focused & report is scrolled making the function of space key less predictable.

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: 1.3.44-0
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

Screencast.from.2023-07-24.13-57-13.mp4

Recording.3885.mp4

Expensify/Expensify Issue URL:
Issue reported by: @Natnael-Guchima
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1690196594809449

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~0150e7ff18d1f62eb0
• Upwork Job ID: 1683892863293607936
• Last Price Increase: 2023-07-25
• Automatic offers:
• samh-nl | Contributor | 25928554
• Natnael-guchima | Reporter | 25928556

[melvin-bot]

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

[samh-nl]

Proposal

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

Pressing space in a report applies focus to the composer and scrolls comments.

What is the root cause of that problem?

The focusComposerOnKeyPress function (ReportActionCompose.js) is used to place the focus in the composer when a key press event occurs. However, the default behavior of scrolling is still continued.

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

To prevent focusing the composer when space is pressed, we can add a condition to focusComposerOnKeyPress similar to how other keys such as Enter and Shift are ignored.

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

Lines 721 to 724 in c6dd3d9

	// If the key pressed is non-character keys like Enter, Shift, ... do not focus
	if (e.key.length > 1) {
	return;
	}

What alternative solutions did you explore? (Optional)

Alternatively, if it's desired that scrolling is blocked but the focusing behavior is maintained, we should add e.preventDefault() right before this.focus() in the focusComposerOnKeyPress function.

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

Line 736 in c6dd3d9

this.focus();

[trjExpensify]

@mountiny @JmillsExpensify I found this somewhat similar issue when looking into this one. It's similar in that it's an issue with clicking the space bar. In terms of expected behaviour, I would think we scroll the chat page and don't focus the composer in this case here. Would you agree with that?

[mountiny]

@trjExpensify I agree the expected behaviour should be no focus and just scroll down

[trjExpensify]

Cool, updating the OP's expected behaviour to make that clear. 👍 Moving on!

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~0150e7ff18d1f62eb0

[melvin-bot]

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

[melvin-bot]

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

[robertKozik]

@samh-nl could you update your proposal to be in line with the expected behaviour as was stated here. I see that you stated it inside the alternative solutions, but I want this to be more clear as it should be go-to solution

[JmillsExpensify]

In terms of expected behaviour, I would think we scroll the chat page and don't focus the composer in this case here. Would you agree with that?

I agree with this as well.

[samh-nl]

@robertKozik Thank you, I have re-arranged the proposal according to the updated expected behavior.

[robertKozik]

Thank you @samh-nl . Your solution is straightforward and is in line with expected behaviour.

I would choose @samh-nl proposal

🎀 👀 🎀 C+ reviewed

[melvin-bot]

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

[saalimzafar]

Proposal

Problem Statement:

Pressing the space key applies focus to the composer and scrolls through comments simultaneously, leading to an undesirable user experience.

Root Cause:

The root cause of this issue is that the function focusComposerOnKeyPress(e), responsible for handling keypress events, lacks a specific condition to prevent focusing the composer and performing simultaneous comment scrolling when the space key is pressed.

Proposed Changes:

To address the problem, I propose updating the focusComposerOnKeyPress(e) function to include a proper handling mechanism for the space key. By incorporating the necessary condition, we can prevent focusing the composer and avoid triggering the comment scrolling action when users press the space key.

Alternative Solution:

NA

Please review and consider this proposal to resolve the issue.

[robertKozik]

Thanks, @saalimzafar, for your proposal, but the other one has already been selected (here). Your proposal suggests the same fix as the chosen one.

bumping @grgia to review and assign contributor

[saalimzafar]

It's okay @robertKozik

[trjExpensify]

@grgia can you give this a secondary review please so we can keep it moving?

[melvin-bot]

📣 @Natnael-Guchima 🎉 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

[grgia]

Thanks for the bump, I got a chance to review and @samh-nls proposal looks good, thank you!

[saalimzafar]

Hi @grgia
I want to report a bug which I'm unable to do via github issue, I've already sent the emails to constributors but got no response. Can you help me if possible?

[robertKozik]

Hi @saalimzafar you can submit bug reports via #expensify-bugs channel on slack

[saalimzafar]

It seems that my invitation is not getting accepted @robertKozik
I already send the emails but no response so far.

[samh-nl]

PR is ready for review: #24162

[trjExpensify]

PR is still in review, @grgia is back this week.

[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 @samh-nl got assigned: 2023-08-03 14:48:18 Z
• when the PR got merged: 2023-08-14 20:14:05 UTC
• days elapsed: 7

On to the next one 🚀

[samh-nl]

Thanks all. Unsure if this makes a difference, but perhaps worth considering the OOO (I think I've seen precedence on this, but correct me if wrong):

Day 0 (Thu, Aug 3) - Assigned
Day 1 (Fri, Aug 4) - PR ready for review
Day 2 (Mon, Aug 7) - PR reviewed by @robertKozik

[trjExpensify]

Yeah, we take into account things like the weekend and a delay on our internal review.

[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.54-13 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• fix: do not focus composer when space is pressed #24162

If no regressions arise, payment will be issued on 2023-08-24. 🎊

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:

• @robertKozik does not require payment (Contractor)
• @samh-nl requires payment offer (Contributor)

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:

• [@robertKozik] The PR that introduced the bug has been identified. Link to the PR:
• [@robertKozik] 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:
• [@robertKozik] 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:
• [@robertKozik] Determine if we should create a regression test for this bug.
• [@robertKozik] 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.
• [@trjExpensify] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[trjExpensify]

👋 @robertKozik can you complete the checklist so we're ready to make payments here?

Confirming payments as follows:

$250 to @Natnael-Guchima for the bug report
$1,500 to @samh-nl for the fix + #urgency bonus
@robertKozik C+ payment will be handled separately.

Note: Urgency bonus being applied taking into account weekend/internal delay noted here.

[robertKozik]

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:

• [@robertKozik] The PR that introduced the bug has been identified. Link to the PR: 16098 — selecting chat message and pressing any key focus the message instead of switch the focus to the composer #21583
• [@robertKozik] 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/21583/files#r1302944466
• [@robertKozik] 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 - it was rather unconsidered case of the PR, so I don't think we should extend the checklist or anything
• [@robertKozik] Determine if we should create a regression test for this bug. N/A - same as above
• [@robertKozik] 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. N/A

[trjExpensify]

Okay perfect, thanks for confirming!

I'm going to be out of pocket tomorrow, so settled up with @Natnael-Guchima & @samh-nl today. Closing this out, thanks everyone!