Modify optimistic data to support new text+attachment messages #39007

tgolen · 2024-03-26T18:00:27Z

Details

Now that text and attachments are combined into a single report action, the optimistic data needed to change slightly to account for it.

Fixed Issues

$ #35977

Tests

Open a chat with someone
Send a text-only comment
Verify only a single report action is created
Send an attachment only comment
Verify only a single report action is created
Send a comment with text and attachment (eg. copy/paste an image into the composer after you have typed a message)
Verify only a single report action is created

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Same as above, but also perform this test:

Go into a public room
Send the text "Unsubscribe" and also add an attachment to the message
Verify that you are unsubscribed from the room and that the attachment is not posted

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: mWeb Chrome - Note: I was unable to test this due to a broken emulator
- iOS: Native
- iOS: mWeb 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 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 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 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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-04-04T16:46:01Z

@rayane-djouah 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]

rayane-djouah · 2024-04-07T00:02:15Z

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. https://expensify.slack.com/archives/C049HHMV9SM/p1712805356614479
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

Recording.2024-04-11.040747.mp4

Android: mWeb Chrome

Recording.2024-04-11.010729.mp4

iOS: Native

Recording.2024-04-11.005714.mp4

iOS: mWeb Safari

Recording.2024-04-11.010117.mp4

MacOS: Chrome / Safari

Recording.2024-04-11.005037.mp4

MacOS: Desktop

Recording.2024-04-11.004727.mp4

rayane-djouah · 2024-04-08T00:52:48Z

Bug 1:

Steps:

open a report
Write a draft message (text: "This is an image").
Add an attachment and send

Expected result:

LHN shows the report subtitle as "This is an image [Attachment]"

Actual Result:

LHN shows the report subtitle as "[Attachment]"

Screenshots/Videos

Recording.2024-04-08.012818.mp4

rayane-djouah · 2024-04-08T00:53:00Z

Bug 2:

Not reproducible on main.
I'm able to reproducible it only on Firefox. Not sure about the steps.

Edit: reproduced on chrome with a new account.

Steps:

open a report
Write a draft message
Add an attachment and send; refresh immediately after clicking send

Result:

AddTextAndAttachment fails with a 404 error and retries endlessly.
After some time, a red dot error appears with an unexpected error message.

Screenshots/Videos

Recording.2024-04-08.011255.mp4

Recording.2024-04-08.020823.mp4

rayane-djouah · 2024-04-08T00:53:13Z

Bug 3:

It is also reproducible on main NAB for this PR.

Steps:

open a report
Write a draft message (optional step).
Add an attachment and send; refresh immediately after clicking send

Result:

"Auth CreateReportAction returned an error.

Screenshots/Videos

Recording.2024-04-08.010220.mp4

rayane-djouah · 2024-04-08T00:53:24Z

Bug 4:

It is also reproducible on main NAB for this PR.

Steps:

open a report
Write a draft message.
Add an attachment and send

Result:

Console error:
Warning: flushSync was called from inside a lifecycle method. React cannot flush when React is already rendering. Consider moving this call to a scheduler task or micro task.

Screenshots/Videos

Recording.2024-04-08.005357.mp4

rayane-djouah · 2024-04-08T00:53:34Z

Bug 5:

Steps:

open a report
Write a draft message.
Add this an empty (0 kb file) video attachment and send:

Expected result:

The file link shows in a new line

Actual Result:

The file link is concatenated with the message.

Screenshots/Videos

Recording.2024-04-08.014159.mp4

rayane-djouah · 2024-04-08T00:53:45Z

Bug 6:

Steps:

open a report
Write a draft message ("Hello").
Add an attachment and send
Right-click on the sent text+image message and click copy to clipboard.
Paste the clipboard content

Expected result:

We have three options:

Text should be Hello [Attachment]
or:
Hello![Filename](url)
or (actual result):
Hello![url](url)

I think that we can also add a space/new line between the message and the image markdown.

Actual Result:

Copied text is:
Hello![https://staging.expensify.com/chat-attachments/8511954859736692126/w_ece86a3bdecdde82bc45421e4d087841a754dd92.png.1024.jpg](https://staging.expensify.com/chat-attachments/8511954859736692126/w_ece86a3bdecdde82bc45421e4d087841a754dd92.png.1024.jpg)

Screenshots/Videos

Recording.2024-04-08.014605.mp4

rayane-djouah · 2024-04-08T01:08:47Z

Bug 7:

Steps:

open a report
Write a draft message.
Add an attachment and send
Right-click on the sent message and click edit

Expected result:

User is able to edit the message.

Actual Result:

App crashes with a console error:
Uncaught Error: Invalid HTML: unclosed tags

Screenshots/Videos

Recording.2024-04-08.021659.mp4

rayane-djouah · 2024-04-08T01:24:43Z

Please sync with main, as the branch is +2k commits behind.

rayane-djouah · 2024-04-08T01:30:10Z

Bug 8:

Steps:

open a report
Write a draft message.
Add an attachment and send
Right-click on the sent message or view the mini context menu

Expected result:

Users can click on a download option to download the attachment.

Actual Result:

There is no download option in text+image messages.

Screenshots/Videos

Recording.2024-04-08.022607.mp4

rayane-djouah · 2024-04-08T01:37:17Z

Bug 9:

Steps:

open a report
Write a draft message with markdown.
Add an attachment and send

Expected result:

Markdown is applied to the sent message.

Actual Result:

Markdown is not applied to the sent message.

Screenshots/Videos

Recording.2024-04-08.023453.mp4

rayane-djouah · 2024-04-08T01:37:59Z

"Android: mWeb Chrome" Screenshot/Video is missing in author checklist

rayane-djouah

Please check the above reported bugs. Thank you!

tgolen · 2024-04-10T15:07:19Z

Current progress:

Bug 1: ✅ Can only be fixed on the server, I'll open an issue to get it fixed (GH)
Bug 2: ✅ Reproducible on main (anytime you refresh while the image is uploading this will happen, it's OK)
Bug 3: ✅ Reproducible on main
Bug 4: ✅ Reproducible on main
Bug 5: ✅ Empty file is too much of an edge case

tgolen · 2024-04-10T16:36:17Z

Bug 6: ✅ This is being handled in some of the other front-end tasks for the markdown side of this feature
Bug 7: ✅ Unable to reproduce
Bug 8: ✅ This is not really a bug and will also be handled with some of the other front-end tasks concerning the image carousel
Bug 9: ✅ Unable to reproduce

I updated the branch with main before testing any of these, so some of them might have been resolved in main. Regarding the missing screenshot, I noted above in the platform test checkmarks:

mWeb Chrome - Note: I was unable to test this due to a broken emulator

If you're able to test it there, then I think this is OK. We should be all set here!

rayane-djouah

LGTM

melvin-bot · 2024-04-11T03:24:38Z

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

johnmlee101

Looks great!

rayane-djouah · 2024-04-11T20:56:03Z

@tgolen, Can you please assign me in the linked issue? Thank you!

OSBotify · 2024-04-18T04:55:17Z

🚀 Deployed to staging by https://github.com/johnmlee101 in version: 1.4.63-0 🚀

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

OSBotify · 2024-04-22T14:56:16Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

rojiphil · 2024-05-08T04:33:24Z

src/libs/ReportUtils.ts

+        textForNewComment = parser.htmlToText(htmlForNewComment);
+    } else {
+        htmlForNewComment = `${commentText}\n${CONST.ATTACHMENT_UPLOADING_MESSAGE_HTML}`;
+        textForNewComment = `${commentText}\n${CONST.ATTACHMENT_UPLOADING_MESSAGE_HTML}`;


Here, we missed decoding the html encoded text using parser.htmlToText because of which html encoded text was displayed temporarily. This caused issue #40578

Modify optimistic data to support new text+attachment messages

c06a5cb

tgolen mentioned this pull request Mar 26, 2024

[Pay 29/4] [$250] HIGH: [Polish] Combine image attachment with the unsent composed message #35977

Closed

Use separate API for text and attachment

8aadc83

tgolen changed the title ~~Modify optimistic data to support new text+attachment messages~~ [HOLD Web-Expensify/pull/41449] Modify optimistic data to support new text+attachment messages Mar 28, 2024

Fix TS error and improve comments

0ff4dd7

tgolen self-assigned this Mar 29, 2024

tgolen changed the title ~~[HOLD Web-Expensify/pull/41449] Modify optimistic data to support new text+attachment messages~~ [HOLD Web-Expensify/pull/41449] Apr 4, 2024

tgolen marked this pull request as ready for review April 4, 2024 16:45

tgolen requested a review from a team as a code owner April 4, 2024 16:45

melvin-bot bot removed the request for review from a team April 4, 2024 16:46

melvin-bot bot requested a review from rayane-djouah April 4, 2024 16:46

tgolen changed the title ~~[HOLD Web-Expensify/pull/41449]~~ Modify optimistic data to support new text+attachment messages Apr 4, 2024

rayane-djouah suggested changes Apr 8, 2024

View reviewed changes

Merge branch 'main' into tgolen-improve-attachmentmessage

70d3a94

rayane-djouah approved these changes Apr 11, 2024

View reviewed changes

melvin-bot bot requested a review from johnmlee101 April 11, 2024 03:24

johnmlee101 approved these changes Apr 11, 2024

View reviewed changes

johnmlee101 merged commit 2e1dd1d into main Apr 11, 2024
16 checks passed

johnmlee101 deleted the tgolen-improve-attachmentmessage branch April 11, 2024 18:24

shubham1206agra mentioned this pull request Apr 12, 2024

De-dupe network requests #40059

Closed

49 tasks

github-actions bot mentioned this pull request Apr 18, 2024

Deploy Checklist: New Expensify 2024-04-18 #40392

Closed

ShridharGoel mentioned this pull request Apr 18, 2024

[HOLD for payment 2024-06-05] [$250] Chat - Text with attachment message can be edited when the attachment is uploading #40400

Closed

6 tasks

rojiphil reviewed May 8, 2024

View reviewed changes

rojiphil mentioned this pull request May 8, 2024

[HOLD for payment 2024-05-06] [$125] Sending image with message has ' appears as HTML for temporarily until the image appears fully #40578

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Modify optimistic data to support new text+attachment messages #39007

Modify optimistic data to support new text+attachment messages #39007

tgolen commented Mar 26, 2024 •

edited

Loading

melvin-bot bot commented Apr 4, 2024

rayane-djouah commented Apr 7, 2024 •

edited

Loading

rayane-djouah commented Apr 8, 2024 •

edited

Loading

rayane-djouah commented Apr 8, 2024 •

edited

Loading

rayane-djouah commented Apr 8, 2024 •

edited

Loading

rayane-djouah commented Apr 8, 2024 •

edited

Loading

rayane-djouah commented Apr 8, 2024 •

edited

Loading

rayane-djouah commented Apr 8, 2024 •

edited

Loading

rayane-djouah commented Apr 8, 2024 •

edited

Loading

rayane-djouah commented Apr 8, 2024 •

edited

Loading

rayane-djouah commented Apr 8, 2024

rayane-djouah commented Apr 8, 2024

rayane-djouah commented Apr 8, 2024

rayane-djouah left a comment

tgolen commented Apr 10, 2024

tgolen commented Apr 10, 2024

rayane-djouah left a comment

melvin-bot bot commented Apr 11, 2024

johnmlee101 left a comment

rayane-djouah commented Apr 11, 2024

OSBotify commented Apr 18, 2024

OSBotify commented Apr 22, 2024

rojiphil May 8, 2024

Modify optimistic data to support new text+attachment messages #39007

Modify optimistic data to support new text+attachment messages #39007

Conversation

tgolen commented Mar 26, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 4, 2024

rayane-djouah commented Apr 7, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

rayane-djouah commented Apr 8, 2024 • edited Loading

Bug 1:

Steps:

Expected result:

Actual Result:

Screenshots/Videos

rayane-djouah commented Apr 8, 2024 • edited Loading

Bug 2:

Steps:

Result:

Screenshots/Videos

rayane-djouah commented Apr 8, 2024 • edited Loading

Bug 3:

Steps:

Result:

Screenshots/Videos

rayane-djouah commented Apr 8, 2024 • edited Loading

Bug 4:

Steps:

Result:

Screenshots/Videos

rayane-djouah commented Apr 8, 2024 • edited Loading

Bug 5:

Steps:

Expected result:

Actual Result:

Screenshots/Videos

rayane-djouah commented Apr 8, 2024 • edited Loading

Bug 6:

Steps:

Expected result:

Actual Result:

Screenshots/Videos

rayane-djouah commented Apr 8, 2024 • edited Loading

Bug 7:

Steps:

Expected result:

Actual Result:

Screenshots/Videos

rayane-djouah commented Apr 8, 2024 • edited Loading

rayane-djouah commented Apr 8, 2024

Bug 8:

Steps:

Expected result:

Actual Result:

Screenshots/Videos

rayane-djouah commented Apr 8, 2024

Bug 9:

Steps:

Expected result:

Actual Result:

Screenshots/Videos

rayane-djouah commented Apr 8, 2024

rayane-djouah left a comment

Choose a reason for hiding this comment

tgolen commented Apr 10, 2024

tgolen commented Apr 10, 2024

rayane-djouah left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Apr 11, 2024

johnmlee101 left a comment

Choose a reason for hiding this comment

rayane-djouah commented Apr 11, 2024

OSBotify commented Apr 18, 2024

OSBotify commented Apr 22, 2024

tgolen commented Mar 26, 2024 •

edited

Loading

rayane-djouah commented Apr 7, 2024 •

edited

Loading

rayane-djouah commented Apr 8, 2024 •

edited

Loading

rayane-djouah commented Apr 8, 2024 •

edited

Loading

rayane-djouah commented Apr 8, 2024 •

edited

Loading

rayane-djouah commented Apr 8, 2024 •

edited

Loading

rayane-djouah commented Apr 8, 2024 •

edited

Loading

rayane-djouah commented Apr 8, 2024 •

edited

Loading

rayane-djouah commented Apr 8, 2024 •

edited

Loading

rayane-djouah commented Apr 8, 2024 •

edited

Loading