fix: sorted suggestion emoji #51220

nkdengineer · 2024-10-22T04:43:37Z

Details

Fixed Issues

$ #50079
PROPOSAL: #50079 (comment)

Tests

Open any DM
Type :dis in the compose box for emoji suggestions
Verify that: Suggestions displayed are sorted in that more closely match the text

Verify that no errors appear in the JS console

Offline tests

same as above

QA Steps

same as above

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

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

android-mweb.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-mweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-10-22T08:59:01Z

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

suneox · 2024-10-22T14:56:36Z

@nkdengineer Could you please update the Tests section at Step 3 to reflect this confirmation, instead of display by sorted alphabetically?

suneox · 2024-10-22T15:42:00Z

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

Screen.Recording.2024-10-22.at.22.15.54.mp4

Android: mWeb Chrome

Screen.Recording.2024-10-22.at.22.15.00.mp4

iOS: Native

Screen.Recording.2024-10-22.at.22.13.24.mp4

iOS: mWeb Safari

Screen.Recording.2024-10-22.at.22.11.46.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-10-22.at.22.10.14.mp4

MacOS: Desktop

Screen.Recording.2024-10-22.at.22.14.14.mp4

Warning: Function components cannot be given refs was raised on slack

Warning: TRenderEngineProvider: Support for defaultProps was raised on slack

suneox · 2024-10-24T02:46:05Z

Bump @nkdengineer for update Test section at comment

nkdengineer · 2024-10-29T03:56:16Z

@suneox i updated, please check again

src/libs/EmojiUtils.ts

srikarparsi · 2024-10-31T16:24:45Z

tests/unit/EmojiTest.ts

@@ -154,6 +154,11 @@ describe('EmojiTest', () => {

    it('correct suggests emojis accounting for keywords', () => {
        const thumbEmojisEn: Emoji[] = [
+            {


Why did we move this back up? We moved it down for this issue: #48748

@srikarparsi After we sort the suggestion emoji, the position of the emojis in the test is changed here

Hm, when I test it manually, the wrong emoji comes up first, does this occur for you as well?

@srikarparsi I think that's expected since we're prioritizing sorting by emoji name here.

Hm, I don't think that's expected. Based on this issue, I believe we want :thumb to show the thumbs up emoji first instead of the hand_with_index_finger emoji in the picture.

My vote would be either to do nothing, or update the sorting algorithm now to include keywords since "thumbsup" is already in that array.

FWIW, :thumbsup: is the emoji name on slack

The name in slack is :+1: 😄 Even if you type :thumbsup:, when you highlight it, it will always say +1

Hm okay, updating the sorting algorithm to include keywords wouldn't work for this example right? Because melting_face 🫠 has keywords that start with dis even though the name doesn't.

I am leaning towards changing the names of +1 and -1 to thumbsup and thumbsdown and including a comment explaining to change the name back once we incorporate frequency into our sorting algorithm. Does that sound okay with you?

If not, I am also fine with doing nothing for now for this edge case.

Yeah let's do nothing. Keeping the same names as unicode seems more important than this one edge case IMO

Soundss good, going to merge this one then

srikarparsi

Just one comment

srikarparsi

going to merge this one. :thu is going to generate 🫰 first on the list but I believe we prefer that over changing the unicode name.

OSBotify · 2024-11-19T21:03: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.

github-actions · 2024-11-21T01:43:56Z

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

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

github-actions · 2024-11-22T19:47:56Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 9.0.65-5 🚀

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

nkdengineer added 6 commits October 22, 2024 11:43

fix: sorted suggestion emoji

e774111

Merge branch 'main' into fix/50079

a2adfcd

fix test

596f16f

chore

313d716

fix test

8e6b360

fix lint

7cacc00

nkdengineer marked this pull request as ready for review October 22, 2024 08:58

nkdengineer requested a review from a team as a code owner October 22, 2024 08:58

melvin-bot bot requested review from suneox and removed request for a team October 22, 2024 08:58

This comment was marked as outdated.

Sign in to view

suneox reviewed Oct 29, 2024

View reviewed changes

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

nkdengineer added 2 commits October 30, 2024 16:31

Merge branch 'main' into fix/50079

542cb41

create a function to remove dup code

c0a7a2f

suneox approved these changes Oct 30, 2024

View reviewed changes

melvin-bot bot requested a review from srikarparsi October 30, 2024 15:00

srikarparsi reviewed Oct 31, 2024

View reviewed changes

srikarparsi requested changes Oct 31, 2024

View reviewed changes

nkdengineer added 3 commits November 6, 2024 15:53

Merge branch 'main' into fix/50079

14e4caf

Merge branch 'main' into fix/50079

ebcdade

Merge branch 'main' into fix/50079

3120da7

srikarparsi mentioned this pull request Nov 18, 2024

[HOLD for payment 2024-11-29] [$250] Auto suggestions for emoji is not sorted alphabetically #50079

Closed

6 tasks

srikarparsi approved these changes Nov 19, 2024

View reviewed changes

srikarparsi merged commit 688d360 into Expensify:main Nov 19, 2024
28 checks passed

github-actions bot mentioned this pull request Nov 21, 2024

Deploy Checklist: New Expensify 2024-11-21 #52862

Closed

65 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: sorted suggestion emoji #51220

fix: sorted suggestion emoji #51220

nkdengineer commented Oct 22, 2024 •

edited

Loading

melvin-bot bot commented Oct 22, 2024

suneox commented Oct 22, 2024 •

edited

Loading

suneox commented Oct 22, 2024 •

edited

Loading

suneox commented Oct 24, 2024

This comment was marked as outdated.

nkdengineer commented Oct 29, 2024

srikarparsi Oct 31, 2024

nkdengineer Nov 4, 2024

srikarparsi Nov 5, 2024 •

edited

Loading

nkdengineer Nov 6, 2024

srikarparsi Nov 6, 2024

stitesExpensify Nov 19, 2024

stitesExpensify Nov 19, 2024

srikarparsi Nov 19, 2024 •

edited

Loading

stitesExpensify Nov 19, 2024

srikarparsi Nov 19, 2024

srikarparsi left a comment •

edited

Loading

srikarparsi left a comment

OSBotify commented Nov 19, 2024

github-actions bot commented Nov 21, 2024

github-actions bot commented Nov 22, 2024

fix: sorted suggestion emoji #51220

fix: sorted suggestion emoji #51220

Conversation

nkdengineer commented Oct 22, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 22, 2024

suneox commented Oct 22, 2024 • edited Loading

suneox commented Oct 22, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

suneox commented Oct 24, 2024

This comment was marked as outdated.

nkdengineer commented Oct 29, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

srikarparsi Nov 5, 2024 • edited Loading

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

srikarparsi Nov 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

srikarparsi left a comment • edited Loading

Choose a reason for hiding this comment

srikarparsi left a comment

Choose a reason for hiding this comment

OSBotify commented Nov 19, 2024

github-actions bot commented Nov 21, 2024

github-actions bot commented Nov 22, 2024

nkdengineer commented Oct 22, 2024 •

edited

Loading

suneox commented Oct 22, 2024 •

edited

Loading

suneox commented Oct 22, 2024 •

edited

Loading

srikarparsi Nov 5, 2024 •

edited

Loading

srikarparsi Nov 19, 2024 •

edited

Loading

srikarparsi left a comment •

edited

Loading