Support new emojiReaction data format #17996

tgolen · 2023-04-25T21:57:12Z

Held on https://github.com/Expensify/Auth/pull/7811

Details

In order to facilitate the use of Onyx.merge() when adding and removing emoji, the data formation of reactions was changed from an array to emojiReactions which is an object. This allows for much better incremental changes of the emoji data so that the entire array of emojis doesn't have to be passed to Onyx.set() which is known for causing race conditions (explained in detail here).

This leads to a lot of cascading changes for how emojis are parsed, displayed, and modified, which this PR is updating.

Lastly, there is a network param called useEmojiReactions which allows the PHP and Auth to maintain backwards compatibility to support both reactions and emojiReactions at the same time while the front-end code is being migrated.

Old Format:

"reactionName": {
          emoji: string,
          users: {
              accountID: string,
              skinTone: number,
          }[]
      }

New Format:

{+1: 
    {
        createdAt: "2023-07-06 19:24:43"
        emojiName: "+1"
        users: 
            273: {
                skinTones: {-1: '2023-07-06 19:24:43'}
            } 
            274: null
    }
}

Fixed Issues

$ #19531

Tests

Sign into NewDot with User A
Sign into NewDot with User B
Have each of them open a chat with each other
Have them both adding and removing reactions from messages
Verify that the emojis are added and removed as you would expect them to

Verify that no errors appear in the JS console

Offline tests

Go offline
Add a reaction to a message
Come back online and wait a few seconds (to ensure the network requests are all done)
Refresh the page
Verify the reaction is still there

QA Steps

Same as the tests

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

tgolen · 2023-04-26T15:06:37Z

TODOs:

Add new API requests for adding and removing emoji
Add timestamps to the data to keep it in order and then pass those timestamps to the server
Document new proptypes
Remove old methods for adding and removing emoji
Fix a console error that happens when adding the first quick emoji to a message
Test test test

…eactions

stitesExpensify · 2023-07-17T22:12:19Z

Updated!

MariaHCD

LGTM!

stitesExpensify · 2023-07-18T14:16:17Z

Aweseome! @rushatgabhane @neil-marcellini if you could check this out before there are more conflicts I would really appreciate it :)

neil-marcellini

Looks good to me assuming it tests well.

stitesExpensify · 2023-07-19T13:40:08Z

Bump @rushatgabhane you're the last reviewer 😄

rushatgabhane · 2023-07-20T03:53:28Z

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

Screen.Recording.2023-07-20.at.11.49.02.mov

Mobile Web - Chrome

WhatsApp.Video.2023-07-20.at.12.07.16.mp4

Mobile Web - Safari

Desktop

Screen.Recording.2023-07-20.at.11.49.02.mov

iOS

Screen.Recording.2023-07-20.at.11.34.03.mov

Android

Screen.Recording.2023-07-20.at.11.32.44.mov

rushatgabhane

Bug: can't react to the first message in a thread.
Steps:

Send a message
Click reply in thread
React to the message

Expected: Can react to the first (parent) message of a thread
Actual: can't react

Screen.Recording.2023-07-20.at.09.39.01.mov

aimane-chnaif · 2023-07-20T04:21:25Z

@rushatgabhane PR which fixes that bug is on hold for this PR - #22235 (comment)

rushatgabhane · 2023-07-20T05:36:40Z

@aimane-chnaif thanks for the info! Moving ahead with the PR

rushatgabhane

LGTM too

melvin-bot · 2023-07-20T06:43:53Z

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

OSBotify · 2023-07-20T09:07:43Z

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

ayazhussain79 · 2023-07-20T12:12:06Z

Is that regression of this PR?
"0:undefined:" displayed in reaction emoji tooltip and some time "0::"
Bug posted on salack https://expensify.slack.com/archives/C049HHMV9SM/p1689854537784799

screen-recording-2023-07-20-at-45905-pm_i7reUDxU.mp4

OSBotify · 2023-07-21T18:50:54Z

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

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

OSBotify · 2023-07-25T01:24:51Z

🚀 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 · 2023-07-25T01:45:27Z

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

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

OSBotify · 2023-07-26T15:54:58Z

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

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

tgolen added 5 commits April 25, 2023 14:56

Create a separate collection for reactions

46f1cca

Call the new toggle method

f5de44f

Display reactions in new format

a7945e9

Make sure toggling reactions works locally in onyx

1b9f15f

Fix a few references to user account IDs and clean up code

af0fed2

tgolen mentioned this pull request Apr 26, 2023

Reaction emoji disappears/reappears after quickly adding/removing reactions #16506

Open

12 tasks

tgolen self-assigned this Apr 26, 2023

tgolen added 22 commits April 26, 2023 15:50

Protect against report actions that don't have any reactions yet

b805586

Turn on API requests

4d70bbd

Merge branch 'main' into tgolen-migrate-reactions

7698ad0

Simplify the reaction data

8aacb9f

