Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: On delete Message hide un-actionable items #20460

Merged
merged 6 commits into from
Jun 15, 2023

Conversation

dhairyasenjaliya
Copy link
Contributor

@dhairyasenjaliya dhairyasenjaliya commented Jun 8, 2023

Details

Fixed Issues

$ #20074
PROPOSAL: #20074 (comment)

Tests

  1. Open the app
  2. Open any report
  3. Send any message eg: Hello test
  4. Click on reply to thread on message
  5. Delete the message (go to another chat and come back on the same message)
  6. hover On [deleted message]
  7. Notice it should not show copy clipboard, copy link, or delete icon
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

  1. Open the app
  2. Open any report
  3. Send any message eg: Hello test
  4. Click on reply to thread on message
  5. Delete the message (go to another chat and come back on the same message)
  6. hover On [deleted message]
  7. Notice it should not show copy clipboard, copy link, or delete icon
  • 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
    • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web web-chrome
Mobile Web - Chrome mobile-chrome
Mobile Web - Safari
Desktop desktop
iOS
Android

@dhairyasenjaliya dhairyasenjaliya marked this pull request as ready for review June 8, 2023 15:51
@dhairyasenjaliya dhairyasenjaliya requested a review from a team as a code owner June 8, 2023 15:51
@melvin-bot melvin-bot bot requested review from aimane-chnaif and techievivek and removed request for a team June 8, 2023 15:51
@melvin-bot
Copy link

melvin-bot bot commented Jun 8, 2023

@techievivek @aimane-chnaif 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]

@dhairyasenjaliya
Copy link
Contributor Author

@aimane-chnaif do we need to add conditions for copyURLToClipboard , copyEmailToClipboard ?

@aimane-chnaif
Copy link
Contributor

@aimane-chnaif do we need to add conditions for copyURLToClipboard , copyEmailToClipboard ?

I believe keep as is now. No reason for disabling those in deleted message.

@dhairyasenjaliya
Copy link
Contributor Author

Sure not added in this PR @aimane-chnaif

@dhairyasenjaliya
Copy link
Contributor Author

@aimane-chnaif any other suggestion on other options to hide here?

@aimane-chnaif
Copy link
Contributor

Open any other platform (eg: notepad) and write anything in it, copy that text

What is this step for?

@dhairyasenjaliya
Copy link
Contributor Author

@aimane-chnaif I just removed that since that Is not required

@aimane-chnaif
Copy link
Contributor

aimane-chnaif commented Jun 12, 2023

Also reaction icon and 4 quick reactions in Step 7.
[Deleted message] will not appear instantly after Step 5. It's known bug and already separate issue. But let's still explain (i.e. go to another chat and come back) so that QA team isn't blocked.

@dhairyasenjaliya
Copy link
Contributor Author

@aimane-chnaif I have added little note on step-5 so QA team can test

@aimane-chnaif
Copy link
Contributor

5 repeated conditions seem not perfect. Let's introduce global function similar to getActionText(reportAction) in that file

@dhairyasenjaliya
Copy link
Contributor Author

yeah agree I'm about to create a new function but I was thinking to create inside ReportActionsUtils and was just waiting for the review :)

@aimane-chnaif
Copy link
Contributor

yeah agree I'm about to create a new function but I was thinking to create inside ReportActionsUtils and was just waiting for the review :)

ok let's do that

@dhairyasenjaliya
Copy link
Contributor Author

@aimane-chnaif added a new helper function to fetch delete status

@aimane-chnaif
Copy link
Contributor

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
web.mov
web2.mov
Mobile Web - Chrome
mchrome.mov
Mobile Web - Safari
msafari.mov
Desktop
desktop.mov
iOS
ios.mov
Android
android.mov

Copy link
Contributor

@aimane-chnaif aimane-chnaif left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@techievivek LGTM 🎉

* @param {Object} reportActions
* @returns {Boolean}
*/
function isMessageDeleted(reportActions) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't we use this function which already exists -

function isDeletedAction(reportAction) {
// A deleted comment has either an empty array or an object with html field with empty string as value
const message = lodashGet(reportAction, 'message', []);
return message.length === 0 || lodashGet(message, [0, 'html']) === '';
}

Also, your parameter should be named reportAction and not reportActions in case we do end up adding this function.

Apologies, if contributors can't comment on other PRs but I was working on a similar issue and came here to see what was being changed here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed inconsistent logic to check if action is deleted.

We reused already existing logic in ContextMenuActions download icon. This is also being used here:

const isDeletedParentAction = lodashGet(reportAction, ['message', 0, 'isDeletedParentAction'], false);

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think isDeletedParentAction logic check makes more sense than html emptiness

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope, we can't use this function we have specific situations when we delete messages on thread we are displaying [deleted message] on that particular comment has this status stored inside originalMessage.isDeletedParentAction which we don't have any function so created new please compare it yourself

For rename parameters i have just followed the above function we can check as well for consistency its fine

Copy link
Contributor

@aimane-chnaif aimane-chnaif Jun 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use reportAction name. This should be correct one

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, adding a new function makes sense but since the parameter is a single action, I thought it should be named reportAction and in most places it is singular only but that is just my suggestion so it is up to you and the reviewers to decide.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah let me Change that spell

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

@aimane-chnaif aimane-chnaif left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@techievivek all yours!

@dhairyasenjaliya
Copy link
Contributor Author

bump for review @techievivek

Copy link
Contributor

@techievivek techievivek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the delay as I was ooo. Changes looks good to me.

@techievivek techievivek merged commit 4280edd into Expensify:main Jun 15, 2023
@techievivek
Copy link
Contributor

Also, in future, if the assigned engineer is delaying the review feel free to bring a discussion to the C+ channel so someone else can look into it.

@OSBotify
Copy link
Contributor

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

@aimane-chnaif
Copy link
Contributor

Also, in future, if the assigned engineer is delaying the review feel free to bring a discussion to the C+ channel so someone else can look into it.

Sure thanks. I just left PR for your review since it's not extreme urgent PR and hoping you'll be back no later than a week 😄

@dhairyasenjaliya
Copy link
Contributor Author

Also, in future, if the assigned engineer is delaying the review feel free to bring a discussion to the C+ channel so someone else can look into it.

noted :)

@OSBotify
Copy link
Contributor

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

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.29-11 🚀

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

@fedirjh
Copy link
Contributor

fedirjh commented Jul 25, 2023

Hey there, it would be better if bug #21103 were fixed in this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants