Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom emoji picker performance improvement #1408

Merged
merged 3 commits into from
Dec 20, 2024
Merged

Conversation

lourou
Copy link
Member

@lourou lourou commented Dec 20, 2024

  • Increased debounce delay for better performance
  • Reset immediately when input is cleared
  • Reset bigBold text preset not to use xs font size (bottom sheet drawer title)

Summary by CodeRabbit

  • New Features
    • Enhanced emoji picker functionality with improved filtering and user input handling.
  • Bug Fixes
    • Adjusted emoji filtering behavior to provide default emojis when the search input is empty.
  • Style
    • Simplified the styling of the bigBold text preset.

@lourou lourou requested a review from a team as a code owner December 20, 2024 10:53
Copy link
Contributor

coderabbitai bot commented Dec 20, 2024

Walkthrough

The pull request introduces modifications to two files in the design system and conversation features. In the Text.presets.ts file, the bigBold preset's styling has been simplified by removing the textSizeStyles.xs component. In the emoji picker component, changes have been made to improve emoji filtering, including adjusting the filtering threshold, increasing debounce time, and modifying the behavior when the search input is empty.

Changes

File Change Summary
design-system/Text/Text.presets.ts Simplified bigBold preset by removing textSizeStyles.xs
features/conversation/conversation-message/.../conversation-message-context-menu-emoji-picker.tsx Enhanced emoji filtering logic with modified search behavior, debounce time, and matching threshold

Poem

🐰 A Rabbit's Ode to Code Refinement 🎨

Presets trimmed with surgical grace,
Emojis dance at a gentler pace,
Filtering magic, now smooth and light,
Code evolves with pixel-perfect might!

Hop hop hooray! 🌟

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
features/conversation/conversation-message/conversation-message-context-menu/conversation-message-context-menu-emoji-picker/conversation-message-context-menu-emoji-picker.tsx (2)

90-93: Consider adding a comment explaining the debounce delay choice.

The increase to 300ms is a good balance between responsiveness and performance. However, it would be helpful to add a comment explaining why this specific value was chosen.

 debounce((value: string) => {
   const filtered = filterEmojis(value);
   setFilteredReactions(filtered);
   setHasInput(value.length > 0);
+  // 300ms provides optimal balance between responsiveness and performance
 }, 300),

89-94: Consider adding cleanup for debounced function.

To prevent potential memory leaks, consider cleaning up the debounced function when the component unmounts.

+ useEffect(() => {
+   return () => {
+     // Cleanup the debounced function
+     debouncedFilter.clear?.();
+   };
+ }, [debouncedFilter]);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 44f3996 and eddb73d.

📒 Files selected for processing (2)
  • design-system/Text/Text.presets.ts (1 hunks)
  • features/conversation/conversation-message/conversation-message-context-menu/conversation-message-context-menu-emoji-picker/conversation-message-context-menu-emoji-picker.tsx (2 hunks)
🔇 Additional comments (3)
design-system/Text/Text.presets.ts (1)

35-35: Verify the impact on bottom sheet drawer titles.

The removal of textSizeStyles.xs from the bigBold preset makes it more consistent with its name. However, since this preset is used for bottom sheet drawer titles, we should verify the visual impact.

✅ Verification successful

The previous ast-grep pattern didn't work because it was looking for JSX/TSX syntax in a specific format. Let's try a broader search using ripgrep to find any usage of "bigBold" in the codebase, which will help us verify its usage in bottom sheet drawer titles or anywhere else.


Let's try a simpler ripgrep search without file type specifications since the tsx extension isn't recognized. This will help us find all occurrences of "bigBold" in the codebase.


The removal of textSizeStyles.xs from bigBold preset is safe

The search results confirm that the bigBold preset is indeed used in BottomSheetHeader.tsx for titles, along with several examples in Text.example.tsx. The typography configuration in theme/typography.ts shows that the bigBold style already has its own fontSize (24) and lineHeight (34) defined, which means removing textSizeStyles.xs from the preset is actually correcting a conflict where an extra-small size was being incorrectly mixed with a style meant to be big and bold.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for components using the bigBold preset in bottom sheet titles
ast-grep --pattern 'Text preset="bigBold"' 

Length of output: 44


Script:

#!/bin/bash
# Search for usage of bigBold preset in TypeScript/JavaScript files
rg -l "bigBold" --type ts --type tsx --type js --type jsx

# Show the content of files containing "bigBold"
rg "bigBold" -C 3 --type ts --type tsx --type js --type jsx

Length of output: 173


Script:

#!/bin/bash
# Search for files containing "bigBold" using basic ripgrep
rg -l "bigBold"

# Show the content with context
rg "bigBold" -C 3

Length of output: 3975

features/conversation/conversation-message/conversation-message-context-menu/conversation-message-context-menu-emoji-picker/conversation-message-context-menu-emoji-picker.tsx (2)

49-56: Performance improvement in emoji filtering.

Good optimization! The changes improve performance by:

  1. Avoiding unnecessary slicing when input is empty
  2. Using a less strict threshold for matching, which provides better fuzzy search results

99-105: Good UX improvement with immediate reset.

Excellent change! The immediate reset when clearing input provides better user feedback, while still maintaining debounced filtering for non-empty inputs. This is a good balance between responsiveness and performance.

Copy link
Contributor

Performance Comparison Report

  • Current: 3177d74 - 2024-12-20 10:58:48Z
  • Baseline: release/3.0.0 (44f3996) - 2024-12-20 10:57:26Z

