[HOLD for payment 2023-05-25] [$1000] Emoji gets added in between the text when selecting text and add new emoji by search and enter

[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. Write multiple emojis (any emojis are fine) in compose box
4. Select the emojis and open emoji picker
5. Search for any emoji and press enter to insert the emoji (do not click to select)

Expected Result:

App should remove the emojis as it does normally when we select the emoji by clicking on it.

Actual Result:

App adds emoji in the middle of existing emojis

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.11.2
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

emojis.added.in.middle.of.existing.emojis.on.select.and.add.mp4

Recording.506.mp4

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

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01bf65aebce0e7ee33
• Upwork Job ID: 1655592568939524096
• Last Price Increase: 2023-05-08

[melvin-bot]

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

Emoji gets added in between the text when selecting text and add new emoji by search and enter

What is the root cause of that problem?

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

Lines 534 to 542 in d120f6a

	addEmojiToTextBox(emoji) {
	this.setState(prevState => ({
	selection: {
	start: prevState.selection.start + emoji.length,
	end: prevState.selection.start + emoji.length,
	},
	}));
	this.updateComment(ComposerUtils.insertText(this.comment, this.state.selection, emoji));
	}

When hitting enter on the keyboard, the setState function is executed before ComposerUtils.insertText function is called so that the second param of ComposerUtils.insertText function (selection) is incorrect. This problem doesn't happen when we click by mouse

The root cause is: React may batch multiple setState() calls into a single update for performance. (ref)
When clicking by mouse React doesn't execute immediately and waits to batch multiple setState() calls. But when hitting enter on the keyboard React execute setState immediately

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

We should insert emoji before updating the selection state like this

addEmojiToTextBox(emoji) {
        
        this.updateComment(ComposerUtils.insertText(this.comment, this.state.selection, emoji));
        this.setState(prevState => ({
            selection: {
                start: prevState.selection.start + emoji.length,
                end: prevState.selection.start + emoji.length,
            },
        }));
       
    }

What alternative solutions did you explore? (Optional)

NA

[anmurali]

Cannot reproduce

[dukenv0307]

@anmurali Please try again with these steps:

1. Open the app
2. Open any report
3. Write 2 emojis (any emojis are fine) in compose box
4. Select all emojis
5. open emoji picker
6. Hover any emoji and click enter

My video
https://user-images.githubusercontent.com/129500732/236848003-48cca23f-e786-4072-84fd-21507dcba421.mov

Make sure that you click enter in keyboard to select emoji in step 6

[anmurali]

I did do that, but I selected the emoji with a click rather than by hitting enter

[melvin-bot]

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

[melvin-bot]

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

[melvin-bot]

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

[melvin-bot]

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

[dangrous]

Waiting for proposals

[dukenv0307]

@dangrous I posted a proposal, please help to look at it
cc @mollfpr

[mollfpr]

Thanks @dukenv0307, for the proposal!

Before the PR #17346 we used the selection state before it's update in this file. So it makes sense that we move it early before the new setState.

@dangrous Let's go with @dukenv0307 proposal.

🎀 👀 🎀 C+ reviewed!

[dangrous]

Ah yep, that makes sense to me! Assigning this now!

@dukenv0307 out of curiosity, do you know why does it fire immediately on enter and not on mouse click?

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

• fix/18515: Update comment before setting new state #18814

If no regressions arise, payment will be issued on 2023-05-25. 🎊

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

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:

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

[dangrous]

@mollfpr do you have time to take a look at that checklist? Thanks!

[mollfpr]

[@mollfpr] The PR that introduced the bug has been identified. Link to the PR:

#17346

[@mollfpr] 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:

#17346 (comment)

[@mollfpr] 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:

https://expensify.slack.com/archives/C049HHMV9SM/p1684989964993659

[@mollfpr] Determine if we should create a regression test for this bug.

I think we should; it's easy to miss this kind of bug while testing/review.

[@mollfpr] 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.

Propose regression step

1. Open the app
2. Open any report
3. Write 2 emojis (any emojis are fine) in compose box
4. Select the two above emojis and open emoji picker
5. Hover the mouse over any emoji and hit enter on the keyboard
6. Verify that the before emojis are removed and the new emoji is added
7. 👍 or 👎

[dangrous]

Test looks good to me!

[mollfpr]

Bump @anmurali to help with the payment

[anmurali]

I can't find either of you on Upwork since I only have your GH and Slack profile handles. Asked here

[dukenv0307]

@anmurali here's my profile: https://www.upwork.com/freelancers/~01f5cbe690701118a2
Thanks!

[anmurali]

Added regression test - https://github.com/Expensify/Expensify/issues/288154
Sent offers, waiting to accept to pay

[dhanashree-sawant]

Thanks @anmurali, I have accepted the offer.

[dangrous]

Are we still waiting on the accepted offers, or are we good to close?

[anmurali]

Paid.

[dukenv0307]

hi @anmurali , I think this issue is eligible for the PR timeline bonus, see here, but it seems the payout didn't have it.

Could you help to double check?
Thank you!

[dukenv0307]

@anmurali would you mind checking the above comment? Thanks!

[anmurali]

Added bonus to @dukenv0307 and @mollfpr