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: Regression - Emoji reaction not working - Issue 22235 (Original - 21826) #22270

Merged
merged 30 commits into from
Jul 20, 2023

Conversation

jeet-dhandha
Copy link
Contributor

@jeet-dhandha jeet-dhandha commented Jul 5, 2023

Details

Fixed Issues

$ #22235
PROPOSAL: #22235 (comment)
REGRESSION-ISSUE: #21826

Tests

  1. Open any Chat and then reply to a message in thread.
  2. Now react using emoji to the first message of thread.
  3. Verify that the reacted emoji is displayed.
  • Verify that no errors appear in the JS console

Offline tests

  1. Open any Chat and then reply to a message in thread.
  2. Now react using emoji to the first message of thread.
  3. Verify that the reacted emoji is displayed.

QA Steps

  1. Open any Chat and then reply to a message in thread.
  2. Now react using emoji to the first message of thread.
  3. Verify that the reacted emoji is displayed.
  • 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
Chrome-Desktop-min.mp4
Mobile Web - Chrome
mSafari-mChrome-min.mp4
Mobile Web - Safari
mSafari-mChrome-min.mp4
Desktop
Chrome-Desktop-min.mp4
iOS
iOS-Android-min.mp4
Android
iOS-Android-min.mp4

@jeet-dhandha jeet-dhandha requested a review from a team as a code owner July 5, 2023 14:24
@melvin-bot melvin-bot bot requested review from aimane-chnaif and removed request for a team July 5, 2023 14:24
@melvin-bot
Copy link

melvin-bot bot commented Jul 5, 2023

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

@@ -1635,13 +1635,14 @@ function removeEmojiReaction(reportID, originalReportAction, emoji) {
/**
* Calls either addEmojiReaction or removeEmojiReaction depending on if the current user has reacted to the report action.
* @param {String} reportID
* @param {String} reportActionID
* @param {Object} action
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* @param {Object} action
* @param {Object} reportAction

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's re-use name from original code so replace all action with reportAction

Copy link
Contributor Author

@jeet-dhandha jeet-dhandha Jul 5, 2023

Choose a reason for hiding this comment

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

But this will give conflicts with the const created inside.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

function toggleEmojiReaction(reportID, reportActionID, emoji, paramSkinTone = preferredSkinTone) {
const reportAction = ReportActionsUtils.getReportAction(reportID, reportActionID);
function toggleEmojiReaction(reportID, action, emoji, paramSkinTone = preferredSkinTone) {
const originalReportID = ReportUtils.getOriginalReportID(reportID, action);
Copy link
Contributor

Choose a reason for hiding this comment

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

As original reportID is already calculated here, let's remove redundant calculation in addEmojiReaction and removeEmojiReaction

@aimane-chnaif
Copy link
Contributor

So this PR should

@aimane-chnaif
Copy link
Contributor

And please complete checklist. It's failing.

@jeet-dhandha
Copy link
Contributor Author

@aimane-chnaif This happened as reviewers are unaware of originalReportID else this wouldn't have gone to regression so i would suggest if we go through all the functions where originalReportID is not used and fix them all in as a different Issue. And also would love to fix that myself. As i don't want other people's PR go into regression. As this results in lower payment.

@aimane-chnaif
Copy link
Contributor

@jeet-dhandha I am well aware of that as I reviewed PR which introduced getOriginalReportID. And sure everything is out of scope as long as it's not related to #21826, #22235.

@jeet-dhandha
Copy link
Contributor Author

Then @aimane-chnaif you are right, the reviewer should have told me to keep originalReportID in check.

@jeet-dhandha
Copy link
Contributor Author

@aimane-chnaif Checklist completed.

@aimane-chnaif
Copy link
Contributor

All reactions disappear after editing message and re-appears after refresh.
I think this is known issue happening on production.
@jeet-dhandha do you know GH?

Screen.Recording.2023-07-05.at.5.40.53.PM.mov

@aimane-chnaif
Copy link
Contributor

I confirmed it's known backend issue - #15794

@jeet-dhandha
Copy link
Contributor Author

@aimane-chnaif - Please review the PR again.

@aimane-chnaif
Copy link
Contributor

Tests well!

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

:shipit:

@melvin-bot
Copy link

melvin-bot bot commented Jul 20, 2023

We did not find an internal engineer to review this PR, trying to assign a random engineer to #22235 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

@melvin-bot melvin-bot bot requested a review from danieldoglas July 20, 2023 14:35
@neil-marcellini neil-marcellini requested review from neil-marcellini and removed request for danieldoglas July 20, 2023 17:21
@neil-marcellini
Copy link
Contributor

@danieldoglas I'm removing your assignment to take this off your plate, but please reassign if you like.

@jeet-dhandha
Copy link
Contributor Author

Done @aimane-chnaif

@aimane-chnaif
Copy link
Contributor

@neil-marcellini all yours!

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Code looks good but please add test and QA steps.

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Good to go

@neil-marcellini neil-marcellini merged commit 7fea760 into Expensify:main Jul 20, 2023
12 checks passed
@melvin-bot
Copy link

melvin-bot bot commented Jul 20, 2023

Congrats, that’s your 5th PR merged! 🎉 Do you know about the ContributorPlus role? It’s an opportunity to earn more in the Expensify Open Source community. Keep up the great work - thanks!

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.3.44-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.44-2 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.3.45-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.45-7 🚀

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

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.

4 participants