Add comment text update by edit comment by gedu · Pull Request #51422 · Expensify/App

gedu · 2024-10-24T14:54:52Z

Details

When a EditComment is fired, the code will look for an AddComment or AttachmentWithText, if found it will look any UpdateComment in the middle to delete it, will get the AddMessage and update just the text from the EditComment.

This code is depends on: #50919

Fixed Issues

$ #50074
PROPOSAL: -

Tests

Normal Flow

Send a new message
Edit that new message
You should see an AddComment and later an UpdateComment

Pending Flow

On the devtool -> Network tab, make the connection a bit slower
Send a some new messages so the queue grows
Edit the last message
You should see an AddComment with the UpdateComment for the last message

Verify that no errors appear in the JS console

Offline tests

Delete No requests:

Go to offline
send a message
edit the message
add a emoji reaction
delete the message
Go to online
No requests should be sent

No delete Threads

Go to offline
Send a message
create a thread
delete that message
Go to online
All the request must be sent

Update:

Go offline
Send a new message
Edit that new message
Go back online
Only AddComment request with the Edited text should be sent

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

updateCommentText_chrome.mp4

UpdateCommentText_safari.mp4

MacOS: Desktop

UpdateCommentText_desktop.mp4

# Conflicts: # src/libs/actions/Report.ts # src/libs/actions/RequestConflictUtils.ts # tests/actions/ReportTest.ts # tests/unit/RequestConflictUtilsTest.ts

…mment_text_update_by_edit_comment # Conflicts: # src/libs/actions/Report.ts # src/libs/actions/RequestConflictUtils.ts # tests/actions/ReportTest.ts

melvin-bot · 2024-10-24T14:54:57Z

@dukenv0307 Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

dukenv0307 · 2024-10-24T18:42:16Z

@gedu Lints are failed.

…mment_text_update_by_edit_comment # Conflicts: # tests/unit/RequestConflictUtilsTest.ts

dukenv0307 · 2024-10-25T17:57:56Z

@gedu Is it ready for review?

gedu · 2024-10-28T09:25:10Z

@dukenv0307 yes