Significant Changes To Duration

There are no entries

Meaningless Changes To Duration

Show entries
Name Type Duration Count
Avatar Image 10 runs render 1.2 ms → 1.4 ms (+0.2 ms, +16.7%) 🔴 1 → 1
Avatar Image 50 runs render 1.1 ms → 1.1 ms (-0.0 ms, -3.6%) 1 → 1
Empty Avatar 10 runs render 0.9 ms → 0.8 ms (-0.1 ms, -11.1%) 1 → 1
Empty Avatar 50 runs render 0.7 ms → 0.7 ms (-0.0 ms, -5.6%) 1 → 1
Text Component with color prop - 10 runs render 0.0 ms → 0.2 ms (+0.2 ms, +Infinity%) 🔴 1 → 1
Text Component with default props - 10 runs render 0.3 ms → 0.3 ms 1 → 1
Text Component with translation key - 10 runs render 0.5 ms → 0.2 ms (-0.3 ms, -60.0%) 🟢 1 → 1
Text Component with weight and size - 10 runs render 0.5 ms → 0.2 ms (-0.3 ms, -60.0%) 🟢 1 → 1
Show details
Name Type Duration Count
Avatar Image 10 runs render Baseline
Mean: 1.2 ms
Stdev: 0.4 ms (35.1%)
Runs: 1 1 1 1 1 2 1 2 1 1
Warmup runs: 2

Current
Mean: 1.4 ms
Stdev: 0.5 ms (36.9%)
Runs: 1 2 2 1 1 2 1 2 1 1
Warmup runs: 2
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:
Avatar Image 50 runs render Baseline
Mean: 1.1 ms
Stdev: 0.3 ms (27.5%)
Runs: 1 1 1 1 1 1 1 1 2 2 1 1 1 1 2 1 1 1 1 1 1 1 1 2 1 1 2 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
Warmup runs: 1

Current
Mean: 1.1 ms
Stdev: 0.3 ms (29.6%)
Runs: 1 1 1 2 1 1 1 1 1 1 2 1 1 1 1 1 1 1 1 1 0 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 2 1 1 1 1 1 1 2 1 1 1 1 1 1
Warmup runs: 1
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
Render issues:

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
Render issues:
Empty Avatar 10 runs render Baseline
Mean: 0.9 ms
Stdev: 0.3 ms (35.1%)
Runs: 1 1 1 0 1 1 1 1 1 1
Warmup runs: 3

Current
Mean: 0.8 ms
Stdev: 0.4 ms (52.7%)
Runs: 1 1 0 1 1 1 1 1 0 1
Warmup runs: 3
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:
Empty Avatar 50 runs render Baseline
Mean: 0.7 ms
Stdev: 0.5 ms (63.0%)
Runs: 1 1 1 0 1 1 0 1 1 1 1 0 1 0 1 0 1 0 1 1 1 1 1 0 1 1 1 1 1 0 0 1 1 1 1 1 0 0 1 1 1 1 1 1 1 0 1 1 0 0
Warmup runs: 1

Current
Mean: 0.7 ms
Stdev: 0.5 ms (69.3%)
Runs: 1 1 1 1 0 1 1 0 1 1 0 0 1 1 1 0 1 0 1 0 0 0 1 0 1 1 1 0 0 1 1 1 1 1 1 0 0 1 1 1 1 1 1 0 1 1 1 0 1 1
Warmup runs: 1
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
Render issues:

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
Render issues:
Text Component with color prop - 10 runs render Baseline
Mean: 0.0 ms
Stdev: 0.0 ms (NaN%)
Runs: 0 0 0 0 0 0 0 0 0 0
Warmup runs: 0

Current
Mean: 0.2 ms
Stdev: 0.4 ms (210.8%)
Runs: 1 1 0 0 0 0 0 0 0 0
Warmup runs: 0
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:
Text Component with default props - 10 runs render Baseline
Mean: 0.3 ms
Stdev: 0.5 ms (161.0%)
Runs: 0 0 0 1 0 0 1 0 0 1
Warmup runs: 1

Current
Mean: 0.3 ms
Stdev: 0.5 ms (161.0%)
Runs: 1 1 0 1 0 0 0 0 0 0
Warmup runs: 1
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:
Text Component with translation key - 10 runs render Baseline
Mean: 0.5 ms
Stdev: 0.5 ms (105.4%)
Runs: 1 0 1 0 0 1 0 1 0 1
Warmup runs: 1

Current
Mean: 0.2 ms
Stdev: 0.4 ms (210.8%)
Runs: 0 0 0 0 1 0 0 1 0 0
Warmup runs: 1
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:
Text Component with weight and size - 10 runs render Baseline
Mean: 0.5 ms
Stdev: 0.5 ms (105.4%)
Runs: 0 1 0 1 0 1 0 1 1 0
Warmup runs: 0

Current
Mean: 0.2 ms
Stdev: 0.4 ms (210.8%)
Runs: 1 0 0 0 0 0 1 0 0 0
Warmup runs: 0
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:

Render Count Changes

There are no entries

Render Issues

There are no entries

Added Scenarios

There are no entries

Removed Scenarios

There are no entries

Generated by 🚫 dangerJS against eddb73d

@lourou lourou merged commit 229402f into release/3.0.0 Dec 20, 2024
6 checks passed
@lourou lourou deleted the lr/emoji-picker-perf branch December 20, 2024 13:06
@lourou lourou mentioned this pull request Dec 20, 2024
45 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants