[HOLD for payment 2023-09-29] [$500] Chat - Inconsistent "(edited)" text on styled RTL text

[izarutskaya]

If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!

---

Action Performed:

1. Open a chat and type a text in a right-to-left character set, (for example مثال).
2. Edit the text to another right-to-left text, (for example مال). Examine the "(edited)" text position
3. Edit the text so it become styled (for example, مال). Examine the "(edited)" text position

Expected Result:

The "(edited)" text is supposed to stay the same for right-to-left characters, regardless being edited or not

Actual Result:

In the normal edited text, the "(edited)" text is positioned in the right of the edited message. However in the styled edited text, the "(edited)" text is positioned on the left of the edited message.

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: v1.3.67-1

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

Styled.RTL.Text.-.Crop.mp4

Recording.1491.mp4

Expensify/Expensify Issue URL:

Issue reported by: @kerupuksambel

Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1693864715884909

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01466b9797b975245b
• Upwork Job ID: 1701135260498452480
• Last Price Increase: 2023-09-11
• Automatic offers:
• bernhardoj | Contributor | 26611890
• kerupuksambel | Reporter | 26611895

[melvin-bot]

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

[bernhardoj]

Proposal

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

Having an edited RTL markdown/styled text put the (edited) text to the left instead of the right like normal text.

What is the root cause of that problem?

In ReportActionItemFragment, we force the report action text to be ltr by applying styles.ltr and convertToLTR (android).

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

Lines 140 to 144 in ae68e74

	<Text
	selectable={!DeviceCapabilities.canUseTouchScreen() || !props.isSmallScreenWidth}
	style={[containsOnlyEmojis ? styles.onlyEmojisText : undefined, styles.ltr, ...props.style]}
	>
	{convertToLTR(props.iouMessage || text)}

However, this only applies to normal text without markdown/styling. Markdown text will be rendered using RenderHTML which is not forced to ltr.

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

Lines 133 to 135 in ae68e74

	const htmlContent = applyStrikethrough(html + editedTag, isPendingDelete);
	return <RenderHTML html={props.source === 'email' ? `<email-comment>${htmlContent}</email-comment>` : `<comment>${htmlContent}</comment>`} />;

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

Force the markdown text to be ltr too by:

1. Apply ltr style to baseFontStyles.
   

   App/src/styles/styles.js

   Lines 152 to 153 in ae68e74

   	baseFontStyle: {
   	color: themeColors.text,

   
   ...writingDirection.ltr
2. Alter the HTML text data. In BaseHTMLEngineProvider, wrap all text nodes with convertToLTR by passing a new prop called domVisitors. It will look like this:

domVisitors={{
    onText: (text) => {
        text.data = convertToLTR(text.data);
    }
}}

Then clear the LTR unicode from the text in mention renderer.

App/src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.js

Lines 34 to 35 in f5b7d5c

	// We need to remove the leading @ from data as it is not part of the login
	const loginWithoutLeadingAt = props.tnode.data ? props.tnode.data.slice(1) : '';

props.tnode.data.replace('\u2066', '').slice(1)

This will force the text to be LTR for all components that use RenderHTML (Banner, FormAlertWrapper, MoneyRequestAction, and TaskPreview).

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~01466b9797b975245b

[melvin-bot]

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

[melvin-bot]

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

[rushatgabhane]

looks like a simple solution #27125 (comment)

🎀 👀 🎀

[melvin-bot]

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

[bernhardoj]

@rushatgabhane so fast haha, btw I found an issue with my own solution (Android). Appending the HTML with LTR unicode breaks the styling of non-text components.

So, I have updated my solution

[rushatgabhane]

@bernhardoj nice find! Your solution looks good.

[rajsixthblock]

Contributor details
Your Expensify account email: [email protected]
Upwork Profile Link: https://www.upwork.com/freelancers/~0104b18b5cf10d77e5

[mountiny]

is this something we actually support now @rushatgabhane this is a first time I am seeing something like that and I am not sure if this is worth spending our time on, right now. What do you think?

[bernhardoj]

@mountiny we don't support RTL by forcing the message text to LTR, but this does not work if the message is a markdown.

[melvin-bot]

📣 @rushatgabhane Please request via NewDot manual requests for the Reviewer role ($500)

[melvin-bot]

📣 @bernhardoj 🎉 An offer has been automatically sent to your Upwork account for the Contributor role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job
Please accept the offer 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 📖

[melvin-bot]

📣 @kerupuksambel 🎉 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

[mountiny]

Ok thanks, I think your solution looks good but it will touch lots of places so make sure to really test properly

[bernhardoj]

It's nearly midnight already at my place, I will create the PR tomorrow.

[mountiny]

yeah I am also in Bali 😂

[bernhardoj]

@mountiny yeah, I saw the flag on your Slack status 😂 but I'm actually on a different island that is 1h+ flights apart from Bali 😞

Btw, PR is ready!

[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 @bernhardoj got assigned: 2023-09-11 15:00:04 Z
• when the PR got merged: 2023-09-19 06:32:00 UTC
• days elapsed: 5

On to the next one 🚀

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

• Force markdown text to LTR #27216

If no regressions arise, payment will be issued on 2023-09-29. 🎊

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:

• @rushatgabhane does not require payment (Eligible for Manual Requests)
• @bernhardoj requires payment offer (Contributor)
• @kerupuksambel requires payment offer (Reporter)

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:

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

[rushatgabhane]

1. The PR that introduced the bug has been identified. Link to the PR: I couldn't find the PR. But we should add a regression test

2. 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: N.A.

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

4. Determine if we should create a regression test for this bug. YES

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

   1. Open any chat
   2. Send an RTL text, for example, مثال
   3. Edit the text by applying some style, for example مثال (strikethrough)
   4. Verify the text is on the left and (edited) text is on the right

[rushatgabhane]

Created a manual request here - https://staging.new.expensify.com/r/7161765702402744

[melvin-bot]

@JmillsExpensify, @rushatgabhane, @mountiny, @bernhardoj Whoops! This issue is 2 days overdue. Let's get this updated quick!

[melvin-bot]

@JmillsExpensify, @rushatgabhane, @mountiny, @bernhardoj Eep! 4 days overdue now. Issues have feelings too...

[mountiny]

$50 to @kerupuksambel
$500 to @bernhardoj
$500 to @rushatgabhane already requested in NewDot

[JmillsExpensify]

$500 payment approved for @rushatgabhane based on summary above.

[JmillsExpensify]

All other contributors have been paid out!

[JmillsExpensify]

Regression test has also been created. Closing.