fix: 💄 Add new chart event onDataPointHover that triggers only on data point change

[EnricoBarbieri1997]

Current onCrosshairMove triggers multiple times for small mouse movements even if the mouse is kept on the same data point. Added an event that triggers only when the logical data point id changes

What is the purpose of the change:

Fixes an "infinite render" that in reality was an hover event triggered each millisecond the mouse was hovering the element instead of triggering on enter

Linear Task

https://linear.app/osmosis/issue/FE-1272/fix-infinite-rendering-of-portfolio-chartheader-in-osmosis-fe

Brief Changelog

• Create new higher level event in the Chart base component
• Used said event for historical-chart and portfolio historical chart

Notes

The other charts did not display such an issue because they update a mobx store that was filtering rerenders when no data was changed. That said it is best to implement this new event at the base chart and use it for future components to avoid such issues in the future

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
osmosis-frontend	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 11, 2024 1:50pm

4 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
osmosis-frontend-datadog	⬜️ Ignored (Inspect)			Dec 11, 2024 1:50pm
osmosis-frontend-dev	⬜️ Ignored (Inspect)			Dec 11, 2024 1:50pm
osmosis-frontend-edgenet	⬜️ Ignored (Inspect)			Dec 11, 2024 1:50pm
osmosis-testnet	⬜️ Ignored (Inspect)			Dec 11, 2024 1:50pm

[coderabbitai]

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/web/components/chart/historical-chart.tsx

Oops! Something went wrong! :(

ESLint: 8.50.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/packages/web/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

This pull request introduces modifications across three chart components: HistoricalChart, HistoricalVolumeChart, and Chart. The primary change involves renaming the onCrosshairMove prop to onDataPointHover, which updates the event handling for mouse interactions with the charts. The new prop retains existing functionality while improving naming clarity. Additionally, the Chart component sees the introduction of an internal callback to manage hover events more effectively. Overall, the changes enhance interactivity while keeping the components' structures intact.

Changes

File Path	Change Summary
packages/web/components/chart/historical-chart.tsx	Renamed onCrosshairMove prop to onDataPointHover in HistoricalChartProps interface.
packages/web/components/chart/historical-volume-chart.tsx	Renamed onCrosshairMove prop to onDataPointHover in HistoricalVolumeChartProps interface.
packages/web/components/chart/light-weight-charts/chart.tsx	Added onDataPointHover prop to ChartProps interface and updated internal logic for hover events. Renamed onCrosshairMove to onCrosshairMoveInternal.

Possibly related PRs

• feat(portfolio-page---empty-wallet-edge-case): handle empty wallet st… #3908: The onCrosshairMove prop is renamed to onDataPointHover in both the HistoricalChart and HistoricalVolumeChart components, indicating a direct relationship in the handling of hover events across chart components.
• Fix layout shift when nav to Portfolio page w collapsed chart #3926: The changes in the PortfolioPage include enhancements to the chart's interactivity, which aligns with the updates made to the onDataPointHover prop in the main PR, suggesting a focus on improving user interactions with charts.

Suggested reviewers

• MaxMillington
• JoseRFelix

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2ed6cc5 and 707a223.

📒 Files selected for processing (3)

• packages/web/components/chart/historical-chart.tsx (1 hunks)
• packages/web/components/chart/historical-volume-chart.tsx (1 hunks)
• packages/web/components/chart/light-weight-charts/chart.tsx (4 hunks)

🔇 Additional comments (5)

packages/web/components/chart/light-weight-charts/chart.tsx (3)

200-200: LGTM! Well-named prop addition.

The new onDataPointHover prop is well-typed and its name clearly describes its purpose.

---

217-230: LGTM! Efficient implementation of hover state tracking.

The implementation effectively solves the infinite render issue by:

1. Using useRef to track the last hovered point without causing re-renders
2. Only triggering onDataPointHover when the logical index changes

---

248-248: LGTM! Proper event handler initialization.

The chart initialization correctly uses the new internal callback, ensuring consistent event handling.

packages/web/components/chart/historical-volume-chart.tsx (1)

Line range hint 98-107: LGTM! Clean adoption of the new event handler.

The component correctly implements the new onDataPointHover prop while maintaining the existing event handling logic.

packages/web/components/chart/historical-chart.tsx (1)

Line range hint 124-133: LGTM! Clean adoption of the new event handler.

The component correctly implements the new onDataPointHover prop while maintaining the existing event handling logic.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Experiment)
• @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.