De-duplicate checking if a report action is an attachment #25560

cubuspl42 · 2023-08-21T09:17:06Z

Details

De-duplicate the code checking if a report action is an attachment

Fixed Issues

$
PROPOSAL:

Tests

Go to a report with attachment comments
Verify that attachments can be downloaded via context menu
Verify that attachments cannot be copied via context menu
Verify that text messages can be copied via context menu
Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

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

deduplicate-isAttachment-web.mp4

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-08-21T09:17:42Z

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

cubuspl42 · 2023-08-21T09:19:08Z

src/libs/isReportActionAttachment.js

+ * @returns {Boolean}
+ */
+export default function isReportActionAttachment(reportAction) {
+    const message = _.first(lodashGet(reportAction, 'message', [{}]));


I switched to first to be consistent with the ['message', 0, 'html'] path I used elsewhere, but attachment messages (and comment messages in general) can't have multiple fragments if I understand this correctly.

What I meant is that...
...in some places, like this, we were looking at the last fragment of the attachment message (this is what I de-duplicate)
...but in other places, like this (actually the next line), we were looking at the first fragment of the attachment message

In both cases, the actual assumption seems to be that an attachment message has only one fragment. Still, I decided to make that consistent and always look at the first fragment.

By "fragment", I mean an element of the message array.

@venture1981 Let me know if my explanation clarified this

@venture1981 Friendly bump

@venture1981 As the merge freeze is over, it would be great if we could resolve this conversation. If for some reason you're not available to reply, I'll resolve this thread anyway and try to get this PR merged. Thanks!

src/libs/ReportUtils.js

src/libs/isReportActionAttachment.js

...and improve the comment.

flodnv

Can you do at least 1 test?

flodnv · 2023-08-22T08:45:49Z

Additionally, there are conflicts

cubuspl42 · 2023-08-22T09:29:11Z

@flodnv

Can you do at least 1 test?

I did manual tests, but I didn't include their description in the Tests section. Fixed.

Additionally, there are conflicts

The conflict was minor. Resolved.

…hment-1

cubuspl42 · 2023-09-13T08:51:35Z

@flodnv I bumped the single open thread again. It would be great if we could merge this soon, as the merge freeze is over.

flodnv · 2023-09-14T04:58:56Z

Could you please attach at least 1 screenshot or video for the tests?

cubuspl42 · 2023-09-14T06:53:33Z

@flodnv Sure! Done. I added a video for the Web/Desktop.

flodnv · 2023-09-15T01:58:08Z

Thanks! Does this fix #25415 ?

flodnv · 2023-09-15T02:10:50Z

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

OSBotify · 2023-09-15T02:18:29Z

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

cubuspl42 · 2023-09-15T10:16:53Z

Thanks! Does this fix #25415 ?

No, this was meant to be an independent thing that makes it easier to fix #25415. In my head, this was a little thing that's great do before, that's kind of how I approached such challenges in the previous projects I worked on.

flodnv · 2023-09-18T02:18:27Z

Ah ok, in the future please link this context in the PR description so we can better understand

OSBotify · 2023-09-18T10:40:51Z

🚀 Deployed to staging by https://github.com/flodnv in version: 1.3.71-0 🚀

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

OSBotify · 2023-09-20T08:13:21Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.71-12 🚀

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

cubuspl42 requested a review from a team as a code owner August 21, 2023 09:17

melvin-bot bot requested review from flodnv and removed request for a team August 21, 2023 09:17

cubuspl42 commented Aug 21, 2023

View reviewed changes

De-duplicate checking if a report action is an attachment

ed7d7ba

cubuspl42 force-pushed the deduplicate-isAttachment-1 branch from defcc6a to ed7d7ba Compare August 21, 2023 09:19

cubuspl42 commented Aug 21, 2023

View reviewed changes

src/libs/ReportUtils.js Show resolved Hide resolved

cubuspl42 mentioned this pull request Aug 21, 2023

[HOLD for payment 2023-11-27] [$1000] Web - Chat - The display name goes down when deleting an attachment in main thread #25415

Closed

6 tasks

flodnv requested changes Aug 21, 2023

View reviewed changes

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

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

Move isReportActionAttachment to ReportActionsUtils.js

c52b251

...and improve the comment.

cubuspl42 mentioned this pull request Aug 21, 2023

Refactor comment message rendering #25524

Merged

55 tasks

flodnv requested a review from blacksaru August 22, 2023 08:45

flodnv reviewed Aug 22, 2023

View reviewed changes

cubuspl42 added 4 commits August 22, 2023 11:30

De-duplicate attachment checking in more places

3d50aed

Remove dead code path in the "Copy to clipboard" context menu action

296b045

Merge remote-tracking branch 'upstream/main' into deduplicate-isAttac…

341e21b

…hment-1

Merge remote-tracking branch 'upstream/main' into deduplicate-isAttac…

b4f8724

…hment-1

Run Prettier

4e75989

flodnv approved these changes Sep 14, 2023

View reviewed changes

flodnv merged commit be091a9 into Expensify:main Sep 15, 2023
12 checks passed

OSBotify mentioned this pull request Sep 18, 2023

Deploy Checklist: New Expensify 2023-09-18 #27654

Closed

91 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

De-duplicate checking if a report action is an attachment #25560

De-duplicate checking if a report action is an attachment #25560

cubuspl42 commented Aug 21, 2023 •

edited

Loading

melvin-bot bot commented Aug 21, 2023

cubuspl42 Aug 21, 2023

cubuspl42 Aug 21, 2023

cubuspl42 Aug 21, 2023

cubuspl42 Aug 29, 2023

cubuspl42 Aug 30, 2023

cubuspl42 Sep 13, 2023

flodnv left a comment

flodnv commented Aug 22, 2023

cubuspl42 commented Aug 22, 2023

cubuspl42 commented Sep 13, 2023

flodnv commented Sep 14, 2023

cubuspl42 commented Sep 14, 2023

flodnv commented Sep 15, 2023

flodnv commented Sep 15, 2023 •

edited

Loading

OSBotify commented Sep 15, 2023

cubuspl42 commented Sep 15, 2023

flodnv commented Sep 18, 2023

OSBotify commented Sep 18, 2023

OSBotify commented Sep 20, 2023

De-duplicate checking if a report action is an attachment #25560

De-duplicate checking if a report action is an attachment #25560

Conversation

cubuspl42 commented Aug 21, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 21, 2023

cubuspl42 Aug 21, 2023

Choose a reason for hiding this comment

cubuspl42 Aug 21, 2023

Choose a reason for hiding this comment

cubuspl42 Aug 21, 2023

Choose a reason for hiding this comment

cubuspl42 Aug 29, 2023

Choose a reason for hiding this comment

cubuspl42 Aug 30, 2023

Choose a reason for hiding this comment

cubuspl42 Sep 13, 2023

Choose a reason for hiding this comment

flodnv left a comment

Choose a reason for hiding this comment

flodnv commented Aug 22, 2023

cubuspl42 commented Aug 22, 2023

cubuspl42 commented Sep 13, 2023

flodnv commented Sep 14, 2023

cubuspl42 commented Sep 14, 2023

flodnv commented Sep 15, 2023

flodnv commented Sep 15, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Sep 15, 2023

cubuspl42 commented Sep 15, 2023

flodnv commented Sep 18, 2023

OSBotify commented Sep 18, 2023

OSBotify commented Sep 20, 2023

cubuspl42 commented Aug 21, 2023 •

edited

Loading

flodnv commented Sep 15, 2023 •

edited

Loading