dukenv0307 · 2024-10-29T16:53:44Z


    it('opens a chat and load initial messages', async () => {
        mockOpenReport(5, '5');
-


This change is unnecessary

dukenv0307 · 2024-10-29T16:54:23Z

Looks good, just one small problem ^

dukenv0307 · 2024-10-29T16:59:56Z

@gedu Can you add the test steps on the Test section then verify that no errors appear in the JS console?

dukenv0307 · 2024-10-29T17:01:47Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Screen.Recording.2024-10-30.at.11.00.01.mov

Android: mWeb Chrome

Screen.Recording.2024-10-30.at.10.45.46.mov

iOS: Native

Screen.Recording.2024-10-30.at.10.58.45.mov

iOS: mWeb Safari

Screen.Recording.2024-10-30.at.00.18.45.mov

MacOS: Chrome / Safari

web-resize.mp4

MacOS: Desktop

web-resize.mp4

dukenv0307 · 2024-10-29T17:23:46Z

@gedu Bug:

Disable internet connection
Add new comment
Edit comment
Observe that we can see the (edited)
Go online

Actual result: (edited) disappear in step 5

Expected result: (edited) shouldn't appear in step 4
https://github.com/user-attachments/assets/b4dc4831-abb1-4c8b-89d0-2d56b0f33012

gedu · 2024-10-29T18:37:22Z

@gedu Bug:

Disable internet connection

Add new comment

Edit comment

Observe that we can see the (edited)

Go online

Actual result: (edited) disappear in step 5

Expected result: (edited) shouldn't appear in step 4 https://github.com/user-attachments/assets/b4dc4831-abb1-4c8b-89d0-2d56b0f33012

@dukenv0307 It's not a bug, I commented here: #50074 (comment), technically we are editing so showing the edit it is ok, and because later we are merging the edit and the add, the edit label doesn't show up.

dukenv0307 · 2024-10-30T04:06:34Z

Thank you @gedu. LGTM

mountiny

Just NAB comments

mountiny · 2024-10-30T16:24:36Z

+        PersistedRequests.save(newRequest);
+    } else if (conflictAction.type === 'replace') {
+        PersistedRequests.update(conflictAction.index, conflictAction.request ?? newRequest);
+    } else if (conflictAction.type === 'delete') {


Might be good to make these types a const at this point

mountiny · 2024-10-30T16:26:46Z

+        if (request.command === WRITE_COMMANDS.OPEN_REPORT && request.data?.parentReportActionID === reportActionID && reportActionID in commentCouldBeThread) {
+            const indexToRemove = commentCouldBeThread[reportActionID];
+            commentIndicesToDelete.splice(indexToRemove, 1);
+            // The new message performs some changes in Onyx, we want to keep those changes.


Suggested change

// The new message performs some changes in Onyx, we want to keep those changes.

// The new message performs some changes in Onyx, we want to keep those changes.

mountiny · 2024-10-30T16:28:38Z

+
+        Report.addComment(REPORT_ID, 'Testing a comment');
+        // Need the reportActionID to delete the comments


Suggested change

Report.addComment(REPORT_ID, 'Testing a comment');

// Need the reportActionID to delete the comments

Report.addComment(REPORT_ID, 'Testing a comment');

// Need the reportActionID to delete the comments

OSBotify · 2024-10-30T16:42:00Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2024-10-31T11:41:30Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.56-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	success ✅

github-actions · 2024-11-04T14:14:14Z

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.56-9 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

gedu added 12 commits October 15, 2024 16:54

Adding conflict resolver for delete comment

c503b78

Merge branch 'main' into gedu/delete_comment_conflict_resolver

db367ac

Adding case for OpenReport when creating a thread

ecb7aaa

Merge branch 'main' into gedu/delete_comment_conflict_resolver

b26e6cd

Merge branch 'main' into gedu/delete_comment_conflict_resolver

aa0b105

Merge branch 'main' into gedu/delete_comment_conflict_resolver

06cdcf9

# Conflicts: # src/libs/actions/Report.ts # src/libs/actions/RequestConflictUtils.ts # tests/actions/ReportTest.ts # tests/unit/RequestConflictUtilsTest.ts

handle new update text update conflict

7184508

Fixed action type conflict when no AddComment

f87891d

Add new field to know if a request was rollbacked

c93b9b4

Merge branch 'main' into gedu/delete_comment_conflict_resolver

ca92e8b

# Conflicts: # src/libs/actions/Report.ts # src/libs/actions/RequestConflictUtils.ts # tests/actions/ReportTest.ts # tests/unit/RequestConflictUtilsTest.ts

Merge branch 'gedu/delete_comment_conflict_resolver' into gedu/add_co…

84a8e08

…mment_text_update_by_edit_comment # Conflicts: # src/libs/actions/Report.ts # src/libs/actions/RequestConflictUtils.ts # tests/actions/ReportTest.ts

Merge branch 'main' into gedu/add_comment_text_update_by_edit_comment

4324bd7

gedu requested a review from a team as a code owner October 24, 2024 14:54

melvin-bot Bot requested review from dukenv0307 and removed request for a team October 24, 2024 14:54

gedu mentioned this pull request Oct 24, 2024

[HOLD for payment 2024-11-11] [HOLD for payment 2024-11-05] [$250] De-dupe AddComment, EditComment, and DeleteComment requests #50074

Closed

gedu added 3 commits October 25, 2024 15:23

Fixed wrong indexing

abd5651

Merge branch 'gedu/delete_comment_conflict_resolver' into gedu/add_co…

0d2a266

…mment_text_update_by_edit_comment # Conflicts: # tests/unit/RequestConflictUtilsTest.ts

fixed lint issue

abb906f

change to run test again

71112b7

dukenv0307 reviewed Oct 29, 2024

View reviewed changes

Comment thread src/libs/actions/PersistedRequests.ts Resolved

dukenv0307 reviewed Oct 29, 2024

View reviewed changes

rolling back un-necessary change

ce50fdc

dukenv0307 approved these changes Oct 30, 2024

View reviewed changes

melvin-bot Bot requested a review from mountiny October 30, 2024 04:06

mountiny assigned gedu Oct 30, 2024

mountiny approved these changes Oct 30, 2024

View reviewed changes

mountiny merged commit 66195ad into Expensify:main Oct 30, 2024

gedu mentioned this pull request Oct 30, 2024

DeleteComment conflict resolver #50919

Closed

48 of 50 tasks

github-actions Bot mentioned this pull request Oct 31, 2024

Deploy Checklist: New Expensify 2024-10-31 #51778

Closed

lanitochka17 mentioned this pull request Oct 31, 2024

mWeb - Chat - Not here page displayed when going online after deleting a thread message #51825

Closed

1 of 8 tasks

mkzie2 mentioned this pull request Nov 8, 2024

Chat-The "edited" text disappears when go online #52215

Closed

1 of 8 tasks

NJ-2020 mentioned this pull request Nov 12, 2024

Сhat - Message deleted in offline are not striked out #52344

Closed

1 of 8 tasks


		it('opens a chat and load initial messages', async () => {
		mockOpenReport(5, '5');

	// The new message performs some changes in Onyx, we want to keep those changes.

	// The new message performs some changes in Onyx, we want to keep those changes.


		Report.addComment(REPORT_ID, 'Testing a comment');
		// Need the reportActionID to delete the comments

Conversation

gedu commented Oct 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Oct 24, 2024

Uh oh!

dukenv0307 commented Oct 24, 2024

Uh oh!

dukenv0307 commented Oct 25, 2024

Uh oh!

gedu commented Oct 28, 2024

Uh oh!

Uh oh!

dukenv0307 Oct 29, 2024

Choose a reason for hiding this comment

Uh oh!

dukenv0307 commented Oct 29, 2024

Uh oh!

dukenv0307 commented Oct 29, 2024

Uh oh!

dukenv0307 commented Oct 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

dukenv0307 commented Oct 29, 2024

Uh oh!

gedu commented Oct 29, 2024

Uh oh!

dukenv0307 commented Oct 30, 2024

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny Oct 30, 2024

Choose a reason for hiding this comment

Uh oh!

mountiny Oct 30, 2024

Choose a reason for hiding this comment

Uh oh!

mountiny Oct 30, 2024

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Oct 30, 2024

Uh oh!

github-actions Bot commented Oct 31, 2024

Uh oh!

github-actions Bot commented Nov 4, 2024

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

gedu commented Oct 24, 2024 •

edited

Loading

dukenv0307 commented Oct 29, 2024 •

edited

Loading