Use the updated data structure

cf4a396

Merge branch 'main' into tgolen-migrate-reactions

5d0808b

style

f88e62c

style

ea49f29

Get new emoji reactions displaying properly

36568e2

Add timestamp to requests when adding reactions

62f83fe

Add API parameter to use new data format

8c31f4f

Rename methods

f93266e

Rename old toggle method

44d426a

Provide a second toggle method for emojiReactions

5b99716

Update for checking to see if someone already reacted

b2781c9

Merge branch 'main' into tgolen-migrate-reactions

9adef35

style

c8369e5

Remove code that still uses old format

d7221f6

Remove more code referencing old reactions

34797c7

Remove unused component

11c5380

Get tests working for toggling reactions

2970f79

Update tests for adding reactions

c17e2ec

stitesExpensify added 2 commits July 17, 2023 14:51

Merge branch 'main' of github.com:Expensify/App into tgolen-migrate-r…

b4d7e6e

…eactions

Remove unused prop

73ca137

MariaHCD approved these changes Jul 18, 2023

View reviewed changes

neil-marcellini approved these changes Jul 18, 2023

View reviewed changes

rushatgabhane suggested changes Jul 20, 2023

View reviewed changes

rushatgabhane approved these changes Jul 20, 2023

View reviewed changes

melvin-bot bot requested a review from techievivek July 20, 2023 06:43

MariaHCD merged commit e87f2eb into main Jul 20, 2023

MariaHCD deleted the tgolen-migrate-reactions branch July 20, 2023 09:04

This was referenced Jul 20, 2023

[HOLD for c+ payment in newdot] [$1000] Dev: "0:undefined:" displayed in reaction emoji tooltip #23307

Closed

[HOLD for payment 2023-08-28] [$1000] Dev: Web - Emoji-reacted tooltip does not close for User B when User A deletes the message #23308

Closed

OSBotify mentioned this pull request Jul 21, 2023

Deploy Checklist: New Expensify 2023-07-21 #23362

Closed

lanitochka17 mentioned this pull request Jul 22, 2023

[$1000] Chat - Removed reactions by other user offline still displayed after going online #23388

Closed

6 tasks

stitesExpensify mentioned this pull request Jul 24, 2023

fixed: dev: '0:undefined:' displayed in reaction emoji tooltip #23371

Merged

58 tasks

OSBotify mentioned this pull request Jul 25, 2023

Deploy Checklist: New Expensify 2023-07-25 #23522

Closed

pecanoro mentioned this pull request Jul 26, 2023

[HOLD for payment 2023-08-08] [$1000] Dev: Web - Message is not center aligned vertically #23350

Closed

6 tasks

stitesExpensify mentioned this pull request Jul 26, 2023

Only render ReportActionItemReactions if there are reactions #23671

Merged

58 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support new emojiReaction data format #17996

Support new emojiReaction data format #17996

tgolen commented Apr 25, 2023 •

edited by stitesExpensify

Loading

tgolen commented Apr 26, 2023 •

edited

Loading

stitesExpensify commented Jul 17, 2023

MariaHCD left a comment

stitesExpensify commented Jul 18, 2023

neil-marcellini left a comment

stitesExpensify commented Jul 19, 2023

rushatgabhane commented Jul 20, 2023 •

edited

Loading

rushatgabhane left a comment

aimane-chnaif commented Jul 20, 2023 •

edited

Loading

rushatgabhane commented Jul 20, 2023 •

edited

Loading

rushatgabhane left a comment

melvin-bot bot commented Jul 20, 2023

OSBotify commented Jul 20, 2023

ayazhussain79 commented Jul 20, 2023

OSBotify commented Jul 21, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

Support new emojiReaction data format #17996

Support new emojiReaction data format #17996

Conversation

tgolen commented Apr 25, 2023 • edited by stitesExpensify Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

tgolen commented Apr 26, 2023 • edited Loading

stitesExpensify commented Jul 17, 2023

MariaHCD left a comment

Choose a reason for hiding this comment

stitesExpensify commented Jul 18, 2023

neil-marcellini left a comment

Choose a reason for hiding this comment

stitesExpensify commented Jul 19, 2023

rushatgabhane commented Jul 20, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

rushatgabhane left a comment

Choose a reason for hiding this comment

aimane-chnaif commented Jul 20, 2023 • edited Loading

rushatgabhane commented Jul 20, 2023 • edited Loading

rushatgabhane left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jul 20, 2023

OSBotify commented Jul 20, 2023

ayazhussain79 commented Jul 20, 2023

OSBotify commented Jul 21, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

tgolen commented Apr 25, 2023 •

edited by stitesExpensify

Loading

tgolen commented Apr 26, 2023 •

edited

Loading

rushatgabhane commented Jul 20, 2023 •

edited

Loading

aimane-chnaif commented Jul 20, 2023 •

edited

Loading

rushatgabhane commented Jul 20, 2023 •

edited

Loading