Fix deleting parent thread message temporary disappearing #26548

Nodebrute · 2023-09-02T05:39:24Z

Details

Fixed Issues

$ #23139
$ #23139 (comment)

Tests

Send a message.
Click on "Reply in Thread."
In the thread, delete the parent message.
Notice that the parent message does not disappear.

Test 2

Send a message.
Click on "Reply in Thread."
Send some messages in the thread.
Go back to the parent report.
Delete the message with thread replies.
Verify that the message does not disappear.

Verify that no errors appear in the JS console

Offline tests

same as above

QA Steps

Send a message.
Click on "Reply in Thread."
In the thread, delete the parent message.
Notice that the parent message does not disappear.

Test 2

Send a message.
Click on "Reply in Thread."
Send some messages in the thread.
Go back to the parent report.
Delete the message with thread replies.
Verify that the message does not disappear.

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Untitled.3.mp4

Mobile Web - Chrome

Untitled.2.mp4

Mobile Web - Safari

Untitled.4.mp4

Desktop

Untitled.1.mp4

iOS

Untitled.5.mp4

Android

Untitled.7.mp4

melvin-bot · 2023-09-02T05:39:29Z

@fedirjh 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]

Nodebrute · 2023-09-02T05:41:21Z

@fedirjh Thank you for your patience. Unfortunately, we're currently experiencing an issue https://expensify.slack.com/archives/C01GTK53T8Q/p1693595827771879 that has resulted in the native iOS and Android test videos being missing. I'll make sure to attach those videos as soon as the issue is resolved

fedirjh

Left some concern about the optimistic data.

fedirjh · 2023-09-03T09:19:26Z

src/libs/ReportUtils.js

