Use correct lastMessageText for attachments #15182

marcaaron · 2023-02-15T19:41:44Z

Details

When we get the lastMessageText we are not checking if the last message is an attachment. This leads to the text message becoming an empty string and defaulting to an email in the sidebar.

Fixed Issues

$ #15140

Tests

Add attachment to chat
Add another attachment to the chat
Delete the last attachment
Verify the chat preview line says [Attachment]

Verify that no errors appear in the JS console

Offline tests

Add attachment
Add another attachment
Go offline
Delete the last attachment
Verify the attachment is greyed out
Verify the chat preview line says [Attachment]

QA Steps

Same as Web & Tests

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 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 correct English and 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
- 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 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.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

FULL DISCLOSURE: I had issues testing on mWeb Chrome and skipped it since I did not want to spend too much time resolving.

Mobile Web - Safari

Desktop

iOS

Android

MelvinBot · 2023-02-15T21:22:59Z

@mananjadhav @dangrous One of you needs to 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]

dangrous · 2023-02-15T21:31:10Z

src/libs/isReportMessageAttachment.js

+ * @returns {Boolean}
+ */
+export default function isReportMessageAttachment({text, html}) {
+    return text === CONST.ATTACHMENT_MESSAGE_TEXT && html !== CONST.ATTACHMENT_MESSAGE_TEXT;


What does the second half of this do? Is it checking if someone typed the phrase [Attachment]? I guess NAB since it was in the old function too, but out of interest...

Tbh, I don't really know. Can't think of a case where the html would be equal to [Attachment]. Could have been someone found this bug randomly by throwing stuff at a wall, reported it, then we fixed it. Or maybe it's important 😅

Ha. If it ain't broke...

dangrous

Code looks good!

For testing, @marcaaron can you confirm there should be a 3.5 in the Offline tests that is Delete the last attachment before verifying that it's greyed out? That seemed right but I didn't want to just add without checking.

dangrous · 2023-02-16T17:06:58Z

Oh also looks like some jest tests are failing, though as far as I can tell they're unrelated (about avatars). Maybe merge main?

marcaaron · 2023-02-16T21:14:12Z

@dangrous yes thanks for catching that!

…wAttachment

dangrous · 2023-02-16T21:37:11Z

Sweet. Good on my end - @mananjadhav all yours!

mananjadhav · 2023-02-17T04:08:54Z

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 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 correct English and 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web-last-attachment.mov

Mobile Web - Chrome

mweb-chrome-last-attachment.mov

Mobile Web - Safari

mweb-safari-last-attachment.mov

Desktop

desktop-last-attachment.mov

iOS

ios-last-attachment.mov

Android

android-last-attachment.mov

Thanks for the patience here @dangrous @marcaaron. Tested this and it works well.

OSBotify · 2023-02-17T16:15:56Z

✋ 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-02-17T21:23:48Z

🚀 Deployed to staging by https://github.com/dangrous in version: 1.2.74-0 🚀

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

OSBotify · 2023-02-21T20:34:31Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.2.74-0 🚀

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

s77rt · 2023-04-21T00:08:37Z

This PR caused a regression here #17164. In getting the message here we should have set the fallback value to an empty object instead of keeping it as undefined. As the undefined variable will later cause a crash on isReportMessageAttachment.

marcaaron · 2023-04-21T00:18:25Z

Interesting, thanks for pointing it out @s77rt. Curious though, why does it have no value and need a fallback in the first place? I would expect all supported actions should have a field of message that is a non empty array, so can't imagine why the default is necessary.

s77rt · 2023-04-21T00:21:38Z

@marcaaron There is no value because there is no report action. The array of visibleActions is empty.

If the report action is undefined then the message would also be undefined.

marcaaron · 2023-04-24T16:27:25Z

The array of visibleActions is empty

Ah, but is this part expected to be possibly empty or not? Is the problem that the function doesn't fail silently when an empty array is passed or that we call it with one in the first place?

Use correct lastMessageText for attachments

13f07f7

marcaaron self-assigned this Feb 15, 2023

fix dependency cycle

694b074

marcaaron marked this pull request as ready for review February 15, 2023 21:22

marcaaron requested a review from a team as a code owner February 15, 2023 21:22

melvin-bot bot requested review from dangrous and mananjadhav and removed request for a team February 15, 2023 21:22

dangrous reviewed Feb 15, 2023

View reviewed changes

dangrous approved these changes Feb 16, 2023

View reviewed changes

Merge remote-tracking branch 'origin' into marcaaron-fixSidebarPrevie…

4e7746a

…wAttachment

mananjadhav approved these changes Feb 17, 2023

View reviewed changes

dangrous merged commit 7e3caf9 into main Feb 17, 2023

dangrous deleted the marcaaron-fixSidebarPreviewAttachment branch February 17, 2023 16:11

OSBotify mentioned this pull request Feb 17, 2023

Deploy Checklist: New Expensify 2023-02-17 #15260

Closed

17 tasks

MelvinBot mentioned this pull request Feb 21, 2023

[HOLD for payment 2023-02-28] LHN : Deleting a file showing email address below the user name for a moment #15140

Closed

1 task

s77rt mentioned this pull request Apr 21, 2023

[HOLD for payment 2023-04-27] [$1000] App crashes on editing and deleting the emoji messages on #admins on Android in an Offline mode #17164

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use correct lastMessageText for attachments #15182

Use correct lastMessageText for attachments #15182

marcaaron commented Feb 15, 2023 •

edited

Loading

MelvinBot commented Feb 15, 2023

dangrous Feb 15, 2023

marcaaron Feb 16, 2023

dangrous Feb 16, 2023

dangrous left a comment

dangrous commented Feb 16, 2023

marcaaron commented Feb 16, 2023

dangrous commented Feb 16, 2023

mananjadhav commented Feb 17, 2023

OSBotify commented Feb 17, 2023

OSBotify commented Feb 17, 2023

OSBotify commented Feb 21, 2023

s77rt commented Apr 21, 2023

marcaaron commented Apr 21, 2023

s77rt commented Apr 21, 2023 •

edited

Loading

marcaaron commented Apr 24, 2023

Use correct lastMessageText for attachments #15182

Use correct lastMessageText for attachments #15182

Conversation

marcaaron commented Feb 15, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Feb 15, 2023

dangrous Feb 15, 2023

Choose a reason for hiding this comment

marcaaron Feb 16, 2023

Choose a reason for hiding this comment

dangrous Feb 16, 2023

Choose a reason for hiding this comment

dangrous left a comment

Choose a reason for hiding this comment

dangrous commented Feb 16, 2023

marcaaron commented Feb 16, 2023

dangrous commented Feb 16, 2023

mananjadhav commented Feb 17, 2023

Reviewer Checklist

Screenshots/Videos

OSBotify commented Feb 17, 2023

OSBotify commented Feb 17, 2023

OSBotify commented Feb 21, 2023

s77rt commented Apr 21, 2023

marcaaron commented Apr 21, 2023

s77rt commented Apr 21, 2023 • edited Loading

marcaaron commented Apr 24, 2023

marcaaron commented Feb 15, 2023 •

edited

Loading

s77rt commented Apr 21, 2023 •

edited

Loading