Issue 28059 fix emoji reactions in offline mode #28519

abdel-h66 · 2023-09-29T19:24:17Z

Details

Fixed Issues

$ #28059
PROPOSAL: #28059 (comment)

Tests

Verify that no errors appear in the JS console

Steps

Open any report
Go offline
Add an emoji reaction to any message

Verify that any added reaction will appear greyed out in offline mode to indicate the fact that they have a pending action.

Extra Steps
4. Go online

Verify that the greyed emojies will now go to their usual display and will be sent to the API

Offline tests

QA Steps

Verify that no errors appear in the JS console

Steps

Open any report
Go offline
Add an emoji reaction to any message

Verify that any added reaction will appear greyed out in offline mode to indicate the fact that they have a pending action.

Extra Steps
4. Go online

Verify that the greyed emojies will now go to their usual display and will be sent to the API

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

chrome-web.mp4

Mobile Web - Chrome

mweb-chrome.mp4

Mobile Web - Safari

mweb-safari.mp4

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

melvin-bot · 2023-09-29T21:29:58Z

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

jjcoffee · 2023-10-02T13:29:18Z

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

chrome-desktop-2023-10-02_15.59.25.mp4

Mobile Web - Chrome

android-chrome.mp4

Mobile Web - Safari

ios-safari-2023-10-02_16.42.38.mp4

Desktop

mac-desktop-2023-10-02_16.56.29.mp4

iOS

ios-native-2023-10-02_16.37.09.mp4

Android

android-native.mp4

jjcoffee · 2023-10-02T13:34:58Z

@abdel-h66 Just a readability thing - can you update the test steps so that instead of a separate "expected result" line there's just a final numbered step, Verify that.... Thanks!

jjcoffee · 2023-10-02T14:05:01Z

@abdel-h66 Only issue I'm noting whilst testing is that there's double-opacity for emoji reactions added to messages sent offline (the bottom message in the screenshot below), so the appearance is a bit inconsistent. Would you be able to fix?

abdel-h66 · 2023-10-02T14:17:49Z

Oh yes that's a nice catch @jjcoffee I will try to see what I can do for this one

abdel-h66 · 2023-10-02T15:16:08Z

So the general idea to fix the problem above @jjcoffee would be using shouldDisableOpacity prop found on OfflineWithFeedback based on the check if the reportAction has a pending action or not. this way we could avoid the double opacity reduce thing.

I also had to refactor a little bit the component ReportActionItemEmojiReactions by passing the entire reportAction instead of just an ID.

Let me know what do you think, and here are the results after the changes.

Monosnap (32) New Expensify 2023-10-02 16-59-27

jjcoffee · 2023-10-02T15:51:17Z

Sounds good, will retest tomorrow!

jjcoffee · 2023-10-02T15:51:50Z

