[HOLD for payment 2023-08-17] [$1000] Completed task gets re-indexed if edited. #23883

kavimuru · 2023-07-30T17:34:22Z

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:

Create a task
Set to completed
Open task report and write something & watch the sidebar

Expected Result:

Completed task should not be reindex and should not move to top to the report list or if it has to move up then it should persist its index.

Actual Result:

Completed tasks moves to top while writing something in composer and gets back to its position if the message is sent.

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?

Version Number: 1.3.47-2
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

completed_task_reindexing.mp4

Recording.1403.mp4

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

View all open jobs on GitHub

Upwork Automation - Do Not Edit

Upwork Job URL: https://www.upwork.com/jobs/~01ffb623af5dcd64cc
Upwork Job ID: 1687217514400518144
Last Price Increase: 2023-08-03
Automatic offers:

dukenv0307 | Contributor | 25999076

melvin-bot · 2023-07-30T17:34:26Z

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

melvin-bot · 2023-07-30T17:34:28Z

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

niteshletxsoft · 2023-07-30T19:39:31Z

Proposal

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

Completed task should not be reindex and should not move to top to the report list or if it has to move up then it should persist its index.

What is the root cause of that problem?

The root cause of this issue is the ordering of the report ID's based on their status and when the completed task has a draft comment, According to the current logic all draft report comes on the top.

App/src/libs/SidebarUtils.js

Lines 142 to 145 in 62622e9

    
           if (report.hasDraft) { 
        
               draftReports.push(report); 
        
               return; 
        
           }

 if (report.hasDraft) {
      draftReports.push(report);
      return;
  }

This is the part of the code, which is causing the current issue.

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

The actual solution to this issue is to keep the Completed task at their position even if the task has a draft comment.

We can check if this REPORT is a task and completed one, We will not put the REPORT in the draftReports array.

// The completed tasks should not move the position when have a draft
if (report.hasDraft && !(ReportUtils.isTaskReport(report) && ReportUtils.isCompletedTaskReport(report))) {
    draftReports.push(report);
    return;
}

As per the another half comment of the issue by the reporter "if it has to move up then it should persist its index."
We can not update the completed task position on new comments because this will conflict with the logic of archivedReports, which keeps the completed task at the bottom of the list.

What alternative solutions did you explore? (Optional)

N/A

dukenv0307 · 2023-07-31T08:39:54Z

Not a bug, we prioritize the draft report on LHN

twisterdotcom · 2023-07-31T16:27:08Z

I agree, this is intentional. Not a bug.

thienlnam · 2023-07-31T16:28:52Z

I had the same initial view but in the video, it looks like after you send the message it is reverting it’s position which is the bug here. I agree it reindexing while in draft state is correct, but it seems like after the message is sent and it is no longer in draft state it should stay at the top

twisterdotcom · 2023-07-31T16:57:02Z

Hmmm, yes I haven't not used focus mode for a long time. I'll retest this.

niteshletxsoft · 2023-08-01T03:31:29Z

Yes, You are right @thienlnam. either the completed task should change the position on draft and keep the position after sending the message or should not change the position when has the draft message.
As shown in the bug, It changes the position when has the draft message and come back to original position when message is sent.

According to me, It should not come to top position with draft message as the task has been completed and that's the solution i have provided.

dukenv0307 · 2023-08-02T10:20:10Z

Proposal

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

Completed tasks move to the top while writing something in Composer and get back to its position if the message is sent.

What is the root cause of that problem?

The order report in LHN is calculated based on this line of code:

App/src/libs/SidebarUtils.js

Line 176 in 751d797

    
           return _.pluck([].concat(pinnedReports).concat(outstandingIOUReports).concat(draftReports).concat(nonArchivedReports).concat(archivedReports), 'reportID');

Then, the proper order in LHN will be
Pinned Report -> outstandingIOU Reports -> Draft Reports -> Non Archived Reports -> Archived Reports
In the current code, when a task is marked as completed, it will be pushed to the Archived Reports ( last position in the array of reports )

