[TS migration] Migrate 'EmojiUtils.js' lib to TypeScript #28589

BartoszGrajdek · 2023-10-02T09:18:27Z

Details

Migrate EmojiUtils lib & assets to typescript

Fixed Issues

$ #24899
$ #24733

Tests

Test if EmojiPicker works correctly, send a few messages with emotes
Check emoji reactions - ideally with multiple accounts and different skin tones
Make sure that emoji suggestion is working like it used to before
Check if recently used emotes are working

Offline tests

QA Steps

Test if EmojiPicker works correctly, send a few messages with emotes
Check emoji reactions - ideally with multiple accounts and different skin tones
Make sure that emoji suggestion is working like it used to before
Check if recently used emotes are working

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

web.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

ios.mov

Android

android.mov

…ils-lib

BartoszGrajdek · 2023-10-02T09:49:22Z

@blazejkustra please review this before it goes off to callstack

assets/emojis/index.ts

src/libs/EmojiUtils.ts

assets/emojis/common.ts

src/libs/EmojiUtils.ts

kubabutkiewicz

one small comment , but LGTM

assets/emojis/types.ts

melvin-bot · 2023-10-18T09:25:58Z

@0xmiroslav 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]

blazejkustra

One small comment, let's add more detailed Tests and QA Steps @BartoszGrajdek

src/libs/EmojiUtils.ts

BartoszGrajdek · 2023-10-24T09:05:31Z

@0xmiroslav bump

situchan · 2023-10-26T07:54:03Z

Taking this over based on @0xmiroslav's request

blazejkustra · 2023-10-27T11:02:41Z

@situchan we would greatly appreciate it if you could work on the reviewer's checklist today. This PR blocks other migration PR.

situchan · 2023-10-27T11:10:07Z

Sure. Reviewing now

situchan

I don't see Frequently Used emojis

Screen.Recording.2023-10-27.at.6.33.36.PM.mov

situchan · 2023-10-27T12:18:05Z

src/libs/EmojiUtils.ts

            if (matching.length === limit) {
                return matching;
            }
-            matching.push({code: nodes[j].metaData.code, name: nodes[j].name, types: nodes[j].metaData.types});
+            matching.push({code: node.metaData?.code ?? '', name: node.name, types: node.metaData.types});


Already have this check - node.metaData.code && in if condition

Suggested change

matching.push({code: node.metaData?.code ?? '', name: node.name, types: node.metaData.types});

matching.push({code: node.metaData.code, name: node.name, types: node.metaData.types});

situchan · 2023-10-27T12:45:36Z

I noticed that above bug also happens on main. So not able to verify this PR didn't cause any issue with Frequently Used emojis.

situchan · 2023-10-27T13:22:13Z

I can confirm that manually typing emoji in composer works and added to recent list

web2.mov

situchan · 2023-11-07T11:05:57Z

Console error:

Happening on main so out of scope

Repro step:

Screen.Recording.2023-11-07.at.5.06.21.PM.mov

situchan · 2023-11-07T11:12:48Z

Crash on android

situchan · 2023-11-07T11:21:39Z

src/libs/EmojiUtils.ts

+    const usersWithTimestamps: Record<string, UserReactionsWithTimestamps> = {};
+    Object.keys(emoji.users ?? {}).forEach((id) => {
+        const user = emoji?.users?.[id];
+        const oldestUserTimestamp = Object.values(user?.skinTones ?? {}).reduce((min, curr) => (curr < min ? curr : min));


initial value is missing in reduce 2nd param. This leads to crash

I've added the initial value, can you tell me what have you done to crash the app?

I randomly tested emojis on other platform. And then opened that report in android app

Screen.Recording.2023-11-07.at.5.33.39.PM.mov

situchan · 2023-11-07T11:39:04Z

Above crash is replaced with this one after last commit:

Screen.Recording.2023-11-07.at.5.36.04.PM.mov

situchan · 2023-11-07T11:42:33Z

For easy debugging:

BartoszGrajdek · 2023-11-07T11:50:11Z

Above crash is replaced with this one after last commit:

Screen.Recording.2023-11-07.at.5.36.04.PM.mov

Working on it, however cannot reproduce yet

situchan · 2023-11-07T11:59:03Z

It's interesting that crash happens only on my android emulator.
Version: Pixel 2 API 30

blazejkustra · 2023-11-07T12:00:13Z

I managed to reproduce this error, or similar one on web. @BartoszGrajdek is investigating 👍

BartoszGrajdek · 2023-11-07T14:37:42Z

Alright, the error that Błażej reproduced wasn't the one you've seen @situchan

Could you please provide some reproduction steps? Also is it only happening on this branch, or is it on main as well?

situchan · 2023-11-07T14:41:47Z

Alright, the error that Błażej reproduced wasn't the one you've seen @situchan

Could you please provide some reproduction steps? Also is it only happening on this branch, or is it on main as well?

Only this branch. Not happening on main

Can you fix based on log I shared above? I can test here.

BartoszGrajdek · 2023-11-07T14:44:53Z

I've added a quick fix, however if this doesn't work we will need some clear reproduction steps unfortunately. Let us know how it works out @situchan

situchan · 2023-11-07T14:47:42Z

src/libs/EmojiUtils.ts

    const {users, oldestTimestamp} = enrichEmojiReactionWithTimestamps(reaction, emojiName);

    const emoji = findEmojiByName(emojiName);
    const emojiCodes = getUniqueEmojiCodes(emoji, users);
-    const reactionCount = lodashSum(_.map(users, (user) => _.size(user.skinTones)));
+    const reactionCount = Object.values(users)
+        .map((user) => Object.values(user.skinTones).length)


Suggested change

.map((user) => Object.values(user.skinTones).length)

.map((user) => Object.values(user.skinTones ?? {}).length)

Crash doesn't happen anymore after this change

Done! I've also added this in a few other places, to make sure that potential undefined are handled.

situchan · 2023-11-07T15:17:33Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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

Android: Native

android.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

situchan

francoisl

Nice

OSBotify · 2023-11-07T18:55:38Z

✋ 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-11-08T08:30:27Z

🚀 Deployed to staging by https://github.com/francoisl in version: 1.3.96-6 🚀

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

OSBotify · 2023-11-09T22:46:04Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

OSBotify · 2023-11-10T16:02:06Z

🚀 Deployed to staging by https://github.com/francoisl in version: 1.3.98-0 🚀

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

OSBotify · 2023-11-14T21:55:33Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.98-5 🚀

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

rayane-djouah · 2024-08-08T08:52:19Z

src/libs/EmojiUtils.ts

-        frequentlyUsedEmojis = _.map(val, (item) => {
-            const emoji = Emojis.emojiCodeTableWithSkinTones[item.code];
-            if (emoji) {
-                return {...emoji, count: item.count, lastUpdatedAt: item.lastUpdatedAt};
-            }
-        });
+        if (!val) {
+            return;
+        }
+        frequentlyUsedEmojis =
+            val
+                ?.map((item) => {
+                    const emoji = Emojis.emojiCodeTableWithSkinTones[item.code];
+                    return {...emoji, count: item.count, lastUpdatedAt: item.lastUpdatedAt};
+                })
+                .filter((emoji): emoji is FrequentlyUsedEmoji => !!emoji) ?? [];
    },
 });


FYI, removing if (emoji) condition in this PR caused #45354

More details in this proposal: #45354 (comment)

BartoszGrajdek added 5 commits September 27, 2023 14:25

Migrate emoji utils lib to TS

9703539

Fix types

53e7db7

Merge remote-tracking branch 'origin/main' into ts-migration/emoji-ut…

f70e7f9

…ils-lib

Migrate emoji utils to TS

6092e1d

Rename types

f2ee9a0

blazejkustra suggested changes Oct 3, 2023

View reviewed changes

Fixes after review for emojiUtils lib

1e005a8

blazejkustra approved these changes Oct 11, 2023

View reviewed changes

Resolve merge conflicts

a0ab67c

blazejkustra approved these changes Oct 12, 2023

View reviewed changes

kubabutkiewicz approved these changes Oct 17, 2023

