import emoji async draft #41097

rinej · 2024-04-26T13:15:03Z

Details

Problem
Currently, both translations for emoji in English (EN) and Spanish (ES) are imported during app initialization. Additionally, we create large objects of EmojiTrie for both languages. The idea is to import and build EmojiTrie only for the currently selected language.

Solution
During app initialization, we check the preferred language and import only that translation file.
We create an EmojiTrie only for that selected language.
If the user changes the language, we will dynamicly import the new translation file and create a new Trie object at that time.

In most cases, users only use one language, so by implementing this change, we can significantly reduce memory consumption and the time needed for creating large EmojiTrie objects.

Some concerns
Jest doesn't support dynamic imports by default. We have to add the flag --experimental-vm-modules (https://jestjs.io/docs/ecmascript-modules ) when running jest command (both in GH action and in local package json).

Fixed Issues

$ #41893

Tests

Offline tests

QA Steps

Open report view
Type some emoji shortcut in the input field e.g. :snail
See that the Snail emoji is in suggested list
Change language in settings to spanish
Check if translation are loaded properly
Go back to the report screen
Type spanish emoji shortcut e.g. :caracol
See that the Snail emoji is in suggested list

PR Author Checklist

Screenshots/Videos

Android: Native

Android.mp4

Android: mWeb Chrome

Android-web.mp4

iOS: Native

iOS.mp4

iOS: mWeb Safari

iOS-web.mp4

MacOS: Chrome / Safari

Web.mp4

MacOS: Desktop

Desktop.mp4

gedu · 2024-04-26T13:29:31Z

src/libs/EmojiTrie.ts

@@ -95,9 +95,24 @@ function createTrie(lang: SupportedLanguage = CONST.LOCALES.DEFAULT): Trie<Emoji
    return trie;
 }

-const emojiTrie: EmojiTrie = supportedLanguages.reduce((prev, cur) => ({...prev, [cur]: createTrie(cur)}), {});
+// const emojiTrie: EmojiTrie = supportedLanguages.reduce((prev, cur) => ({...prev, [cur]: createTrie(cur)}), {});


Remove this comment when the PR is ready

hurali97 · 2024-04-26T14:14:02Z

src/libs/EmojiTrie.ts

+const emojiTrie: EmojiTrie = {
+    en: undefined,
+    es: undefined,
+};


Instead of manually creating and maintaining this variable can we consider implementing something like:

https://github.com/callstack-internal/Expensify-App/blob/f903144c44c252e676670ad8d8251f992219cfd6/src/libs/Localize/index.ts#L68-L73

That approach I think will create all the tries for "en" and "es" and we want to create them on demand, that's why the idea is to create them manually when it is needed

good point, I added the change so now we create it based on supportedLanguages variable, thanks!

hurali97 · 2024-04-26T14:15:38Z

src/libs/EmojiTrie.ts

