[HOLD for payment 2023-05-16] [$1000] Adding `` in a message when editing will make the message flicker

[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. Go to Expensify
2. Open any chat > Send a message like "Hi"
3. Edit the message and add one or two ` characters at the end (Eg. "Hi `` ")
4. Click on "Save changes"

Note: I was able to reproduce this as long as that backtick character was added into the message, so editing "Hello" to "Hello a" caused the effect to happen, as well as editing to "Hello".

Expected Result:

(edited) text should not flicker or move

Actual Result :

The (edited) text shifts its position or flickers after editing the text and adding a backtick character.

Workaround:

N/A

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

Bug.-.+.edit.mov

Recording.442.mp4

Expensify/Expensify Issue URL:
Issue reported by: @daraksha-dk
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1682945338708039

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01740ff3dbfb5381b5
• Upwork Job ID: 1653227404892110848
• Last Price Increase: 2023-05-02

[MelvinBot]

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

[MelvinBot]

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

[daraksha-dk]

The formatting appears to be incorrect for 3rd step, because of the differences in how GH and Slack handle formatting.
Here is the correct step:

3. Edit the message and add `` in the end (Eg. "Hi``")
cc: @sakluger

[sakluger]

Thanks for the notes! I was able to reproduce, and I update the original description to clean up the formatting, and I also included more ways to reproduce.

[MelvinBot]

Job added to Upwork: https://www.upwork.com/jobs/~01740ff3dbfb5381b5

[MelvinBot]

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

[MelvinBot]

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

[MelvinBot]

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

[daraksha-dk]

Proposal

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

Adding `` in a message when editing will make the message flicker

What is the root cause of that problem?

The root cause of this issue is using different approaches for defining some space between "message" and "edited" for Normal Messages & HTML Rendered messages. We need to follow only one approach here.
The transition from HTML rendered message to non-HTML message happens because we are optimistically escaping ` with ExpensiMarker, which in turn makes this condition true and later after the API call is done - ` gets unescaped making that condition false.

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

To maintain consistency, we should use the code block given below instead of these lines.

                        {` ${props.translate('reportActionCompose.edited')}`}

What alternative solutions did you explore? (Optional)

Another solution could be using the alternative approach in areas where we need whitespace between two texts like here

Add on

Alternative 1:
The backend should also escape ` with ` like it does for other characters (&, <, >, etc). This will avoid getting this condition false once it's true. (Preferred way, as it will maintain consistency)

Alternative 2:
We can also just avoid escaping ` by using a custom function like escapeWithoutBacktick. Atfter that, we'll have to replace the usage of escaped version with \` in ExpensifyMark.

[0xmiros]

I like @daraksha-dk's proposal. The root cause is correct and I follow main solution as it's simple and consistent with normal text render:

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

Line 137 in a786349

{` ${props.translate('reportActionCompose.edited')}`}

cc: @iwiznia
🎀 👀 🎀 C+ reviewed

[melvin-bot]

📣 @daraksha-dk You have been assigned to this job by @iwiznia!
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 📖

[daraksha-dk]

PR is ready for review!
cc: @0xmiroslav @iwiznia

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

• add proper whitespace between "edited" and html rendered message #18491

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

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:

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

[sakluger]

This was merged the same day it was assigned, so as long as there are no regressions before tomorrow, it qualifies for the efficiency bonus.

[sakluger]

All paid up! Thanks everyone.