App/src/libs/SidebarUtils.js

Lines 152 to 155 in 751d797

    
           if (ReportUtils.isTaskReport(report) && ReportUtils.isCompletedTaskReport(report)) { 
        
               archivedReports.push(report); 
        
               return; 
        
           }

When creating a draft comment, it will be marked as Draft Reports ( the 3rd position )
After the comment was sent, that report will be marked as Archived Reports again, as a result, it will be re-index and moved to the end of the report array in LHN. That's why we see the re-index issue.

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

I think we should not consider a completed task as a Archived report but Non Archived Report instead. Since as I see in the UI. An archived report always has two characteristics

Having ( archived ) text next to it's name
No new comment are allowed

Therefore, after marking a completed task as non archived report, the after adding a new comment, completed tasks will stay on top in LHN

Result:

Screen.Recording.2023-08-02.at.17.18.48.mov

What alternative solutions did you explore? (Optional)

dukenv0307 · 2023-08-02T10:26:33Z

@thienlnam Completed tasks are initially marked as Archived Report in this PR files https://github.com/Expensify/App/pull/18931/files

melvin-bot · 2023-08-03T20:11:12Z

@twisterdotcom Whoops! This issue is 2 days overdue. Let's get this updated quick!

twisterdotcom · 2023-08-03T21:42:48Z

I think we should not consider a completed task as a Archived report but Non Archived Report instead

This makes sense to me.

melvin-bot · 2023-08-03T21:42:59Z

Job added to Upwork: https://www.upwork.com/jobs/~01ffb623af5dcd64cc

melvin-bot · 2023-08-03T21:43:02Z

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

melvin-bot · 2023-08-03T21:43:07Z

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

twisterdotcom · 2023-08-03T21:43:29Z

@parasharrajat and @thienlnam - can we assign @dukenv0307 on this one?

parasharrajat · 2023-08-03T21:51:40Z

IMO, @dukenv0307 's proposal looks good. But I am not sure of the Task design. Why did we move the task to archived when a user can still message in that thread?

🎀 👀 🎀 C+ reviewed

dukenv0307 · 2023-08-08T02:09:57Z

@parasharrajat The PR is ready for review

parasharrajat · 2023-08-08T10:34:55Z

I noticed that all reports change position when drafts are added/removed from them. Are we trying to change that?

Earlier, I got distracted by the mention of the completion of a task in the issue. And I focused on #23883 (comment) & #23883 (comment) as the expected result from triaging. If this is in fact the expected result then we are on track and no action is due. Thus we should update the issue @twisterdotcom to correctly reflect that.

Otherwise, we should fix the issue description and discuss the real problem that reports change position when drafts are added/removed on LHN

melvin-bot · 2023-08-09T04:56:41Z

🎯 ⚡️ Woah @parasharrajat / @dukenv0307, 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 @dukenv0307 got assigned: 2023-08-08 00:26:00 Z
when the PR got merged: 2023-08-09 04:56:40 UTC

On to the next one 🚀

twisterdotcom · 2023-08-09T14:41:45Z

I noticed that all reports change position when drafts are added/removed from them

This is just because the draft moves up in the hierarchy though right? When the message is sent, it doesn't move back down again. If so, I think this is fine.

parasharrajat · 2023-08-09T14:44:25Z

Yeah, it does not move back down.

Krishna2323 · 2023-08-09T16:23:58Z

@parasharrajat @twisterdotcom, why I always have to send proposals on Upwork, I already have 2 jobs assigned to me on Upwork. I have sent a proposal for this one just now, pls let me know if you can help.

Thanks

twisterdotcom · 2023-08-09T17:10:28Z

You shouldn't have to send a proposal on Upwork anymore. We should automatically send you a contract if we have your Upwork profile saved. Only proposals in GitHub.

Krishna2323 · 2023-08-09T17:15:34Z

@twisterdotcom, but I haven't got any reporter role job for this one...
And the bot always says
"We're missing your Upwork ID to automatically send you an offer for the Reporter role.
Once you apply to the Upwork job, your Upwork ID will be stored and you will be automatically hired for future jobs!"

thienlnam · 2023-08-09T17:50:41Z

@Krishna2323 Can you please email the email address you linked to GH/Upwork to contributors@expensify.com and we can take a look from there?

Krishna2323 · 2023-08-09T18:13:35Z

@thienlnam, email sent, thanks.

melvin-bot · 2023-08-10T20:03:41Z

Reviewing label has been removed, please complete the "BugZero Checklist".

melvin-bot · 2023-08-10T20:03:44Z

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: don't mark completed task as archive report #24150

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

@parasharrajat does not require payment (Eligable for Manual Requests)
@dukenv0307 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 · 2023-08-10T20:03:46Z

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:

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

Krishna2323 · 2023-08-17T14:23:41Z

hi @thienlnam, still haven't received job offer for reporter role.

parasharrajat · 2023-08-17T15:09:51Z

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:

[@parasharrajat] The PR that introduced the bug has been identified. Link to the PR: Show tasks in LHN #18931
[@parasharrajat] 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/18931/files#r1297365650
[@parasharrajat] 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: Not required
[@parasharrajat] Determine if we should create a regression test for this bug. Yes
[@parasharrajat] If we decide to create a [regression test] (https://github.com/Expensify/App/blob/main/contributingGuides/REGRESSION_TEST_BEST_PRACTICES.md?rgh-link-date=2023-06-22T16%3A41%3A44Z) for the bug, please propose the regression test steps to ensure the same bug will not reach production again.

Regression Test Steps

Create a task
Set it to complete.
Open the task report and write a draft message but do not send it & observe the sidebar
Verify that the report goes to the top ( but still below pinned reports ).
send the draft message.
Verify that the report stays on top at the same position.

Do you agree 👍 or 👎 ?

thienlnam · 2023-08-17T15:13:56Z

@Krishna2323 I took a look, and our automation doesn't work with the Upwork custom profile links. You'll have to update your stored upwork link to your regular profile link. Can you paste the below in a comment?

Contributor details
Your Expensify account email: belivethatkg@gmail.com
Upwork Profile Link: https://www.upwork.com/freelancers/~011653c0d62a6dc458

twisterdotcom · 2023-08-17T15:25:17Z

Payment Summary:

@parasharrajat will be paid $1500 via newDot
@dukenv0307 has been paid $1500 via Upwork: https://www.upwork.com/nx/wm/workroom/34468017/overview
@Krishna2323 will be paid $250 here: https://www.upwork.com/nx/wm/offer/26179979 (just accept the offer! but also let's store your Upwork details for future too following @thienlnam's instructions).

Krishna2323 · 2023-08-17T16:13:23Z

Contributor details
Your Expensify account email: belivethatkg@gmail.com
Upwork Profile Link: https://www.upwork.com/freelancers/~011653c0d62a6dc458

melvin-bot · 2023-08-17T16:13:25Z

✅ Contributor details stored successfully. Thank you for contributing to Expensify!

Krishna2323 · 2023-08-17T16:15:05Z

@thienlnam, thanks a lot.

parasharrajat · 2023-08-17T18:00:05Z

Payment requested.

JmillsExpensify · 2023-08-18T03:40:29Z

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

kavimuru added Daily KSv2 Bug Something is broken. Auto assigns a BugZero manager. labels Jul 30, 2023

melvin-bot bot assigned twisterdotcom Jul 30, 2023

twisterdotcom closed this as completed Jul 31, 2023

twisterdotcom reopened this Jul 31, 2023

melvin-bot bot added the Overdue label Aug 2, 2023

melvin-bot bot removed the Overdue label Aug 3, 2023

twisterdotcom added External Added to denote the issue can be worked on by a contributor Overdue labels Aug 3, 2023

melvin-bot bot changed the title ~~Completed task gets re-indexed if edited.~~ [$1000] Completed task gets re-indexed if edited. Aug 3, 2023

melvin-bot bot added the Help Wanted Apply this label when an issue is open to proposals by contributors label Aug 3, 2023

melvin-bot bot assigned parasharrajat Aug 3, 2023

twisterdotcom removed the Overdue label Aug 3, 2023

melvin-bot bot added Weekly KSv2 Awaiting Payment Auto-added when associated PR is deployed to production and removed Weekly KSv2 labels Aug 10, 2023

melvin-bot bot changed the title ~~[$1000] Completed task gets re-indexed if edited.~~ [HOLD for payment 2023-08-17] [$1000] Completed task gets re-indexed if edited. Aug 10, 2023

melvin-bot bot removed the Reviewing Has a PR in review label Aug 10, 2023

parasharrajat mentioned this issue Aug 17, 2023

Show tasks in LHN #18931

Merged

56 tasks

This comment was marked as off-topic.

Sign in to view

twisterdotcom closed this as completed Aug 17, 2023

[HOLD for payment 2023-08-17] [$1000] Completed task gets re-indexed if edited. #23883

[HOLD for payment 2023-08-17] [$1000] Completed task gets re-indexed if edited. #23883

Comments

kavimuru commented Jul 30, 2023 • edited by melvin-bot bot Loading

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

melvin-bot bot commented Jul 30, 2023

melvin-bot bot commented Jul 30, 2023

Bug0 Triage Checklist (Main S/O)

niteshletxsoft commented Jul 30, 2023 • edited Loading

Proposal

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

What is the root cause of that problem?

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

What alternative solutions did you explore? (Optional)

dukenv0307 commented Jul 31, 2023

twisterdotcom commented Jul 31, 2023

thienlnam commented Jul 31, 2023

twisterdotcom commented Jul 31, 2023

niteshletxsoft commented Aug 1, 2023

dukenv0307 commented Aug 2, 2023

Proposal

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

What is the root cause of that problem?

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

Therefore, after marking a completed task as non archived report, the after adding a new comment, completed tasks will stay on top in LHN

Result:

What alternative solutions did you explore? (Optional)

dukenv0307 commented Aug 2, 2023

melvin-bot bot commented Aug 3, 2023

twisterdotcom commented Aug 3, 2023

melvin-bot bot commented Aug 3, 2023

melvin-bot bot commented Aug 3, 2023

melvin-bot bot commented Aug 3, 2023

twisterdotcom commented Aug 3, 2023

parasharrajat commented Aug 3, 2023

dukenv0307 commented Aug 8, 2023

parasharrajat commented Aug 8, 2023 • edited Loading

melvin-bot bot commented Aug 9, 2023

twisterdotcom commented Aug 9, 2023

parasharrajat commented Aug 9, 2023

Krishna2323 commented Aug 9, 2023 • edited Loading

twisterdotcom commented Aug 9, 2023

Krishna2323 commented Aug 9, 2023

thienlnam commented Aug 9, 2023 • edited Loading

Krishna2323 commented Aug 9, 2023

melvin-bot bot commented Aug 10, 2023

melvin-bot bot commented Aug 10, 2023

melvin-bot bot commented Aug 10, 2023

Krishna2323 commented Aug 17, 2023

parasharrajat commented Aug 17, 2023

Regression Test Steps

thienlnam commented Aug 17, 2023

This comment was marked as off-topic.

twisterdotcom commented Aug 17, 2023

Krishna2323 commented Aug 17, 2023

melvin-bot bot commented Aug 17, 2023

Krishna2323 commented Aug 17, 2023

parasharrajat commented Aug 17, 2023

JmillsExpensify commented Aug 18, 2023

kavimuru commented Jul 30, 2023 •

edited by melvin-bot bot

Loading

niteshletxsoft commented Jul 30, 2023 •

edited

Loading

parasharrajat commented Aug 8, 2023 •

edited

Loading

Krishna2323 commented Aug 9, 2023 •

edited

Loading

thienlnam commented Aug 9, 2023 •

edited

Loading