Reset last visible message on failure of attachment upload #22342

rojiphil · 2023-07-06T12:23:18Z

Details

The changes include adding failureReport to failureData so that if there is a failure in API.write operation, it will use the previous visible message text.
The changes are in addActions function so that this would work for both addAttachment and addComment

Fixed Issues

$ #19913
PROPOSAL: #19913 (comment)

Test

Click on any chat-based report in LHN to view the report screen.
Click on the actions button on the footer to show the actions menu.
Click 'Add Attachment' and select the corrupted file as attached in the issue.
Click on the 'Send` button in the Attachment modal to send the attachment.
Note that the sidebar screen in LHN for this chat report will show '[Attachment]'. Further, the 'Uploading Attachment' chat comes up in the chat report screen.
Once the attachment upload fails due to the corrupt file, we will observe a failure comment with "Unexpected error..."
At this time, verify that the sidebar screen in LHN for this chat report displays the last successful message instead of '[Attachment]'.

Verify that no errors appear in the JS console

Offline tests

Make Expensify offline.
Click on any chat-based report in LHN to view the report screen.
Click on the actions button on the footer to show the actions menu.
Click 'Add Attachment' and select the corrupted file as attached in the issue.
Click on the 'Send` button in the Attachment modal to send the attachment.
Note that the sidebar screen in LHN for this chat report will show '[Attachment]'. Further, the 'Uploading Attachment' chat comes up in the chat report screen.
The sidebar will continue to show this status as long as it is offline.
Make Expensify online.
Once the attachment upload fails due to the corrupt file, we will observe a failure comment with "Unexpected error..."
At this time, verify that the sidebar screen in LHN for this chat report displays the last successful message instead of 'Attachment'.

QA Steps

Same as above

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android/Native

21_andr-native-fix.mp4

Android/Chrome

22_andr-chrome-fix.mp4

iOS/Native

23_ios-native-fix.mp4

Web/Safari

26_mac-safari-web.mp4

Web/Chrome

25_web-chrome.mp4

MacOS/Desktop

27_mac-desktop.mp4

Android/Native Offline

28_andr-native-offline.mp4

melvin-bot · 2023-07-06T12:23:23Z

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

rojiphil · 2023-07-09T19:18:05Z

@rushatgabhane Friendly bump to review the PR

rushatgabhane · 2023-07-10T05:43:18Z

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

69b97565-0589-4a61-83b8-d21f992dc1ee.mp4

Mobile Web - Chrome

WhatsApp.Video.2023-07-10.at.11.35.41.mp4

Mobile Web - Safari

Screen.Recording.2023-07-10.at.11.42.04.mov

Desktop

Screen.Recording.2023-07-10.at.11.12.44.mov

iOS

Screen.Recording.2023-07-10.at.11.38.58.mov

Android

Screen.Recording.2023-07-10.at.11.27.17.mov

rushatgabhane · 2023-07-10T05:47:44Z

Offline and online behavior tests well

rushatgabhane

@techievivek LGTM

techievivek

Just a quick question around lastReadTime key in failureData.

techievivek · 2023-07-10T07:02:08Z

src/libs/actions/Report.js

@@ -294,7 +295,16 @@ function addActions(reportID, text = '', file) {
        },
    ];

+    const failureReport = {
+        lastMessageText: prevVisibleMessageText,
+        lastReadTime: currentTime,


Do we need to set the lastReadTime in failureData? Curious to learn what purpose does it serve here?

Thanks for pointing this out. Actually, lastReadTime is not required. It is a redundant code. Sorry about that. I have removed it and tested it across 3 platforms and it works well. I will test with the remaining platforms as well and update the code.

techievivek

Looks good.

melvin-bot · 2023-07-10T14:22:59Z

@techievivek looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

techievivek · 2023-07-10T14:24:00Z

Not an emergency merge, all the tests were passing.

OSBotify · 2023-07-10T14:39:34Z

✋ 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-07-11T00:19:58Z

🚀 Deployed to staging by https://github.com/techievivek in version: 1.3.39-0 🚀

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

OSBotify · 2023-07-13T01:44:00Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.39-11 🚀

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

s77rt · 2023-09-06T22:30:35Z

src/libs/actions/Report.js

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


This caused a regression. If we send a message after the attachment and delete that message the LHN would appear again as [Attachment]. Not exactly a bug from this PR but it caused the inconsistency as previously seeing [Attachment] in LHN was the expected results.

update last visible message on attachment upload failure

fc13fd9

rojiphil requested a review from a team as a code owner July 6, 2023 12:23

melvin-bot bot requested review from rushatgabhane and removed request for a team July 6, 2023 12:23

rojiphil mentioned this pull request Jul 6, 2023

[HOLD for payment 2023-07-20] [$1000] [Attachment] shows in LHN even after close error message #19913

Closed

6 tasks

rushatgabhane approved these changes Jul 10, 2023

View reviewed changes

melvin-bot bot requested a review from techievivek July 10, 2023 06:14

techievivek reviewed Jul 10, 2023

View reviewed changes

removal of reduntant code

17a3436

techievivek approved these changes Jul 10, 2023

View reviewed changes

techievivek merged commit 2e3f8c2 into Expensify:main Jul 10, 2023
10 checks passed

melvin-bot bot added the Emergency label Jul 10, 2023

techievivek removed the Emergency label Jul 10, 2023

OSBotify mentioned this pull request Jul 10, 2023

Deploy Checklist: New Expensify 2023-07-10 #22598

Closed

76 tasks

bernhardoj mentioned this pull request Aug 4, 2023

[HOLD for payment 2023-08-17] [$1000] Red dot and [Attachment] shows in LHN even after close error message #24136

Closed

6 tasks

c3024 mentioned this pull request Aug 28, 2023

[PAID] [$500] Chat - [Attachment] shows in LHN even after close error message #26047

Closed

6 tasks

s77rt reviewed Sep 6, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reset last visible message on failure of attachment upload #22342

Reset last visible message on failure of attachment upload #22342

rojiphil commented Jul 6, 2023

melvin-bot bot commented Jul 6, 2023

rojiphil commented Jul 9, 2023

rushatgabhane commented Jul 10, 2023 •

edited

Loading

rushatgabhane commented Jul 10, 2023

rushatgabhane left a comment

techievivek left a comment

techievivek Jul 10, 2023

rojiphil Jul 10, 2023

techievivek left a comment

melvin-bot bot commented Jul 10, 2023

techievivek commented Jul 10, 2023

OSBotify commented Jul 10, 2023

OSBotify commented Jul 11, 2023

OSBotify commented Jul 13, 2023

s77rt Sep 6, 2023

Reset last visible message on failure of attachment upload #22342

Reset last visible message on failure of attachment upload #22342

Conversation

rojiphil commented Jul 6, 2023

Details

Fixed Issues

Test

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 6, 2023

rojiphil commented Jul 9, 2023

rushatgabhane commented Jul 10, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

rushatgabhane commented Jul 10, 2023

rushatgabhane left a comment

Choose a reason for hiding this comment

techievivek left a comment

Choose a reason for hiding this comment

techievivek Jul 10, 2023

Choose a reason for hiding this comment

rojiphil Jul 10, 2023

Choose a reason for hiding this comment

techievivek left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jul 10, 2023

techievivek commented Jul 10, 2023

OSBotify commented Jul 10, 2023

OSBotify commented Jul 11, 2023

OSBotify commented Jul 13, 2023

s77rt Sep 6, 2023

Choose a reason for hiding this comment

rushatgabhane commented Jul 10, 2023 •

edited

Loading