Fix: `preferredSkinTone` type warning #18789

tienifr · 2023-05-11T18:34:19Z

Details

The preferredSkinTone is supposed to be Number but sometimes it's passed as String since default was its legacy default value (becomes -1 now). This PR fixes that.

Fixed Issues

$ #18541
PROPOSAL: #18541 (comment)

Tests

Login with any account
Go to any chat
Type in semicolon with emoji prefix (i.e. :sm)
Verify that the error Invalid prop preferredSkinToneIndex of type string supplied to EmojiSuggestions, expected number does not appear in the JS console

Verify that no errors appear in the JS console

Offline tests

QA Steps

Login with any account
Go to any chat
Type in semicolon with emoji prefix (i.e. :sm)
Verify that the error Invalid prop preferredSkinToneIndex of type string supplied to EmojiSuggestions, expected number does not appear in the JS console

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screencast.from.12-05-2023.01.42.18.webm

Mobile Web - Chrome

Screencast.from.12-05-2023.01.53.16.webm

video_2023-05-12_01-54-36.mp4

Mobile Web - Safari

RPReplay_Final1683878938.mp4

Desktop

Screen.Recording.2023-05-12.at.15.22.51.mov

iOS

Screen.Recording.2023-05-12.at.15.30.11.mov

Android

untitled.webm

melvin-bot · 2023-05-11T19:00:03Z

@pecanoro @mollfpr One of you needs to 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]

tienifr · 2023-05-11T19:10:10Z

While working on this PR, I found out that if the new getPreferredSkinToneIndex function was put in EmojiUtils, using it in Report.js would cause import cycle: Report > EmojiUtils > User > Report. Thus, I decided to move this line out of EmojiUtils:

App/src/libs/EmojiUtils.js

Line 191 in 057417c

User.updateFrequentlyUsedEmojis(frequentEmojiList);

due to:

Prone to causing import cycle
Calling API function within an utility function is weird

Then it would be used like this:

App/src/pages/home/report/ReportActionCompose.js

Lines 610 to 611 in 66f7c0a

    
           const frequentEmojiList = EmojiUtils.addToFrequentlyUsedEmojis(this.props.frequentlyUsedEmojis, emojiObject); 
        
           User.updateFrequentlyUsedEmojis(frequentEmojiList);

pecanoro · 2023-05-12T12:13:48Z

There are some unit tests failing!

src/libs/actions/Report.js

tienifr · 2023-05-14T16:38:04Z

Comments're resolved and tests're fixed!

pecanoro · 2023-05-15T10:56:53Z

@mollfpr Waiting on the checklist to do a final review from my side 😄

mollfpr · 2023-05-15T11:01:36Z

Sorry I’ll working on it in two hours!

src/libs/EmojiUtils.js

mollfpr · 2023-05-15T16:25:11Z

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

18789.Web.mov

Mobile Web - Chrome

18789.mWeb.Chrome.mov

Mobile Web - Safari

18789.mWeb.Safari.mp4

Desktop

18789.Desktop.mov

iOS

18789.iOS.mp4

Android

18789.Android.mov

src/libs/EmojiUtils.js

pecanoro · 2023-05-16T08:11:03Z

@tienifr Linter is complaining since you need to run npm run prettier!

pecanoro · 2023-05-16T10:13:02Z

It looks good and it was working pretty well!

OSBotify · 2023-05-16T10:19:29Z

✋ 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-05-17T01:08:33Z

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.3.15-0 🚀

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

OSBotify · 2023-05-18T06:51:44Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.15-12 🚀

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

tienifr added 3 commits May 12, 2023 01:15

refactor: remove User from EmojiUtils to avoid import cycle

9128c0d

fix: preferredSkinTone type warning

ce7ee2e

prevent preferredSkinTone's legacy value where necessary

66f7c0a

tienifr marked this pull request as ready for review May 11, 2023 18:59

tienifr requested a review from a team as a code owner May 11, 2023 18:59

melvin-bot bot requested review from mollfpr and pecanoro and removed request for a team May 11, 2023 19:00

This comment was marked as outdated.

Sign in to view

tienifr mentioned this pull request May 11, 2023

[HOLD for payment 2023-05-25] [$1000] Dev: console error when emoji suggestions list open #18541

Closed

6 tasks

tienifr added 4 commits May 12, 2023 16:18

Merge branch 'main' into fix/18541

36441cf

revert: prevent preferredSkinTone's legacy value where necessary

2a431b5

remove redundant imports

b4e137a

fix eslint

564914f

mollfpr reviewed May 12, 2023

View reviewed changes

src/libs/actions/Report.js Outdated Show resolved Hide resolved

tienifr added 2 commits May 14, 2023 23:32

assign to preferredSkinTone

182ca56

fix unit tests

08065fb

mollfpr suggested changes May 15, 2023

View reviewed changes

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

tienifr added 2 commits May 15, 2023 22:33

rename addToFrequentlyUsedEmojis function

7b68582

Merge branch 'main' into fix/18541-preferredSkinTone-type-warning

850aab6

mollfpr reviewed May 15, 2023

View reviewed changes

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

refactor: move User action out of EmojiUtils

ed10b48

fix eslint

d7412e7

pecanoro approved these changes May 16, 2023

View reviewed changes

pecanoro merged commit f0478bb into Expensify:main May 16, 2023

OSBotify mentioned this pull request May 16, 2023

Deploy Checklist: New Expensify 2023-05-16 #19088

Closed

71 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: `preferredSkinTone` type warning #18789

Fix: `preferredSkinTone` type warning #18789

tienifr commented May 11, 2023 •

edited

Loading

melvin-bot bot commented May 11, 2023

tienifr commented May 11, 2023 •

edited

Loading

This comment was marked as outdated.

pecanoro commented May 12, 2023

tienifr commented May 14, 2023

pecanoro commented May 15, 2023

mollfpr commented May 15, 2023 •

edited

Loading

mollfpr commented May 15, 2023

pecanoro commented May 16, 2023

pecanoro commented May 16, 2023

OSBotify commented May 16, 2023

OSBotify commented May 17, 2023

OSBotify commented May 18, 2023

Fix: preferredSkinTone type warning #18789

Fix: preferredSkinTone type warning #18789

Conversation

tienifr commented May 11, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 11, 2023

tienifr commented May 11, 2023 • edited Loading

This comment was marked as outdated.

pecanoro commented May 12, 2023

tienifr commented May 14, 2023

pecanoro commented May 15, 2023

mollfpr commented May 15, 2023 • edited Loading

mollfpr commented May 15, 2023

Reviewer Checklist

Screenshots/Videos

pecanoro commented May 16, 2023

pecanoro commented May 16, 2023

OSBotify commented May 16, 2023

OSBotify commented May 17, 2023

OSBotify commented May 18, 2023

Fix: `preferredSkinTone` type warning #18789

Fix: `preferredSkinTone` type warning #18789

tienifr commented May 11, 2023 •

edited

Loading

tienifr commented May 11, 2023 •

edited

Loading

mollfpr commented May 15, 2023 •

edited

Loading