src/components/Reactions/ReportActionItemEmojiReactions.js

                            </View>
                        </Tooltip>
                    );
                })}
                {!props.shouldBlockReactions && (
                    <AddReactionBubble
                        onSelectEmoji={props.toggleReaction}
-                        reportAction={{reportActionID: props.reportActionID}}
+                        reportAction={reportAction}


Just glancing over this, I think AddReactionBubble will need to be updated too?

Can you double check that you've updated all references to the reportActionID?

Yep I did check, the AddReactionBubble was already expecting a kind of partial object similar to reportAction

reportAction: PropTypes.shape({ reportActionID: PropTypes.string.isRequired, }),

The contract is already fullfilled by reportAction object that we are passing now.

github-actions · 2023-10-02T22:18:41Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

abdel-h66 · 2023-10-03T12:07:49Z

Gentle bump here @jjcoffee 😄

jjcoffee · 2023-10-03T12:59:45Z

@abdel-h66 Please could you update the tests according to my comment, thanks!

abdel-h66 · 2023-10-03T13:04:24Z

Of course, it should be updated now :)

jjcoffee · 2023-10-03T13:07:52Z

src/components/Reactions/ReportActionItemEmojiReactions.js

-                                />
+                                <OfflineWithFeedback
+                                    pendingAction={reaction.hasPendingAction}
+                                    shouldDisableOpacity={Boolean(reportAction.pendingAction)}


Suggested change

shouldDisableOpacity={Boolean(reportAction.pendingAction)}

shouldDisableOpacity=Boolean(lodashGet(reportAction, 'pendingAction'))

pendingAction isn't guaranteed to exist

jjcoffee · 2023-10-03T13:09:04Z

src/components/Reactions/ReportActionItemEmojiReactions.js

@@ -108,6 +113,7 @@ function ReportActionItemEmojiReactions(props) {
            reactionCount,
            hasUserReacted,
            onReactionListOpen,
+            hasPendingAction: reaction.pendingAction,


hasPendingAction is a confusing name, it makes me thing this is gonna be a bool

I agree we can use plain pendingAction

jjcoffee · 2023-10-03T13:22:29Z

@abdel-h66 You have lint errors to fix 😄

Adds lodashGet

abdel-h66 · 2023-10-03T13:24:51Z

I got so used to TS showing me errors 😅 I will get there soon haha

abdel-h66 · 2023-10-04T16:01:08Z

Is everything valid from your end @jjcoffee

jjcoffee

LGTM!

srikarparsi

lgtm as well!

OSBotify · 2023-10-04T19:40: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-10-05T00:38:18Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 1.3.78-0 🚀

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

OSBotify · 2023-10-06T07:53:15Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.78-4 🚀

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

OSBotify · 2023-10-06T08:25:27Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 1.3.79-0 🚀

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

OSBotify · 2023-10-09T22:34:01Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.79-5 🚀

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

OSBotify · 2023-10-09T22:42:54Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.79-5 🚀

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

OSBotify · 2023-10-09T23:18:48Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.79-5 🚀

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

abdel-h66 marked this pull request as ready for review September 29, 2023 21:29

abdel-h66 requested a review from a team as a code owner September 29, 2023 21:29

melvin-bot bot requested review from jjcoffee and removed request for a team September 29, 2023 21:29

jjcoffee reviewed Oct 2, 2023

View reviewed changes

abdel-h66 added 5 commits October 3, 2023 00:17

Adds pending actions to the AddEmojiReaction

5a7af6f

Uses OfflineWithFeedback to display emojis with pending add actions

be169e4

Fixes prettier issues

de97cdc

Disables opacity on emojis when the action has a pending action

ec32b85

Uses reportActionID instead of the whole reportAction

3ba9ba0

abdel-h66 force-pushed the issue-28059-fix-emoji-reactions-in-offline-mode branch from a6c4760 to 3ba9ba0 Compare October 2, 2023 22:19

jjcoffee reviewed Oct 3, 2023

View reviewed changes

Uses lodash get to guard against undefined

b0145f1

Adds lodashGet

abdel-h66 force-pushed the issue-28059-fix-emoji-reactions-in-offline-mode branch from 85f3efb to b0145f1 Compare October 3, 2023 13:23

jjcoffee approved these changes Oct 4, 2023

View reviewed changes

melvin-bot bot requested a review from srikarparsi October 4, 2023 16:30

srikarparsi approved these changes Oct 4, 2023

View reviewed changes

srikarparsi merged commit f709b8d into Expensify:main Oct 4, 2023
14 checks passed

OSBotify mentioned this pull request Oct 5, 2023

Deploy Checklist: New Expensify 2023-10-05 #28883

Closed

57 tasks

OSBotify mentioned this pull request Oct 6, 2023

Deploy Checklist: New Expensify 2023-10-06 #28983

Closed

melvin-bot bot mentioned this pull request Oct 6, 2023

[HOLD for payment 2023-10-13] [$500] mWeb-Emoticon- In offline, emoji badge not greyed out when applied to the message sent in online #28059

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue 28059 fix emoji reactions in offline mode #28519

Issue 28059 fix emoji reactions in offline mode #28519

abdel-h66 commented Sep 29, 2023 •

edited

Loading

melvin-bot bot commented Sep 29, 2023

jjcoffee commented Oct 2, 2023 •

edited

Loading

jjcoffee commented Oct 2, 2023

jjcoffee commented Oct 2, 2023

abdel-h66 commented Oct 2, 2023

abdel-h66 commented Oct 2, 2023

jjcoffee commented Oct 2, 2023

jjcoffee Oct 2, 2023

jjcoffee Oct 2, 2023

abdel-h66 Oct 2, 2023

github-actions bot commented Oct 2, 2023 •

edited

Loading

abdel-h66 commented Oct 3, 2023

jjcoffee commented Oct 3, 2023

abdel-h66 commented Oct 3, 2023

jjcoffee Oct 3, 2023

jjcoffee Oct 3, 2023

abdel-h66 Oct 3, 2023

jjcoffee commented Oct 3, 2023

abdel-h66 commented Oct 3, 2023

abdel-h66 commented Oct 4, 2023

jjcoffee left a comment

srikarparsi left a comment

OSBotify commented Oct 4, 2023

OSBotify commented Oct 5, 2023

OSBotify commented Oct 6, 2023

OSBotify commented Oct 6, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 9, 2023

	shouldDisableOpacity={Boolean(reportAction.pendingAction)}
	shouldDisableOpacity=Boolean(lodashGet(reportAction, 'pendingAction'))

Issue 28059 fix emoji reactions in offline mode #28519

Issue 28059 fix emoji reactions in offline mode #28519

Conversation

abdel-h66 commented Sep 29, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 29, 2023

jjcoffee commented Oct 2, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

jjcoffee commented Oct 2, 2023

jjcoffee commented Oct 2, 2023

abdel-h66 commented Oct 2, 2023

abdel-h66 commented Oct 2, 2023

jjcoffee commented Oct 2, 2023

jjcoffee Oct 2, 2023

Choose a reason for hiding this comment

jjcoffee Oct 2, 2023

Choose a reason for hiding this comment

abdel-h66 Oct 2, 2023

Choose a reason for hiding this comment

github-actions bot commented Oct 2, 2023 • edited Loading

abdel-h66 commented Oct 3, 2023

jjcoffee commented Oct 3, 2023

abdel-h66 commented Oct 3, 2023

jjcoffee Oct 3, 2023

Choose a reason for hiding this comment

jjcoffee Oct 3, 2023

Choose a reason for hiding this comment

abdel-h66 Oct 3, 2023

Choose a reason for hiding this comment

jjcoffee commented Oct 3, 2023

abdel-h66 commented Oct 3, 2023

abdel-h66 commented Oct 4, 2023

jjcoffee left a comment

Choose a reason for hiding this comment

srikarparsi left a comment

Choose a reason for hiding this comment

OSBotify commented Oct 4, 2023

OSBotify commented Oct 5, 2023

OSBotify commented Oct 6, 2023

OSBotify commented Oct 6, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 9, 2023

abdel-h66 commented Sep 29, 2023 •

edited

Loading

jjcoffee commented Oct 2, 2023 •

edited

Loading

github-actions bot commented Oct 2, 2023 •

edited

Loading