Refactor the EmojiPicker to a functional component #20187
Conversation
melvin-bot
bot
requested review from
chiragsalian and
parasharrajat
and removed request for
a team
|
@parasharrajat @chiragsalian 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] |
|
Oops a bit premature on the marking ready for review sorry I will add some screenshots later tonight. |
| const [onModalHide, setOnModalHide] = useState(() => {}); | ||
| const [onEmojiSelected, setOnEmojiSelected] = useState(() => {}); |
There was a problem hiding this comment.
We can move these to useRef instead or move outside the function to keep the same logic as before. usestate will cause the rerender which we don't want for these.
|
|
||
| /** | ||
| * Hide the emoji picker menu. | ||
| * | ||
| * @param {Boolean} isNavigating | ||
| */ | ||
| hideEmojiPicker(isNavigating) { | ||
| const hideEmojiPicker = (isNavigating) => { |
There was a problem hiding this comment.
I think we should use useCallback here. And same for all methods which were bound to this.
There was a problem hiding this comment.
Because we're now using all refs in these functions - I don't believe useCallback is necessary, right?
There was a problem hiding this comment.
The only difference is that now on each rerender these methods are recreated. When they were bound to this, they weren't recreated even when passed direct to props in JSX. If we use useCallback it will be same as before and function won't be recreated.
| useEffect(() => { | ||
| if (isEmojiPickerVisible) { | ||
| Keyboard.dismiss(); | ||
| } | ||
|
|
||
| this.hideEmojiPicker(); | ||
| if (_.isFunction(this.onEmojiSelected)) { | ||
| this.onEmojiSelected(emoji, emojiObject); | ||
| } | ||
| } | ||
| const emojiPopoverDimensionListener = Dimensions.addEventListener('change', () => { | ||
| measureEmojiPopoverAnchorPosition(emojiPopoverAnchor).then((value) => { | ||
| setEmojiPopoverAnchorPosition(value); | ||
| }); | ||
| }); | ||
| return () => { | ||
| emojiPopoverDimensionListener.remove(); | ||
| }; | ||
| }, [isEmojiPickerVisible, emojiPopoverAnchor]); |
There was a problem hiding this comment.
We should divide this in two useEffects as we will reattaching the DimenstionsChange listener even if only isEmojiPickerVisible is changed.
| const [emojiPopoverAnchorOrigin, setEmojiPopoverAnchorOrigin] = useState(DEFAULT_ANCHOR_ORIGIN); | ||
| const [onModalHide, setOnModalHide] = useState(() => {}); | ||
| const [onEmojiSelected, setOnEmojiSelected] = useState(() => {}); | ||
| const [emojiPopoverAnchor, setEmojiPopoverAnchor] = useState(null); |
There was a problem hiding this comment.
This should be using useRef as well.
There was a problem hiding this comment.
I believe it is, yeah?
There was a problem hiding this comment.
Oh wait my bad was looking at the wrong thing.
There was a problem hiding this comment.
Anyway, should be good now 👍
| return () => { | ||
| emojiPopoverDimensionListener.remove(); | ||
| }; | ||
| }, [isEmojiPickerVisible, emojiPopoverAnchor]); |
There was a problem hiding this comment.
When emojiPopoverAnchor is ref, this dependency should be changed to emojiPopoverAnchor.current, otherwise this will never change and we won't get the intended effect.
There was a problem hiding this comment.
if emojiPopoverAnchor is a ref, there is no need to add it as a dependency, because refs don't produce rerenders, so if the value of emojiPopoverArchor.current changes, useEffect won't get executed
| function measureEmojiPopoverAnchorPosition(anchorComponent) { | ||
| return new Promise((resolve) => { | ||
| if (!anchorComponent) { | ||
| return resolve({horizontal: 0, vertical: 0}); | ||
| } | ||
| anchorComponent.measureInWindow((x, y, width) => resolve({horizontal: x + width, vertical: y})); | ||
| }); |
There was a problem hiding this comment.
This function can be outside of the EmojiPicker component, it doesn't use any internal props or states
There was a problem hiding this comment.
This was previously using refs so I am thinking if we go with the above-requested changes then we might revert this back to directly using refs. But yes, this can be a generic function.
| * @param {Object} [anchorOrigin=DEFAULT_ANCHOR_ORIGIN] - Anchor origin for Popover | ||
| * @param {Function} [onWillShow=() => {}] - Run a callback when Popover will show | ||
| */ | ||
| function showEmojiPicker(onModalHideValue, onEmojiSelectedValue, emojiPopoverAnchorValue, anchorOrigin, onWillShow = () => {}) { |
There was a problem hiding this comment.
why here creating the function with function and the other functions with const I would keep it consistent and this one use const too
yuwenmemon
force-pushed
the
yuwen-emojiFunctional
branch
from
c81e003 to
5c55108
Compare
| componentDidUpdate(prevProps, prevState) { | ||
| if (prevState.isEmojiPickerVisible === this.state.isEmojiPickerVisible || !this.state.isEmojiPickerVisible) { | ||
| return; | ||
| function measureEmojiPopoverAnchorPosition(anchorComponent) { |
There was a problem hiding this comment.
Missing jSDoc and this function should be renamed.
There was a problem hiding this comment.
Cool, I've gone ahead and moved this to ComponentUtils as well.
| function calculateAnchorPosition(anchorComponent) { | ||
| return new Promise((resolve) => { | ||
| if (!anchorComponent) { | ||
| return resolve({horizontal: 0, vertical: 0}); | ||
| } | ||
| anchorComponent.measureInWindow((x, y, width) => resolve({horizontal: x + width, vertical: y})); | ||
| }); | ||
| } |
There was a problem hiding this comment.
We should not repeat the code even if these are two platform files. Let's DRY this up.
There was a problem hiding this comment.
How would you recommend doing this actually? I'm not 100% sure 🤔
There was a problem hiding this comment.
I would suggest,
- Create a common file and import that into these two files and directly export it.
- Create different util.
|
Can we please merge main to resolve conflicts? |
|
Updated! @parasharrajat please re-review. I did have one issue that I was curious for your take on. I'm seeing the following JS error after merging in main, and it looks like it's coming from the newly added HOCs from #18221 (cc @mollfpr @stitesExpensify @perunt) It seems like we might need to adjust how those HOCs forward the ref - but I'm not exactly sure which one is giving us trouble here 🤔 |
|
@parasharrajat bump! |
|
Testing this in 20 mins. |
|
All looks good. Only the error above @yuwenmemon. Either we need to pass the ref via a prop or move the forwardRef up as you did before. |
|
@parasharrajat Apologies, but could you explain that a bit better? I believe this is the same issue I was having trouble with that I described here. |
|
Ah checking it. |
|
No, it is a different issue. If you look closely, this error is talking about This error is coming because we are passing a component to the Because we need const EmojiPicker = forwardRef((props, ref) => ....You can even use function keyword instead of arrow function. e.g OR I am not sure if we will be able to do this. function EmojiPicker(props){
....
export default EmojiPicker; |
|
Ah okay. That makes sense - pushed - but I believe that error I was referring to might still be an issue - what do you see? |
|
Checking.... |
|
@yuwenmemon I see. We can fix this by updating the PropTypes on WithViewportOffsetTop.propTypes = {
// eslint-disable-next-line react/forbid-prop-types
forwardedRef: PropTypes.oneOfType([PropTypes.func, PropTypes.shape({current: PropTypes.any})]),
}; |
|
Thanks @parasharrajat 😄 - Updated! |
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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.
toggleReportand notonIconClick). - 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 Copylabel 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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
Avataris modified, I verified thatAvataris 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
ScrollViewcomponent to make it scrollable when more elements are added to the page. - If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
cc: @chiragsalian
🎀 👀 🎀 C+ reviewed
|
We did not find an internal engineer to review this PR, trying to assign a random engineer to #16144... Please reach out for help on Slack if no one gets assigned! |
|
Aha, @yuwenmemon there is a lint issue. |
|
Thanks, fixed! |
|
Bump @chiragsalian |
|
@parasharrajat We've entered a feature freeze internally at Expensify until next week so I think this will unfortunately have to wait until after for now |
|
Feature freeze is overrrrrrrrr Merging |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚀 Deployed to staging by https://github.com/yuwenmemon in version: 1.3.35-0 🚀
|
|
🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.35-5 🚀
|
1 similar comment
|
🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.35-5 🚀
|
Details
Fixed Issues
$ #16144
Tests
Offline tests
QA Steps
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)/** comment above it */thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor)thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Web
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android