@@ -1797,6 +1797,7 @@ function buildOptimisticAddCommentReportAction(text, file) {
            attachmentInfo,
            pendingAction: CONST.RED_BRICK_ROAD_PENDING_ACTION.ADD,
            shouldShow: true,
+            childType: 'chat',


Suggested change

childType: 'chat',

childType: CONST.REPORT.TYPE.CHAT,

@Nodebrute I am not sure if this is the correct place to apply the optimistic data. This change will affect all created comments, even those that don't have a child report.

I think it makes sense to apply the optimistic data when we navigate to the child report inside navigateToAndOpenChildReport.

Hey @fedirjh, you're absolutely right. Thank you for catching this bug. Please excuse my inexperience, but could you please guide me on how to set data optimistically here?

@fedirjh gentle bump

Hey @Nodebrute Thanks for the ping. After looking at the code, the changes should be applied to this line and we should add the failureData as well.

App/src/libs/actions/Report.js

Lines 526 to 532 in e552700

// If we are creating a thread, ensure the report action has childReportID property added

if (newReportObject.parentReportID && parentReportActionID) {

onyxData.optimisticData.push({

onyxMethod: Onyx.METHOD.MERGE,

key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${newReportObject.parentReportID}`,

value: {[parentReportActionID]: {childReportID: reportID}},

});

Thank you for your patience and for assisting me, @fedirjh. I've implemented the suggested changes, and I've attached all the test videos. Your review would be greatly appreciated.

Please inform me if there is anything else I may have overlooked.

cc @Nodebrute Looks good and tests well, just left some minor code improvements.

fedirjh · 2023-09-05T08:12:11Z

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 / Chrome
- iOS / native
- iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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(themeColors.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 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

Web

CleanShot.2023-09-05.at.08.25.27.mp4

CleanShot.2023-09-05.at.08.27.11.mp4

Mobile Web - Chrome

CleanShot.2023-09-05.at.08.52.27.mp4

Mobile Web - Safari

CleanShot.2023-09-05.at.08.40.38.mp4

Desktop

CleanShot.2023-09-05.at.08.33.32.mp4

iOS

CleanShot.2023-09-05.at.08.45.49.mp4

Android

CleanShot.2023-09-05.at.09.06.34.mp4

fedirjh

Tests well, Left some comments about the code.

fedirjh · 2023-09-05T08:29:32Z

src/libs/ReportActionsUtils.js

 * @param {Object} reportAction
+ * @param {Number} reportID


Suggested change

* @param {Number} reportID

* @param {String} reportID

reportID has type string.

Let's address this comment as well.

I'm not sure how I overlooked this, but I've just corrected it.

fedirjh · 2023-09-05T08:29:38Z

src/pages/home/report/ReportActionItemMessage.js

@@ -53,7 +53,7 @@ function ReportActionItemMessage(props) {
                        fragment={fragment}
                        isAttachment={props.action.isAttachment}
                        iouMessage={iouMessage}
-                        hasCommentThread={ReportActionsUtils.hasCommentThread(props.action)}
+                        isThreadParentMessage={ReportActionsUtils.isThreadParentMessage(props.action, props.reportID)}


Let's add this prop reportID to the propTypes definition.

cc @Nodebrute , props.reportID is not defined in the propTypes , it should be added to this block

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

Line 13 in 1223e1e

const propTypes = {

I've just fixed this one as well. I apologize for the numerous mistakes.

fedirjh · 2023-09-05T08:32:15Z

src/libs/ReportActionsUtils.js

+function isThreadParentMessage(reportAction, reportID) {
+    return (
+        lodashGet(reportAction, 'childType', '') === CONST.REPORT.TYPE.CHAT &&
+        (lodashGet(reportAction, 'childVisibleActionCount', 0) > 0 || (!_.isUndefined(reportAction.childReportID) && reportAction.childReportID.toString() === reportID))
+    );


Suggested change

function isThreadParentMessage(reportAction, reportID) {

return (

lodashGet(reportAction, 'childType', '') === CONST.REPORT.TYPE.CHAT &&

(lodashGet(reportAction, 'childVisibleActionCount', 0) > 0 || (!_.isUndefined(reportAction.childReportID) && reportAction.childReportID.toString() === reportID))

);

function isThreadParentMessage(reportAction = {}, reportID) {

const {childType, childVisibleActionCount = 0, childReportID} = reportAction;

return childType === CONST.REPORT.TYPE.CHAT && (childVisibleActionCount > 0 || String(childReportID) === reportID);

NAB: Let's improve the code readability.

Thank you for your suggestions; I've just applied the recommended changes.

cc @Nodebrute Thanks for the update , let's make sure to resolve other comments as well.

fedirjh

Looks good to me and tests well.

🎀 👀 🎀 C+ reviewed

Beamanator

Few comments and small requested changes 🙏

src/libs/ReportActionsUtils.js

src/pages/home/report/ReportActionItemFragment.js

src/libs/ReportActionsUtils.js

Beamanator

LGTM!

Small feedback for you, @Nodebrute :

Thanks SO much for following through on the long proposal process & getting this PR up quickly & responding to feedback quickly 👍 👍
I'd recommend making a strong PR title that explains more succinctly its purpose
When you finish dealing with any comment (from me or @fedirjh ), it would be great if you could resolve it yourself so we don't go back and have to question if each comment was addressed or not. If you have more questions about any comment or want our feedback on your solution related to any comment, feel free to keep it open & tag us again so we know to look at it again

Thanks again!!

OSBotify · 2023-09-11T03:23:07Z

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

OSBotify · 2023-09-12T00:18:13Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.3.68-0 🚀

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

OSBotify · 2023-09-13T08:44:40Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.68-17 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

temporary message disappears

9cc6747

Nodebrute requested a review from a team as a code owner September 2, 2023 05:39

melvin-bot bot requested review from fedirjh and removed request for a team September 2, 2023 05:39

fedirjh reviewed Sep 3, 2023

View reviewed changes

Nodebrute and others added 2 commits September 4, 2023 20:03

Merge branch 'Expensify:main' into threadHeader

bffb906

set optimistic childType

39a1074

fedirjh suggested changes Sep 5, 2023

View reviewed changes

Nodebrute and others added 4 commits September 6, 2023 05:00

Merge branch 'Expensify:main' into threadHeader

30b84db

improve code readability

acb86ef

Merge branch 'Expensify:main' into threadHeader

1185100

apply suggested changes

0de1ea8

fedirjh approved these changes Sep 6, 2023

View reviewed changes

melvin-bot bot requested a review from Beamanator September 6, 2023 16:23

Beamanator requested changes Sep 9, 2023

View reviewed changes

src/libs/ReportActionsUtils.js Outdated Show resolved Hide resolved

src/pages/home/report/ReportActionItemFragment.js Show resolved Hide resolved

src/libs/ReportActionsUtils.js Show resolved Hide resolved

Nodebrute and others added 2 commits September 10, 2023 17:50

Merge branch 'Expensify:main' into threadHeader

fa514e4

comments fixed

326010b

Beamanator self-requested a review September 11, 2023 03:14

Beamanator changed the title ~~temporary message disappears~~ Fix parent thread message temporary disappearing Sep 11, 2023

Beamanator changed the title ~~Fix parent thread message temporary disappearing~~ Fix deleting parent thread message temporary disappearing Sep 11, 2023

Beamanator approved these changes Sep 11, 2023

View reviewed changes

Beamanator merged commit 4abaeba into Expensify:main Sep 11, 2023
14 checks passed

OSBotify mentioned this pull request Sep 12, 2023

Deploy Checklist: New Expensify 2023-09-12 #27210

Closed

melvin-bot bot mentioned this pull request Sep 13, 2023

[HOLD for payment 2023-09-20] [$1000] Temporary thread message disappearance when deleting a thread message #23139

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix deleting parent thread message temporary disappearing #26548

Fix deleting parent thread message temporary disappearing #26548

Nodebrute commented Sep 2, 2023 •

edited

Loading

melvin-bot bot commented Sep 2, 2023

Nodebrute commented Sep 2, 2023

fedirjh left a comment

fedirjh Sep 3, 2023

Nodebrute Sep 3, 2023

Nodebrute Sep 4, 2023

fedirjh Sep 4, 2023

Nodebrute Sep 4, 2023

Nodebrute Sep 4, 2023

fedirjh Sep 5, 2023

fedirjh commented Sep 5, 2023

fedirjh left a comment

fedirjh Sep 5, 2023 •

edited

Loading

fedirjh Sep 6, 2023

Nodebrute Sep 6, 2023

fedirjh Sep 5, 2023

fedirjh Sep 6, 2023

Nodebrute Sep 6, 2023

fedirjh Sep 5, 2023

Nodebrute Sep 6, 2023

fedirjh Sep 6, 2023

fedirjh left a comment

Beamanator left a comment

Beamanator left a comment

OSBotify commented Sep 11, 2023

OSBotify commented Sep 12, 2023

OSBotify commented Sep 13, 2023

	// If we are creating a thread, ensure the report action has childReportID property added
	if (newReportObject.parentReportID && parentReportActionID) {
	onyxData.optimisticData.push({
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${newReportObject.parentReportID}`,
	value: {[parentReportActionID]: {childReportID: reportID}},
	});

Fix deleting parent thread message temporary disappearing #26548

Fix deleting parent thread message temporary disappearing #26548

Conversation

Nodebrute commented Sep 2, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 2, 2023

Nodebrute commented Sep 2, 2023

fedirjh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fedirjh commented Sep 5, 2023

Reviewer Checklist

Screenshots/Videos

fedirjh left a comment

Choose a reason for hiding this comment

fedirjh Sep 5, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fedirjh left a comment

Choose a reason for hiding this comment

Beamanator left a comment

Choose a reason for hiding this comment

Beamanator left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 11, 2023

OSBotify commented Sep 12, 2023

OSBotify commented Sep 13, 2023

Nodebrute commented Sep 2, 2023 •

edited

Loading

fedirjh Sep 5, 2023 •

edited

Loading