[HOLD for payment 2024-03-14] [$500] Workspace - System message for workspace description edit with mark down is not gray

[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!

---

Version Number: v1.4.42-1
Reproducible in staging?: y
Reproducible in production?: n
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
Expensify/Expensify Issue URL:
Issue reported by: Applause - Internal Team
Slack conversation:

Action Performed:

1. Navigate to staging.new.expensify.com
2. Create a new workspace.
3. Go to workspace profile.
4. Click Workspace description.
5. Save a description without mark down.
6. Click Workspace description.
7. Save another description with mark down.
8. Go to #admin room.

Expected Result:

The system message for workspace description edit should appear gray, regardless of the usage of mark down in the description.

Actual Result:

The system message for workspace description edit is not grayed out when mark down is involved.

Workaround:

Unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Add any screenshot/video evidence

Bug6380766_1708008538695.bandicam_2024-02-15_16-00-04-569.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01435fd857fbcc98a7
• Upwork Job ID: 1759631118974234624
• Last Price Increase: 2024-02-19
• Automatic offers:
• hoangzinh | Contributor | 0

[github-actions]

👋 Friendly reminder that deploy blockers are time-sensitive ⏱ issues! Check out the open `StagingDeployCash` deploy checklist to see the list of PRs included in this release, then work quickly to do one of the following:

1. Identify the pull request that introduced this issue and revert it.
2. Find someone who can quickly fix the issue.
3. Fix the issue yourself.

[melvin-bot]

Triggered auto assignment to @puneetlath (Engineering), see https://stackoverflowteams.com/c/expensify/questions/9980/ for more details.

[Beamanator]

This is useful to fix, but also doesn't feel like a blocker since everything seems to be working fine (just not a grayed out system message)

[bernhardoj]

Proposal

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

The workspace description system message is not grayed out when the description is a markdown.

What is the root cause of that problem?

Currently, we check the action name and apply the gray color.

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

Lines 482 to 494 in 9843f66

	style={[
	_.contains(
	[
	..._.values(CONST.REPORT.ACTIONS.TYPE.POLICYCHANGELOG),
	CONST.REPORT.ACTIONS.TYPE.IOU,
	CONST.REPORT.ACTIONS.TYPE.APPROVED,
	CONST.REPORT.ACTIONS.TYPE.MOVED,
	],
	props.action.actionName,
	)
	? styles.colorMuted
	: undefined,
	]}

This works perfectly for a plain text, but not for markdown. When the description is a markdown, it will be rendered as HTML,

App/src/pages/home/report/comment/TextCommentFragment.tsx

Lines 53 to 65 in 9843f66

	if (!differByLineBreaksOnly) {
	const editedTag = fragment.isEdited ? `<edited ${styleAsDeleted ? 'deleted' : ''}></edited>` : '';
	const htmlContent = styleAsDeleted ? `<del>${html}</del>` : html;
	const htmlWithTag = editedTag ? `${htmlContent}${editedTag}` : htmlContent;
	return (
	<RenderCommentHTML
	source={source}
	html={htmlWithTag}
	/>
	);
	}

and the style we pass won't work.

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

We can follow the same pattern as styleAsDeleted props. Instead of passing the colorMuted style, we can have a new props called, styleAsMuted with the same condition as below

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

Lines 482 to 491 in 9843f66

	style={[
	_.contains(
	[
	..._.values(CONST.REPORT.ACTIONS.TYPE.POLICYCHANGELOG),
	CONST.REPORT.ACTIONS.TYPE.IOU,
	CONST.REPORT.ACTIONS.TYPE.APPROVED,
	CONST.REPORT.ACTIONS.TYPE.MOVED,
	],
	props.action.actionName,
	)

and wrap the HTML with <muted-text> tag to apply the gray text color.

let htmlWithTag = editedTag ? `${htmlContent}${editedTag}` : htmlContent;
if (styleAsMuted) {
    htmlWithTag = `<muted-text>${htmlWithTag}<muted-text>`;
}

Then, for the plain text, we will apply the style if styleAsMuted is true similar to styleAsDeleted to every text that needs it.

App/src/pages/home/report/comment/TextCommentFragment.tsx

Line 81 in 9843f66

styleAsDeleted ? styles.offlineFeedback.deleted : undefined,

Or we can just leave the current style we have to reduce the changes and regression risk. Please let me know which way we should go.

[melvin-bot]

@puneetlath Uh oh! This issue is overdue by 2 days. Don't forget to update your issues!

[situchan]

As this was deploy blocker, there should be offending PR.
@bernhardoj you know?

[puneetlath]

Making external.

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~01435fd857fbcc98a7

[melvin-bot]

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

[bernhardoj]

As this was deploy blocker, there should be offending PR.

It's noticeable when the workspace description page is introduced.

[yoyumiracle]

Proposal

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

The system message for workspace description edit is not grayed out when mark down is involved.

What is the root cause of that problem?

function updateWorkspaceDescription(policyID: string, description: string, currentDescription: string) {
  if (description === currentDescription) {
      return;
  }
  const parsedDescription = ReportUtils.getParsedComment(description);

I think ReporUtils.getParsedComment make system message to prevent "CONST.REPORT.ACTIONS.TYPE.POLICYCHANGELOG"

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

Delete code below

const parsedDescription = ReportUtils.getParsedComment(description);

[hoangzinh]

@yoyumiracle thanks for your proposal. I don't think you have found the root cause yet. Also, your solution doesn't work. Please test your solution on your local next time. Btw, your solution would cause a regression bug, where it displays plain text instead of markdown after saving workspace description

[hoangzinh]

@bernhardoj Thanks for your proposal. It looks good to me, the root cause is correct and you provided a working solution.

Then, for the plain text, we will apply the style if styleAsMuted is true similar to styleAsDeleted to every text that needs it.

I prefer this option. But the style from ReportActionItemMessage component is also used here

App/src/pages/home/report/ReportActionItemMessage.tsx

Line 105 in 669ac33

<View style={[styles.chatItemMessage, style]}>

I think we should test against 4 actions here to ensure it still works with that option. What do you think?

[yoyumiracle]

@hoangzinh I'm on your side.
In my opinion when we use markdown the style.colorMuted seems to be not applied to component.
I made mistake that it would be ReactUtils.getParsedComment affect to actions(4 actions) you mentioned.
And I suggest you to check this code, I think htmlWithTag in TextComponentFragment.tsx always has <muted-text> tag by this code.

App/src/libs/ReportActionsUtils.ts

Lines 781 to 801 in 669ac33

	function getMemberChangeMessageFragment(reportAction: OnyxEntry<ReportAction>): Message {
	const messageElements: readonly MemberChangeMessageElement[] = getMemberChangeMessageElements(reportAction);
	const html = messageElements
	.map((messageElement) => {
	switch (messageElement.kind) {
	case 'userMention':
	return `<mention-user accountID=${messageElement.accountID}>${messageElement.content}</mention-user>`;
	case 'roomReference':
	return `<a href="${environmentURL}/r/${messageElement.roomID}" target="_blank">${messageElement.roomName}</a>`;
	default:
	return messageElement.content;
	}
	})
	.join('');
	return {
	html: `<muted-text>${html}</muted-text>`,
	text: reportAction?.message ? reportAction?.message[0].text : '',
	type: CONST.REPORT.MESSAGE.TYPE.COMMENT,
	};
	}

Sorry for confusing.

[bernhardoj]

But the style from ReportActionItemMessage component is also used here

I honestly think that the style shouldn't be put there as it affects flagged content text. For our case, we can't flag the 4 actions, so I'm thinking that we should put the styleAsMuted deeper in here

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

Lines 112 to 120 in 8d60f67

	return (
	<TextCommentFragment
	source={source}
	fragment={fragment}
	styleAsDeleted={!!(isOffline && isPendingDelete)}
	iouMessage={iouMessage}
	displayAsGroup={displayAsGroup}
	style={style}
	/>

I think we should test against 4 actions here to ensure it still works with that option. What do you think?

And yes, we can test this.

[hoangzinh]

@yoyumiracle It won't because this condition is not true in this case

App/src/pages/home/report/ReportActionItemMessage.tsx

Line 40 in 29ad878

if (ReportActionsUtils.isMemberChangeAction(action)) {

[hoangzinh]

@bernhardoj proposal #36598 (comment) looks good to me. He pointed out the root cause and provided a working solution.

🎀👀🎀 C+ reviewed

[melvin-bot]

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

[melvin-bot]

📣 @hoangzinh 🎉 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 📖

[bernhardoj]

PR is ready

cc: @hoangzinh

FYI, I haven't got the auto offer yet

cc: @puneetlath

[puneetlath]

Hm, weird that it didn't work sending you the auto-offer. If it doesn't do it, I'll send you one manually when it's time to pay.

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

• Fix workspace system message when contains markdown isn't grayed out #37124

If no regressions arise, payment will be issued on 2024-03-14. 🎊

For reference, here are some details about the assignees on this issue:

• @hoangzinh requires payment automatic offer (Contributor)
• @bernhardoj requires payment (Needs manual offer from BZ)

[puneetlath]

Sent you an offer @bernhardoj: https://www.upwork.com/nx/wm/offer/101362453

[puneetlath]

All paid. Thanks y'all!