View reviewed changes

assets/emojis/types.ts Show resolved Hide resolved

Resolve merge conflicts

5b0cf78

BartoszGrajdek marked this pull request as ready for review October 18, 2023 09:25

BartoszGrajdek requested a review from a team as a code owner October 18, 2023 09:25

melvin-bot bot requested review from 0xmiros and removed request for a team October 18, 2023 09:25

Resolve merge conflicts

d6e6b83

blazejkustra approved these changes Oct 23, 2023

View reviewed changes

src/libs/EmojiUtils.ts Outdated Show resolved Hide resolved

Remove code from comment

ab49c91

BartoszGrajdek changed the title ~~[No QA] [TS migration] Migrate 'EmojiUtils.js' lib to TypeScript~~ [TS migration] Migrate 'EmojiUtils.js' lib to TypeScript Oct 24, 2023

blazejkustra mentioned this pull request Oct 27, 2023

[TS migration] Migrate 'EmojiSuggestions.js' component to TypeScript #30416

Merged

58 tasks

situchan reviewed Oct 27, 2023

View reviewed changes

situchan reviewed Nov 7, 2023

View reviewed changes

Add default value to reduce

0453d00

fix: app crashing on android

7f417c7

situchan reviewed Nov 7, 2023

View reviewed changes

fix: ensure undefined objects are handled

082a210

situchan approved these changes Nov 7, 2023

View reviewed changes

melvin-bot bot requested a review from francoisl November 7, 2023 15:25

francoisl approved these changes Nov 7, 2023

View reviewed changes

francoisl merged commit 8f5007a into Expensify:main Nov 7, 2023
16 of 17 checks passed

OSBotify mentioned this pull request Nov 8, 2023

Deploy Checklist: New Expensify 2023-11-06 #30929

Closed

OSBotify mentioned this pull request Nov 10, 2023

Deploy Checklist: New Expensify 2023-11-10 #31187

Closed

rayane-djouah reviewed Aug 8, 2024

View reviewed changes

rayane-djouah mentioned this pull request Aug 8, 2024

[HOLD for payment 2024-08-07] [$250] App crashes when opening a emoji picker #45354

Closed

6 tasks

	matching.push({code: node.metaData?.code ?? '', name: node.name, types: node.metaData.types});
	matching.push({code: node.metaData.code, name: node.name, types: node.metaData.types});

	.map((user) => Object.values(user.skinTones).length)
	.map((user) => Object.values(user.skinTones ?? {}).length)

[TS migration] Migrate 'EmojiUtils.js' lib to TypeScript #28589

[TS migration] Migrate 'EmojiUtils.js' lib to TypeScript #28589

Conversation

BartoszGrajdek commented Oct 2, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

BartoszGrajdek commented Oct 2, 2023

kubabutkiewicz left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 18, 2023

blazejkustra left a comment

Choose a reason for hiding this comment

BartoszGrajdek commented Oct 24, 2023

situchan commented Oct 26, 2023

blazejkustra commented Oct 27, 2023

situchan commented Oct 27, 2023

situchan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

situchan commented Oct 27, 2023

situchan commented Oct 27, 2023

situchan commented Nov 7, 2023 • edited Loading

situchan commented Nov 7, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

situchan commented Nov 7, 2023

situchan commented Nov 7, 2023

BartoszGrajdek commented Nov 7, 2023

situchan commented Nov 7, 2023

blazejkustra commented Nov 7, 2023

BartoszGrajdek commented Nov 7, 2023

situchan commented Nov 7, 2023

BartoszGrajdek commented Nov 7, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

situchan commented Nov 7, 2023

Reviewer Checklist

Screenshots/Videos

situchan left a comment

Choose a reason for hiding this comment

francoisl left a comment

Choose a reason for hiding this comment

OSBotify commented Nov 7, 2023

OSBotify commented Nov 8, 2023

OSBotify commented Nov 9, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 14, 2023

Choose a reason for hiding this comment

BartoszGrajdek commented Oct 2, 2023 •

edited

Loading

situchan commented Nov 7, 2023 •

edited

Loading