[HOLD for payment 2023-08-17] [$1000] Red dot and [Attachment] shows in LHN even after close error message

[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 any chat
2. send any corrupted file
3. click on X button in Unexpected error message

Expected Result:

should not show red dot and [Attachment] in LHN

Actual Result:

red dot and [Attachment] shows in LHN

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.50-0
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

Screen.Recording.2023-08-01.at.2.08.17.PM.mov

Recording.1441.mp4

Expensify/Expensify Issue URL:
Issue reported by: @gadhiyamanan
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1690879133508289

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~019aca46aa1b2b9812
• Upwork Job ID: 1687588216647823360
• Last Price Increase: 2023-08-04
• Automatic offers:
• gadhiyamanan | Reporter | 25956660
• bernhardoj | Contributor | 25986609

[melvin-bot]

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

[c3024]

Proposal

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

On closing the error in reportAction the red dot is not removed and last message is not updated in LHN.

What is the root cause of that problem?

This here

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

Line 534 in f9d760f

onClose={() => ReportActions.clearReportActionErrors(props.report.reportID, props.action)}

is handler on clicking close on the error.
This method here deletes this attachment report action on clicking the close on attachment uploading error.

App/src/libs/actions/ReportActions.js

Line 10 in f9d760f

function clearReportActionErrors(reportID, reportAction) {

but it does not update the report's lastMessageText, actor, translation key etc.

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

We should update the report also here when we click close on the error similar to the deleteReportComment

App/src/libs/actions/Report.js

Lines 960 to 963 in f9d760f

	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.REPORT}${originalReportID}`,
	value: optimisticReport,
	},

So, we replace this

App/src/libs/actions/ReportActions.js

Lines 12 to 15 in f9d760f

	// Delete the optimistic action
	Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${reportID}`, {
	[reportAction.reportActionID]: null,
	});

with something like this

const optimisticReportActions = {
            [reportAction.reportActionID]: null,
        };
        // Delete the optimistic action
        Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${reportID}`, {
            ...optimisticReportActions,
        });
        let optimisticReport = {
            lastMessageTranslationKey: '',
            lastMessageText: '',
            lastVisibleActionCreated: '',
        };
        const {lastMessageText = '', lastMessageTranslationKey = ''} = ReportActionUtils.getLastVisibleMessage(reportID, optimisticReportActions);
        if (lastMessageText || lastMessageTranslationKey) {
            const lastVisibleAction = ReportActionUtils.getLastVisibleAction(reportID, optimisticReportActions);
            const lastVisibleActionCreated = lastVisibleAction.created;
            const lastActorAccountID = lastVisibleAction.actorAccountID;
            optimisticReport = {
                lastMessageTranslationKey,
                lastMessageText,
                lastVisibleActionCreated,
                lastActorAccountID,
            };
        }
        Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT}${reportID}`, optimisticReport);

Since we are reusing the same logic we might extract this to a separate function in Report or ReportUtils

What alternative solutions did you explore? (Optional)

[jeet-dhandha]

Proposal

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

• We have two issues here:
  • [Issue 1] - Red dot is still showing in LHN even after we close the error message.
  • [Issue 2] - [Attachment] text shows in LHN even after we close error message.

What is the root cause of that problem?

• [Issue 1] - In OptionsRowLHNData.js below line doesn't get any effect (as we are accessing reportActions directly from onyx listener in SidebarUtils.js) when clearing errors and thus its not updating the Red Dot.

App/src/components/LHNOptionsList/OptionRowLHNData.js

Line 82 in f9d760f

const item = SidebarUtils.getOptionData(fullReport, personalDetails, preferredLocale, policy);

• [Issue 2] - When API fails to upload attachment it should revert last message to given lastMessageText but it isn't doing that.

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

• [Issue 1] - We should add a reportActions key to withOnyx HOC and then we can pass it to the useMemo dependency array. This will update the Red Dot when we clear the error.

reportActions: {
    key: (props) => `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${props.reportID}`,
    canEvict: false, // I still don't know what this is used for but I had to pass it to make it run.
},

• [Issue 2] - On backend we should revert last message to given lastMessageText when API fails to upload attachment.

What alternative solutions did you explore? (Optional)

• N/A

[bernhardoj]

Proposal

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

Clearing the error message does not update the last message text.

What is the root cause of that problem?

The real issue here is that, when the attachment upload is failed, we should revert the last message text to the previous text. This issue was previously fixed here #22342, but a new report attribute called lastMessageTranslationKey is introduced.

When we upload an attachment, lastMessageTranslationKey will be optimistically set to common.attachment.

App/src/libs/actions/Report.js

Line 258 in f9d760f

lastMessageTranslationKey: lodashGet(lastAction, 'message[0].translationKey', ''),

App/src/libs/ReportUtils.js

Line 1524 in f9d760f

translationKey: isAttachment ? CONST.TRANSLATION_KEYS.ATTACHMENT : '',

When the attachment fails to upload, we only revert the lastMessageText of the report, so lastMessageTranslationKey value is still common.attachment.

App/src/libs/actions/Report.js

Lines 304 to 312 in f9d760f

	const failureReport = {
	lastMessageText: prevVisibleMessageText,
	};
	const failureData = [
	{
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.REPORT}${reportID}`,
	value: failureReport,
	},

LHN last message will prioritize lastMessageTranslationKey if exist.

App/src/libs/OptionsListUtils.js

Lines 385 to 387 in f9d760f

	if (ReportUtils.isReportMessageAttachment({text: report.lastMessageText, html: report.lastMessageHtml, translationKey: report.lastMessageTranslationKey})) {
	lastMessageTextFromReport = `[${Localize.translateLocal(report.lastMessageTranslationKey || 'common.attachment')}]`;
	} else if (ReportActionUtils.isReportPreviewAction(lastReportAction)) {

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

We should also revert the lastMessageTranslationKey. We can basically take the last message revert logic from the delete comment.

App/src/libs/actions/Report.js

Lines 910 to 922 in f9d760f

	const {lastMessageText = '', lastMessageTranslationKey = ''} = ReportActionsUtils.getLastVisibleMessage(originalReportID, optimisticReportActions);
	if (lastMessageText || lastMessageTranslationKey) {
	const lastVisibleAction = ReportActionsUtils.getLastVisibleAction(originalReportID, optimisticReportActions);
	const lastVisibleActionCreated = lastVisibleAction.created;
	const lastActorAccountID = lastVisibleAction.actorAccountID;
	optimisticReport = {
	lastMessageTranslationKey,
	lastMessageText,
	lastVisibleActionCreated,
	lastActorAccountID,
	};
	}
	}

snippet

let failureReport = {
    lastMessageTranslationKey: '',
    lastMessageText: '',
    lastVisibleActionCreated: '',
};
const {lastMessageText = '', lastMessageTranslationKey = ''} = ReportActionsUtils.getLastVisibleMessage(reportID);
if (lastMessageText || lastMessageTranslationKey) {
    const lastVisibleAction = ReportActionsUtils.getLastVisibleAction(reportID);
    const lastVisibleActionCreated = lastVisibleAction.created;
    const lastActorAccountID = lastVisibleAction.actorAccountID;
    failureReport = {
        lastMessageTranslationKey,
        lastMessageText,
        lastVisibleActionCreated,
        lastActorAccountID,
    };
}

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~019aca46aa1b2b9812

[melvin-bot]

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

[kevinksullivan]

Agree this is a bug, moving forward to external

[melvin-bot]

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

[melvin-bot]

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

[melvin-bot]

📣 @rushatgabhane Please request via NewDot manual requests for the Contributor role ($1000)

[melvin-bot]

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

[kevinksullivan]

@tjferriss I am going OOO for a week, so tapping you in to help out in the interim. Thanks!

[rushatgabhane]

I like @bernhardoj's proposal #24136 (comment) because it fixes the root cause

C+ reviewed 🎀 👀 🎀

[melvin-bot]

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

[melvin-bot]

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

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

[bernhardoj]

PR is ready

cc: @rushatgabhane

[melvin-bot]

🎯 ⚡️ Woah @rushatgabhane / @bernhardoj, great job pushing this forwards! ⚡️

The pull request got merged within 3 working days of assignment, so this job is eligible for a 50% #urgency bonus 🎉

• when @bernhardoj got assigned: 2023-08-07 10:41:25 Z
• when the PR got merged: 2023-08-09 12:36:54 UTC

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

• Fix red dot is not cleared after close add message error and revert last message when the add message fails #24213

If no regressions arise, payment will be issued on 2023-08-17. 🎊

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 @gadhiyamanan $250
• Contributor that fixed the issue @bernhardoj $1500
• Contributor+ that helped on the issue and/or PR @rushatgabhane $1500

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

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

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:

• [@rushatgabhane] The PR that introduced the bug has been identified. Link to the PR:
• [@rushatgabhane] 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:
• [@rushatgabhane] 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] Determine if we should create a regression test for this bug.
• [@rushatgabhane] 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.
• [@tjferriss / @kevinksullivan] 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: Fix: Translation for system message #21780

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: https://github.com/Expensify/App/pull/21780/files#r1293875228

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: https://expensify.slack.com/archives/C01GTK53T8Q/p1692040783758609

4. Determine if we should create a regression test for this bug. No. This is one off bug

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

[rushatgabhane]

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

[kevinksullivan]

Payment summary

• Reporter: @gadhiyamanan $250
• Contributor: @bernhardoj $1,500
• C+: @rushatgabhane $1,500

[kevinksullivan]

Adding @JmillsExpensify for the newdot payment. Following this SO, but let me know if I should be doing something differently

[kevinksullivan]

Payments made to @gadhiyamanan and @bernhardoj

[JmillsExpensify]

Reviewed the details for @rushatgabhane. Approved for $1,500 payment in NewDot based on the BZ summary above.