[HOLD for payment 2024-05-08] [$250] Task – When task name is changed offline, the task's chat report in the LHN doesn't update after going back online

[m-natarajan]

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

Reproducible in staging?: Yes
Reproducible in production?: Yes
If this was caught during regression testing, add the test name, ID and link from TestRail: https://expensify.testrail.io/index.php?/tests/view/4486193
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. Go to https://staging.new.expensify.com/
2. Log in.
3. Go to any chat
4. Create a task with assignee
5. Go Offline and edit task name
6. Go back Online and observe task name in a DM chat in LHN (not task details)

Expected Result:

Offline edited task name changed without delay in DM chat LHN

Actual Result:

Offline edited task name changed with delay in DM chat LHN when go Online. Task name in LHN must be changed when Offline

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

Bug6445047_1712779489342.Task_name.mp4

Bug6445047_1712787643540!Log.txt.txt

Add any screenshot/video evidence

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~018db3c535ab60f25e
• Upwork Job ID: 1779911172994191360
• Last Price Increase: 2024-04-15
• Automatic offers:
• getusha | Reviewer | 0
• bernhardoj | Contributor | 0

[melvin-bot]

Triggered auto assignment to @sakluger (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[m-natarajan]

@sakluger FYI I haven't added the External label as I wasn't 100% sure about this issue. Please take a look and add the label if you agree it's a bug and can be handled by external contributors.

[m-natarajan]

We think this bug might be related to #vip-vsb

[nkdengineer]

Proposal

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

Offline edited task name changed with delay in DM chat LHN when go Online. Task name in LHN must be changed when Offline

What is the root cause of that problem?

When we edit the task title, editTask function is called and in optimistic data we don't update anything for parentReportAction so the OptionRowLHN of parent report isn't re-rendered. After EditTask API is complete, back-end returns the update data for parentReportAction like this, the filed change is childReportName leading the LHN row of parent report is rendered and then last message text is updated.

App/src/libs/actions/Task.ts

Line 430 in 8f90c25

function editTask(report: OnyxTypes.Report, {title, description}: OnyxTypes.Task) {

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

When we edit the title of the task we should update childReportName of parentReportAction in optimisticData and reset it in failureData so the last message text of parent report can be updated in LHN.

if (reportName !== report.reportName) {
    optimisticData.push({
        onyxMethod: Onyx.METHOD.MERGE,
        key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${report.parentReportID}`,
        value: {
            [report.parentReportActionID ?? '0']: {
                childReportName: title
            }
        }
    })

    failureData.push({
        onyxMethod: Onyx.METHOD.MERGE,
        key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${report.parentReportID}`,
        value: {
            [report.parentReportActionID ?? '0']: {
                childReportName: report.reportName
            }
        }
    })
}

App/src/libs/actions/Task.ts

Line 430 in 8f90c25

function editTask(report: OnyxTypes.Report, {title, description}: OnyxTypes.Task) {

What alternative solutions did you explore? (Optional)

NA

[bernhardoj]

Proposal

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

When we update the task title, the LHN of the chat report doesn't update with the new title.

What is the root cause of that problem?

The task title in the LHN last message takes the title from getTaskTitle.

App/src/libs/TaskUtils.ts

Lines 40 to 52 in bbc6761

	function getTaskTitle(taskReportID: string, fallbackTitle = ''): string {
	const taskReport = allReports?.[taskReportID] ?? {};
	// We need to check for reportID, not just reportName, because when a receiver opens the task for the first time,
	// an optimistic report is created with the only property – reportName: 'Chat report',
	// and it will be displayed as the task title without checking for reportID to be present.
	return Object.hasOwn(taskReport, 'reportID') && 'reportName' in taskReport && typeof taskReport.reportName === 'string' ? taskReport.reportName : fallbackTitle;
	}
	function getTaskCreatedMessage(reportAction: OnyxEntry<ReportAction>) {
	const taskReportID = reportAction?.childReportID ?? '';
	const taskTitle = getTaskTitle(taskReportID, reportAction?.childReportName);
	return taskTitle ? Localize.translateLocal('task.messages.created', {title: taskTitle}) : '';
	}

getTaskTitle will first get the title from the task report reportName and fallback to the task action childReportName. When we edit the task, we already optimistically update the task report reportName.

App/src/libs/actions/Task.ts

Lines 447 to 450 in bbc6761

	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.REPORT}${report.reportID}`,
	value: {
	reportName,

However, getTaskTitle never use reportName. That is because the task report here is always an empty object because we access it incorrectly

App/src/libs/TaskUtils.ts

Lines 40 to 41 in bbc6761

	function getTaskTitle(taskReportID: string, fallbackTitle = ''): string {
	const taskReport = allReports?.[taskReportID] ?? {};

allReports contains the collection of the report which is keyed by report_{id} but we try to access it with {id}. This started to happen after #38464. Previously, allReports is keyed by {id}.

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

Access the task report by report_{id}.

const taskReport = allReports?.[`${ONYXKEYS.COLLECTION.REPORT}${taskReportID}`] ?? {};

What alternative solutions did you explore? (Optional)

Use the old approach by keyed it with {id} and remove waitForCollectionCallback.

App/src/libs/TaskUtils.ts

Lines 10 to 17 in bbc6761

	let allReports: OnyxCollection<Report> = {};
	Onyx.connect({
	key: ONYXKEYS.COLLECTION.REPORT,
	waitForCollectionCallback: true,
	callback: (reports) => {
	allReports = reports;
	},
	});

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~018db3c535ab60f25e

[melvin-bot]

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

[getusha]

@bernhardoj's proposal looks good to me.
🎀 👀 🎀 C+ Reviewed.

[melvin-bot]

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

[lakchote]

@bernhardoj's proposal LGTM.

[melvin-bot]

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

Offer link
Upwork job

[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: @getusha

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

• Fix task last message title doesn't update optimistically #40352

If no regressions arise, payment will be issued on 2024-05-08. 🎊

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

• @bernhardoj requires payment automatic offer (Contributor)
• @getusha requires payment automatic offer (Reviewer)

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

• [@getusha] The PR that introduced the bug has been identified. Link to the PR:
• [@getusha] 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:
• [@getusha] 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:
• [@getusha] Determine if we should create a regression test for this bug.
• [@getusha] 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]

Hey @getusha could you please accept the Upwork offer? https://www.upwork.com/nx/wm/offer/101905561

[sakluger]

I paid @bernhardoj's contract. @bernhardoj could you please complete the BZ checklist?

[bernhardoj]

@sakluger I think @getusha should be the one that complete the checklist

[sakluger]

@bernhardoj you're right, my bad! @getusha please complete the checklist when you have a moment.

[getusha]

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:

• [@getusha] The PR that introduced the bug has been identified. Link to the PR: [NoQA] [Audit][Implementation] - Increase max cache keys count and use waitForCollectionCallback #38464
• [@getusha] 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/38464/files#r1596233138
• [@getusha] 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
• [@getusha] Determine if we should create a regression test for this bug. No, it looks like a minor bug
• [@getusha] 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

[sakluger]

Thanks! All paid out.