[HOLD for payment 2023-06-02] [$1000] Mention auto-suggester adds extra spaces when same mention is selected

[puneetlath]

Screen.Recording.2023-05-10.at.3.55.29.PM.mov

When you select the same mention again via the auto-suggestion menu extra spaces are added. We shouldn't do that.

@szebniok do you want to take this one?

Reported by @0xmiroslav

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~0179550c85e09022ec
• Upwork Job ID: 1658193553722515456
• Last Price Increase: 2023-05-15

[melvin-bot]

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

[allroundexperts]

Proposal

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

Mention auto suggester adds extra space when same mentioned is selected

What is the root cause of that problem?

The root cause of this problem is that we're always adding an extra space here regardless if the commentAfterAtSignWithMentionRemoved starts with a space.

The same error occurs with emoji selection as well.

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

We need to replace this line with:

`${commentBeforeAtSign}${mentionCode} ${
                commentAfterAtSignWithMentionRemoved.slice(0, 1) === ' ' ? commentAfterAtSignWithMentionRemoved.slice(1) : commentAfterAtSignWithMentionRemoved
            }`

We'll need to do the same in the insertSelectedEmoji function as well.

What alternative solutions did you explore? (Optional)

None

The insertSelectedEmoji and insertSelectedMention have almost the same functionality and we're really violating the DRY principle here. As such, we should just create a single generic function here that replaces the both and does the job.

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~0179550c85e09022ec

[melvin-bot]

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

[melvin-bot]

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

[melvin-bot]

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

[puneetlath]

Marking external since @szebniok is off for the rest of the week.

[puneetlath]

@thesahindia note that @allroundexperts has already posted a proposal for review above.

[dukenv0307]

Proposal

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

Mention auto-suggester adds extra spaces when the same mention is selected

What is the root cause of that problem?

We are adding space every time we update the comment in both insertSelectedEmoji insertSelectedMention

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

Lines 610 to 624 in dd5fbb6

	insertSelectedMention(highlightedMentionIndex) {
	const commentBeforeAtSign = this.state.value.slice(0, this.state.atSignIndex);
	const mentionObject = this.state.suggestedMentions[highlightedMentionIndex];
	const mentionCode = `@${mentionObject.alternateText}`;
	const commentAfterAtSignWithMentionRemoved = this.state.value.slice(this.state.atSignIndex).replace(CONST.REGEX.MENTION_REPLACER, '');
	this.updateComment(`${commentBeforeAtSign}${mentionCode} ${commentAfterAtSignWithMentionRemoved}`, true);
	this.setState((prevState) => ({
	selection: {
	start: prevState.atSignIndex + mentionCode.length + CONST.SPACE_LENGTH,
	end: prevState.atSignIndex + mentionCode.length + CONST.SPACE_LENGTH,
	},
	suggestedMentions: [],
	}));
	}

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

Lines 589 to 604 in dd5fbb6

	insertSelectedEmoji(highlightedEmojiIndex) {
	const commentBeforeColon = this.state.value.slice(0, this.state.colonIndex);
	const emojiObject = this.state.suggestedEmojis[highlightedEmojiIndex];
	const emojiCode = emojiObject.types && emojiObject.types[this.props.preferredSkinTone] ? emojiObject.types[this.props.preferredSkinTone] : emojiObject.code;
	const commentAfterColonWithEmojiNameRemoved = this.state.value.slice(this.state.selection.end).replace(CONST.REGEX.EMOJI_REPLACER, CONST.SPACE);
	this.updateComment(`${commentBeforeColon}${emojiCode} ${commentAfterColonWithEmojiNameRemoved}`, true);
	this.setState((prevState) => ({
	selection: {
	start: prevState.colonIndex + emojiCode.length + CONST.SPACE_LENGTH,
	end: prevState.colonIndex + emojiCode.length + CONST.SPACE_LENGTH,
	},
	suggestedEmojis: [],
	}));
	EmojiUtils.addToFrequentlyUsedEmojis(emojiObject);
	}

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

We should check if the first character of commentAfterAtSignWithMentionRemoved is ' ' we will don't add space like this

this.updateComment(`${commentBeforeAtSign}${mentionCode}${commentAfterAtSignWithMentionRemoved.slice(0, 1) === ' ' ? commentAfterAtSignWithMentionRemoved : ` ${commentAfterAtSignWithMentionRemoved}`}`, true);

We also do the same thing in insertSelectedEmoji like this

this.updateComment(`${commentBeforeColon}${emojiCode}${commentAfterColonWithEmojiNameRemoved.slice(0, 1) === ' ' ? commentAfterColonWithEmojiNameRemoved : ` ${commentAfterColonWithEmojiNameRemoved}`}`, true);

Result

My solution will make the behavior like Slack

Screen.Recording.2023-05-19.at.12.36.34.1.mp4

[allroundexperts]

@thesahindia I think the selected approach will not work as it will not add a space if we have an emoji directly after the text. For example, this is how it works on Slack:
https://github.com/Expensify/App/assets/30054992/a8dd6004-f19c-4fe5-a602-09465f110b73

After #19004 is merged, our app will essentially behave the same as above. With the proposal that we're currently choosing, following will happen:
https://github.com/Expensify/App/assets/30054992/af2a32ba-0f1e-42bb-b8ee-ee3d34ca45e8

[dukenv0307]

@thesahindia I think we should hold this issue until this thread is resolved

[dukenv0307]

@thesahindia we will remain the logic to get mention suggestion as @puneetlath mentioned here
So I just updated my proposal. My solution is built on top of this PR #19004

[thesahindia]

@dukenv0307, your updated proposal is similar to @allroundexperts. They proposed the solution first so I am going to go with them.

@puneetlath, I like @allroundexperts's proposal

🎀👀🎀 C+ reviewed

[thesahindia]

Are you sure that you have tested it correctly? Because I didn't see any problem. It works fine for me.
Also @allroundexperts, can you check @dukenv0307's comment?

[dukenv0307]

@thesahindia Sorry, my bad. please ignore my comment

[thesahindia]

No worries @dukenv0307!

[melvin-bot]

📣 @allroundexperts You have been assigned to this job by @puneetlath!
Please apply to this job in Upwork 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 📖

[allroundexperts]

PR created #19304

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

• fix: remove extra space after mention insertion #19304

If no regressions arise, payment will be issued on 2023-06-02. 🎊

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 @0xmiroslav
• Contributor that fixed the issue @allroundexperts
• Contributor+ that helped on the issue and/or PR @thesahindia

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:

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

[puneetlath]

Sent contracts to @0xmiroslav @allroundexperts @thesahindia.

@thesahindia friendly reminder about the checklist!

[puneetlath]

Paid @0xmiroslav and @allroundexperts.

@thesahindia will get you once the checklist is done.

[thesahindia]

Sorry for the delay. Dealing with it now.

[thesahindia]

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:

• [@allroundexperts / @thesahindia] The PR that introduced the bug has been identified. Link to the PR:

#18469

• [@allroundexperts / @thesahindia] 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/18469/files#r1218352520

• [@allroundexperts / @thesahindia] 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/p1685985155886849

• [@allroundexperts / @thesahindia] Determine if we should create a regression test for this bug.

I don't think we need a test case for this but let me know if we wanna add tests.

[puneetlath]

I think we're good on tests. We're going to add a suite specifically for mentions. Thanks!

[puneetlath]

@thesahindia I paid the contract but upwork seems to be having issues and won't let me close it. I'll try again tomorrow.

[puneetlath]

Ok, managed to close it. Thanks everyone!