[HOLD for payment 2024-01-11] [$1000] Draft message doesn't remain when It is empty #25488

kavimuru · 2023-08-18T14:16:40Z

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:

Go to any chat
Send new message
Edit this message
Replace the message by empty string (don't click save)
Click another report
Back to previous report

Expected Result:

Draft message should be remained
Note that: When replacing draft message by another string, It will be remained

Actual Result:

Draft message doesn't remain

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

Recording.5919.mp4

Screen.Recording.2023-08-09.at.10.15.13.1.mov

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

View all open jobs on GitHub

Upwork Automation - Do Not Edit

Upwork Job URL: https://www.upwork.com/jobs/~01adda4a6239a4a1af
Upwork Job ID: 1693680071403327488
Last Price Increase: 2023-09-11

melvin-bot · 2023-08-18T14:16:46Z

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

melvin-bot · 2023-08-18T14:16:48Z

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

samh-nl · 2023-08-18T15:15:37Z

Proposal

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

Draft message doesn't remain when It is empty

What is the root cause of that problem?

When the draft is made empty, we reset it to the original message:

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

Lines 203 to 210 in a068ca5

    
           // This component is rendered only when draft is set to a non-empty string. In order to prevent component 
        
           // unmount when user deletes content of textarea, we set previous message instead of empty string. 
        
           if (newDraft.trim().length > 0) { 
        
               // We want to escape the draft message to differentiate the HTML from the report action and the HTML the user drafted. 
        
               debouncedSaveDraft(_.escape(newDraft)); 
        
           } else { 
        
               debouncedSaveDraft(props.action.message[0].html); 
        
           }

This is because if the value is empty, we assume editing is not occurring and we unmount ReportActionItemMessageEdit:

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

Lines 337 to 339 in f6fad4e

    
           {!props.draftMessage ? ( 
        
               <View style={props.displayAsGroup && hasBeenFlagged ? styles.blockquote : {}}> 
        
                   <ReportActionItemMessage

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

We should use a value of undefined to check that editing is not occurring.

To achieve this, we should change:

1. Update deleteDraft to remove the Onyx record instead of making it an empty string:

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

Lines 283 to 287 in 82ee577

    
           const deleteDraft = useCallback(() => { 
        
               InputFocus.callback(() => setIsFocused(false)); 
        
               InputFocus.inputFocusChange(false); 
        
               debouncedSaveDraft.cancel(); 
        
               Report.saveReportActionDraft(props.reportID, props.action, '');

2. Use _.isUndefined here:

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

Line 422 in 82ee577

{!props.draftMessage ? (

3. Always save the newDraft value, instead of using a fallback to the original message if the length is 0:

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

Lines 265 to 270 in 82ee577

    
           if (newDraft.trim().length > 0) { 
        
               // We want to escape the draft message to differentiate the HTML from the report action and the HTML the user drafted. 
        
               debouncedSaveDraft(_.escape(newDraft)); 
        
           } else { 
        
               debouncedSaveDraft(props.action.message[0].html); 
        
           }

4. Update saveReportActionDraft here:
We will store it as an object, so that we can migrate and remove existing empty values by checking if it's a string.

- Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS_DRAFTS}${originalReportID}`, {[reportAction.reportActionID]: draftMessage});
+ Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS_DRAFTS}${originalReportID}`, {[reportAction.reportActionID]: { message: draftMessage }});

5. Don't use empty string as default value and update key here:
In memo we check prevProps.draftMessage === nextProps.draftMessage so we need to be able to capture if a draft is deleted ('' -> undefined) or created (undefined -> '').

-            return lodashGet(drafts, [draftKey, props.action.reportActionID], '');
+            return lodashGet(drafts, [draftKey, props.action.reportActionID, 'message']);

6. Migration to remove existing empty drafts

See migration code

import Onyx from 'react-native-onyx';
import _ from 'underscore';
import Log from '@libs/Log';
import ONYXKEYS from '@src/ONYXKEYS';

/**
 * This migration removes empty drafts from reportActionsDrafts.
 *
 * @returns {Promise}
 */
export default function () {
    return new Promise((resolve) => {
        const connectionID = Onyx.connect({
            key: ONYXKEYS.COLLECTION.REPORT_ACTIONS_DRAFTS,
            waitForCollectionCallback: true,
            callback: (allReportActionsDrafts) => {
                Onyx.disconnect(connectionID);

                if (!allReportActionsDrafts) {
                    Log.info('[Migrate Onyx] Skipped migration RemoveEmptyReportActionsDrafts because there were no reportActionsDrafts');
                    return resolve();
                }

                const newReportActionsDrafts = {};
                _.each(allReportActionsDrafts, (reportActionDrafts, onyxKey) => {
                    newReportActionsDrafts[onyxKey] = {};

                    // Whether there is at least one draft in this report that has to be migrated
                    let hasUnmigratedDraft = false;

                    _.each(reportActionDrafts, (reportActionDraft, reportActionID) => {
                        // If the draft is a string, it means it hasn't been migrated yet
                        if (_.isString(reportActionDraft)) {
                            hasUnmigratedDraft = true;
                            Log.info(`[Migrate Onyx] Migrating draft for report action ${reportActionID}`);

                            if (_.isEmpty(reportActionDraft)) {
                                Log.info(`[Migrate Onyx] Removing draft for report action ${reportActionID}`);
                                return;
                            }

                            newReportActionsDrafts[onyxKey][reportActionID] = {message: reportActionDraft};
                        } else {
                            // We've already migrated this draft, so keep the existing value
                            newReportActionsDrafts[onyxKey][reportActionID] = reportActionDraft;
                        }
                    });

                    if (_.isEmpty(newReportActionsDrafts[onyxKey])) {
                        // Clear if there are no drafts remaining
                        newReportActionsDrafts[onyxKey] = null;
                    } else if (!hasUnmigratedDraft) {
                        // All drafts for this report have already been migrated, there's no need to overwrite this onyx key with the same data
                        delete newReportActionsDrafts[onyxKey];
                    }
                });

                if (_.isEmpty(newReportActionsDrafts)) {
                    Log.info('[Migrate Onyx] Skipped migration RemoveEmptyReportActionsDrafts because there are no actions drafts to migrate');
                    return resolve();
                }

                Log.info(`[Migrate Onyx] Ran migration RemoveEmptyReportActionsDrafts and updated drafts for ${_.keys(newReportActionsDrafts).length} reports`);
                // eslint-disable-next-line rulesdir/prefer-actions-set-data
                return Onyx.multiSet(newReportActionsDrafts).then(resolve);
            },
        });
    });
}

What alternative solutions did you explore? (Optional)

N/A

melvin-bot · 2023-08-18T16:24:18Z

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

melvin-bot · 2023-08-18T16:24:20Z

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

flaviadefaria · 2023-08-18T16:24:37Z

@greg-schroeder I'm logging off now and will be OoO for the next week so reassigning this to you in the meantime. Thanks!

greg-schroeder · 2023-08-19T01:21:18Z

Ok, sure!

greg-schroeder · 2023-08-19T01:22:42Z

Hmmmmm. I don't know about this. Why would a user replace a message with an empty string, not save it, and then switch between reports? That doesn't seem like a use case that would be commonly encountered to me. I don't know that we should optimize for that.

greg-schroeder · 2023-08-19T01:24:58Z

Started a discussion

melvin-bot · 2023-08-21T17:42:53Z

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

melvin-bot · 2023-08-21T17:42:57Z

Triggered auto assignment to @adelekennedy (External), see https://stackoverflow.com/c/expensify/questions/8582 for more details.

melvin-bot · 2023-08-21T17:43:02Z

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

greg-schroeder · 2023-08-21T17:43:15Z

Team agreed it's worth moving over to External

greg-schroeder · 2024-01-03T20:24:01Z

This is on staging, awaiting deploy to prod

melvin-bot · 2024-01-04T18:24:51Z

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

melvin-bot · 2024-01-04T18:24:55Z

The solution for this issue has been 🚀 deployed to production 🚀 in version 1.4.21-4 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

Allow empty draft messages #33500

If no regressions arise, payment will be issued on 2024-01-11. 🎊

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:

@mollfpr requires payment (Needs manual offer from BZ)
@samh-nl requires payment (Needs manual offer from BZ)
@dukenv0307 requires payment (Needs manual offer from BZ)

melvin-bot · 2024-01-04T18:24:56Z

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:

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

melvin-bot · 2024-01-11T17:09:46Z

Issue is ready for payment but no BZ is assigned. @sonialiap you are the lucky winner! Please verify the payment summary looks correct and complete the checklist. Thanks!

melvin-bot · 2024-01-11T17:09:50Z

Payment Summary

Upwork Job

ROLE: @mollfpr paid $(AMOUNT) via Upwork (LINK)
ROLE: @samh-nl paid $(AMOUNT) via Upwork (LINK)

BugZero Checklist (@sonialiap)

I have verified the correct assignees and roles are listed above and updated the neccesary manual offers
I have verified that there are no duplicate or incorrect contracts on Upwork for this job (https://www.upwork.com/ab/applicants/1693680071403327488/hired)
I have paid out the Upwork contracts or cancelled the ones that are incorrect
I have verified the payment summary above is correct

greg-schroeder · 2024-01-12T04:13:43Z

You can ignore this @sonialiap, it's a bug, I will handle payment

mollfpr · 2024-01-12T04:14:33Z

[@mollfpr] The PR that introduced the bug has been identified. Link to the PR:
[@mollfpr] 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:

No offending PR.

[@mollfpr] 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:

The regression test should be good.

[@mollfpr] Determine if we should create a regression test for this bug.
[@mollfpr] 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.

Open any report
Send a message
Press the Edit button in the newly added message
Empty the draft message input
Navigate to a different report
Return to the first report
Verify that the draft message input is empty
👍 or 👎

@greg-schroeder No need to send me the offer; I'll make a manual request in NewDot. Thank you!

greg-schroeder · 2024-01-12T04:23:00Z

reporter: $50
c: $500
c+: $500

Offers sent to @dukenv0307 and @samh-nl, and you can do a manual request @mollfpr.

greg-schroeder · 2024-01-12T04:23:05Z

filing regression test

JmillsExpensify · 2024-01-14T08:39:15Z

$500 payment approved for @mollfpr (c+) based on summary above.

samh-nl · 2024-01-14T12:02:36Z

Thanks all! I'd just like to check on the accuracy of the bounty, as this issue stems from Aug last year.

dukenv0307 · 2024-01-14T16:47:26Z

reporter: $50

@greg-schroeder based on this announcement, the $250 reporting bonus still applies for issues opened before Aug 30, 2023. This issue was created on Aug 18, 2023, so I think it qualifies there.

Could you send me another offer for $250, thanks!

samh-nl · 2024-01-29T16:05:46Z

Bump

greg-schroeder · 2024-01-29T22:19:36Z

Sorry all, let me review this one

greg-schroeder · 2024-01-29T22:24:01Z

Hmm. This is tricky. The issue was reported/created in August before our first pricing changes, but no PR was created until late 2023, well after our payscale changed. I think we could probably honor the original reporting bonus given the date, but the work done on the PR took place well after the $500 baseline was established. That seems most fair to me.

samh-nl · 2024-01-30T10:29:18Z

True, even though the initial proposal was made under a different premise.
But I can follow your reasoning as well. I've accepted the offer on Upwork.

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

melvin-bot bot assigned flaviadefaria Aug 18, 2023

flaviadefaria removed their assignment Aug 18, 2023

flaviadefaria added Bug Something is broken. Auto assigns a BugZero manager. and removed Bug Something is broken. Auto assigns a BugZero manager. labels Aug 18, 2023

melvin-bot bot assigned greg-schroeder Aug 18, 2023

flaviadefaria self-assigned this Aug 18, 2023

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

greg-schroeder added the External Added to denote the issue can be worked on by a contributor label Aug 21, 2023

melvin-bot bot changed the title ~~Draft message doesn't remain when It is empty~~ [$1000] Draft message doesn't remain when It is empty Aug 21, 2023

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

melvin-bot bot assigned adelekennedy Aug 21, 2023

melvin-bot bot assigned mollfpr Aug 21, 2023

greg-schroeder unassigned adelekennedy and flaviadefaria Aug 21, 2023

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

melvin-bot bot added Weekly KSv2 Awaiting Payment Auto-added when associated PR is deployed to production and removed Weekly KSv2 labels Jan 4, 2024

melvin-bot bot changed the title ~~[$1000] Draft message doesn't remain when It is empty~~ [HOLD for payment 2024-01-11] [$1000] Draft message doesn't remain when It is empty Jan 4, 2024

melvin-bot bot removed the Reviewing Has a PR in review label Jan 4, 2024

melvin-bot bot added Daily KSv2 and removed Weekly KSv2 labels Jan 11, 2024

melvin-bot bot assigned sonialiap Jan 11, 2024

greg-schroeder unassigned sonialiap Jan 12, 2024

greg-schroeder mentioned this issue Jan 12, 2024

[$500] Payment issue for #25488 #34405

Closed

greg-schroeder closed this as completed Jan 12, 2024

greg-schroeder reopened this Jan 29, 2024

greg-schroeder closed this as completed Jan 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[HOLD for payment 2024-01-11] [$1000] Draft message doesn't remain when It is empty #25488

[HOLD for payment 2024-01-11] [$1000] Draft message doesn't remain when It is empty #25488

kavimuru commented Aug 18, 2023 •

edited by melvin-bot bot

Loading

melvin-bot bot commented Aug 18, 2023

melvin-bot bot commented Aug 18, 2023 •

edited by greg-schroeder

Loading

samh-nl commented Aug 18, 2023 •

edited

Loading

melvin-bot bot commented Aug 18, 2023

melvin-bot bot commented Aug 18, 2023

flaviadefaria commented Aug 18, 2023

greg-schroeder commented Aug 19, 2023

greg-schroeder commented Aug 19, 2023 •

edited

Loading

greg-schroeder commented Aug 19, 2023

melvin-bot bot commented Aug 21, 2023

melvin-bot bot commented Aug 21, 2023

melvin-bot bot commented Aug 21, 2023

greg-schroeder commented Aug 21, 2023

greg-schroeder commented Jan 3, 2024

melvin-bot bot commented Jan 4, 2024

melvin-bot bot commented Jan 4, 2024

melvin-bot bot commented Jan 4, 2024

melvin-bot bot commented Jan 11, 2024

melvin-bot bot commented Jan 11, 2024

greg-schroeder commented Jan 12, 2024

mollfpr commented Jan 12, 2024

greg-schroeder commented Jan 12, 2024

greg-schroeder commented Jan 12, 2024

JmillsExpensify commented Jan 14, 2024

samh-nl commented Jan 14, 2024

dukenv0307 commented Jan 14, 2024

samh-nl commented Jan 29, 2024

greg-schroeder commented Jan 29, 2024

greg-schroeder commented Jan 29, 2024

samh-nl commented Jan 30, 2024

[HOLD for payment 2024-01-11] [$1000] Draft message doesn't remain when It is empty #25488

[HOLD for payment 2024-01-11] [$1000] Draft message doesn't remain when It is empty #25488

Comments

kavimuru commented Aug 18, 2023 • edited by melvin-bot bot Loading

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

melvin-bot bot commented Aug 18, 2023

melvin-bot bot commented Aug 18, 2023 • edited by greg-schroeder Loading

Bug0 Triage Checklist (Main S/O)

samh-nl commented Aug 18, 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)

melvin-bot bot commented Aug 18, 2023

melvin-bot bot commented Aug 18, 2023

Bug0 Triage Checklist (Main S/O)

flaviadefaria commented Aug 18, 2023

greg-schroeder commented Aug 19, 2023

greg-schroeder commented Aug 19, 2023 • edited Loading

greg-schroeder commented Aug 19, 2023

melvin-bot bot commented Aug 21, 2023

melvin-bot bot commented Aug 21, 2023

melvin-bot bot commented Aug 21, 2023

greg-schroeder commented Aug 21, 2023

greg-schroeder commented Jan 3, 2024

melvin-bot bot commented Jan 4, 2024

melvin-bot bot commented Jan 4, 2024

melvin-bot bot commented Jan 4, 2024

melvin-bot bot commented Jan 11, 2024

melvin-bot bot commented Jan 11, 2024

Payment Summary

BugZero Checklist (@sonialiap)

greg-schroeder commented Jan 12, 2024

mollfpr commented Jan 12, 2024

greg-schroeder commented Jan 12, 2024

greg-schroeder commented Jan 12, 2024

JmillsExpensify commented Jan 14, 2024

samh-nl commented Jan 14, 2024

dukenv0307 commented Jan 14, 2024

samh-nl commented Jan 29, 2024

greg-schroeder commented Jan 29, 2024

greg-schroeder commented Jan 29, 2024

samh-nl commented Jan 30, 2024

kavimuru commented Aug 18, 2023 •

edited by melvin-bot bot

Loading

melvin-bot bot commented Aug 18, 2023 •

edited by greg-schroeder

Loading

samh-nl commented Aug 18, 2023 •

edited

Loading

greg-schroeder commented Aug 19, 2023 •

edited

Loading