+    es: undefined,
+};
+
+const buildEmojisTrie = (locale: 'en' | 'es') => {


Based on the above comment we might need to tweak the locale type.

const locales = ['en', 'es'] as const; type Locale = (typeof locales)[number]; // produces a type of: 'en' | 'es';

adjusted it, used Locale type, thanks!

melvin-bot · 2024-05-09T11:02:24Z

npm has a package.json file and a package-lock.json file. It seems you updated one without the other, which is usually a sign of a mistake. If you are updating a package make sure that you update the version in package.json then run npm install

melvin-bot · 2024-05-10T09:10:53Z

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

shubham1206agra · 2024-05-10T12:13:58Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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: mWeb Chrome

Screen.Recording.2024-05-09.at.6.59.07.PM.mov

iOS: Native

Screen.Recording.2024-05-10.at.5.29.23.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-05-09.at.6.48.27.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-05-09.at.6.46.58.PM.mov

MacOS: Desktop

Screen.Recording.2024-05-09.at.7.12.42.PM.mov

rlinoz

Looks good to me!

rlinoz · 2024-05-10T15:24:25Z

All yours @mountiny

rlinoz · 2024-05-10T19:09:37Z

Is the failling test related to this? It doesn't look like it.

dubielzyk-expensify · 2024-05-12T22:26:13Z

Looks like there's no design review needed here as this is mostly a technical solution?

mountiny

@rinej Can you please merge main and check out the failing test? I am worried it might be related to the node_options change?

Also can you please update the QA steps to not be a checkbox, but instead a numbered list? Its easier to read and follow. Thank you!

rinej · 2024-05-13T12:22:07Z

@mouting I did it, I also added the change to fix the failing workflow

There was similar issue here -> #40778 (comment)
I adjusted the tests suggested here -> ccfd44b

mountiny

Thanks for the changes

OSBotify · 2024-05-13T12:56:17Z

✋ 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 · 2024-05-15T10:13:05Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.74-0 🚀

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

OSBotify · 2024-05-22T23:58:06Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.4.74-6 🚀

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

import emoji async draft

25da155

gedu reviewed Apr 26, 2024

View reviewed changes

refactor: remove redundant if statements

3729e0e

hurali97 reviewed Apr 26, 2024

View reviewed changes

rinej added 19 commits May 6, 2024 16:22

add dynamic emojiTrie creation based on locale variable

f9a9f06

Merge branch 'main' into Load-Emojis-async-depending-on-lang

67f7c37

use vm module for jest tests

ead2673

add proper error handling for dynamic imports

4e3e2f2

fix: fix lint

fab626e

add console logs for debug on cli

6ad5f7a

add build stept to test to debug on cli

1326dbc

fix lint

04e5e36

Merge branch 'main' into Load-Emojis-async-depending-on-lang

09a780e

remove silent and add logs for debug

dd38471

add cl fo debug

7765f88

run test action from packagejson script

f34d9e7

add experimental flag to gh action

cf4776e

adjust action

2ac8e85

adjust jest action

cb2a2e7

cleanup

f39d4bc

add comments

3fbcbda

cleanup

f6d465d

adjust package json script

9f4028f

mountiny assigned rinej May 9, 2024

mountiny self-requested a review May 9, 2024 11:02

mountiny requested a review from shubham1206agra May 9, 2024 11:12

rinej added 2 commits May 10, 2024 10:15

adjust imports for ios

776be3d

parse typescript types for jest tests

82ceac6

Merge branch 'main' into Load-Emojis-async-depending-on-lang

5879397

rinej marked this pull request as ready for review May 10, 2024 09:10

rinej requested review from a team as code owners May 10, 2024 09:10

melvin-bot bot requested review from rlinoz and removed request for a team May 10, 2024 09:10

shubham1206agra approved these changes May 10, 2024

View reviewed changes

rinej mentioned this pull request May 10, 2024

[HOLD for payment 2024-05-29] LOW: [$250] [Performance] Only import the preferred locale and load the other language dynamically if needed #41893

Closed

rlinoz previously approved these changes May 10, 2024

View reviewed changes

mountiny requested changes May 13, 2024

View reviewed changes

rinej added 2 commits May 13, 2024 13:47

Merge branch 'main' into Load-Emojis-async-depending-on-lang

dfdce42

fix failing workflow

060127c

rinej dismissed rlinoz’s stale review via 060127c May 13, 2024 12:10

mountiny approved these changes May 13, 2024

View reviewed changes

mountiny merged commit 323fa7c into Expensify:main May 13, 2024
19 checks passed

github-actions bot mentioned this pull request May 15, 2024

Deploy Checklist: New Expensify 2024-05-15 #42185

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

import emoji async draft #41097

import emoji async draft #41097

rinej commented Apr 26, 2024 •

edited

Loading

gedu Apr 26, 2024

hurali97 Apr 26, 2024

gedu Apr 26, 2024

rinej May 8, 2024

hurali97 Apr 26, 2024

adhorodyski May 7, 2024

adhorodyski May 7, 2024

rinej May 8, 2024

melvin-bot bot commented May 9, 2024

melvin-bot bot commented May 10, 2024

shubham1206agra commented May 10, 2024

rlinoz left a comment

rlinoz commented May 10, 2024

rlinoz commented May 10, 2024 •

edited

Loading

dubielzyk-expensify commented May 12, 2024

mountiny left a comment

rinej commented May 13, 2024

mountiny left a comment

OSBotify commented May 13, 2024

OSBotify commented May 15, 2024

OSBotify commented May 22, 2024

import emoji async draft #41097

import emoji async draft #41097

Conversation

rinej commented Apr 26, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

melvin-bot bot commented May 9, 2024

melvin-bot bot commented May 10, 2024

shubham1206agra commented May 10, 2024

Reviewer Checklist

Screenshots/Videos

rlinoz left a comment

Choose a reason for hiding this comment

rlinoz commented May 10, 2024

rlinoz commented May 10, 2024 • edited Loading

dubielzyk-expensify commented May 12, 2024

mountiny left a comment

Choose a reason for hiding this comment

rinej commented May 13, 2024

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented May 13, 2024

OSBotify commented May 15, 2024

OSBotify commented May 22, 2024

rinej commented Apr 26, 2024 •

edited

Loading

rlinoz commented May 10, 2024 •

edited

Loading