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

fix(table): resolve double fetch issue in useInfiniteScroll hook #3332

Open
wants to merge 3 commits into
base: canary
Choose a base branch
from

Conversation

abhisektomar1
Copy link

@abhisektomar1 abhisektomar1 commented Jun 26, 2024

Summary

Resolved the issue where the useInfiniteScroll hook was fetching data twice on initial render. This fix ensures that data is fetched only once during initial render and additional data is fetched upon scrolling.

Issue

Changes

  • Updated useInfiniteScroll hook to prevent double fetching.
  • Verified the fix by testing the component and ensuring only one initial fetch.

Closes #

📝 Description

I use isLoadingRef to prevent concurrent load calls, implements a debounced loadMore function with useCallback, and simplifies the IntersectionObserver logic.
The hook now handles both loader-based and scroll-based detection more efficiently, using debounce for scroll events. I also improved cleanup for the IntersectionObserver and better TypeScript typing. These changes collectively make the hook more robust, reducing issues like multiple simultaneous loads and excessive re-renders, while providing a smoother infinite scrolling experience

⛳️ Current behavior (updates)

Table useInfiniteScroll hook fetches twice

🚀 New behavior

  • Updated useInfiniteScroll hook to prevent double fetching.

💣 Is this a breaking change (Yes/No):

No

📝 Additional Information

Summary by CodeRabbit

  • New Features
    • Improved infinite scroll performance with a new loadMore callback mechanism.
    • Added a debounce feature to prevent multiple data load requests in a short time frame.

Copy link

changeset-bot bot commented Jun 26, 2024

🦋 Changeset detected

Latest commit: f8c7b6e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@nextui-org/use-infinite-scroll Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Jun 26, 2024

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

Name Status Preview Comments Updated (UTC)
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 26, 2024 10:53am

Copy link

vercel bot commented Jun 26, 2024

@abhisektomar1 is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Jun 26, 2024

Warning

Rate limit exceeded

@abhisektomar1 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 35 minutes and 45 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 044b3f9 and f8c7b6e.

Walkthrough

The useInfiniteScroll function has been updated to address a bug where it was fetching data twice initially. Changes involve refactoring the logic to include a loadMore callback using useCallback, and adding a debounce mechanism to prevent multiple calls within a short timeframe.

Changes

File(s) Summary of Changes
packages/hooks/use-infinite-scroll/src/index.ts Updated to include a loadMore callback using useCallback, refactored the onLoadMore trigger logic, and added a debounce mechanism to prevent multiple calls within a short time frame. Modified imports and function signatures accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant Component as Component
    participant useInfiniteScroll as useInfiniteScroll
    participant loadMoreCallback as loadMoreCallback
    participant onLoadMore as onLoadMore
    
    Component ->> useInfiniteScroll: invoke()
    useInfiniteScroll ->> loadMoreCallback: create with useCallback
    loadMoreCallback ->> onLoadMore: invoke if conditions met
    onLoadMore ->> Component: load more data
    
    Note over loadMoreCallback: Added debounce to prevent multiple calls
Loading

Assessment against linked issues

Objective Addressed Explanation
Resolve initial loadMore invocation without scrolling (#3251)
Prevent multiple data fetches in quick succession (#3251)

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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: 1

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 720f2f5 and 0a6cdb8.

Files selected for processing (1)
  • packages/hooks/use-infinite-scroll/src/index.ts (3 hunks)
Additional context used
Biome
packages/hooks/use-infinite-scroll/src/index.ts

[error] 85-100: This else clause can be omitted because previous branches break early. (lint/style/noUselessElse)

Unsafe fix: Omit the else clause.

Additional comments not posted (6)
packages/hooks/use-infinite-scroll/src/index.ts (6)

2-2: Imports look good.

The addition of useCallback supports the new debounced loadMore function, aligning with the PR objectives.


43-51: Effective use of useCallback and concurrency control in loadMore.

This implementation effectively prevents double fetching and ensures that loadMore is not recreated unnecessarily, which aligns with the PR objectives to optimize infinite scroll behavior.


66-66: Optimized IntersectionObserver setup.

The new IntersectionObserver setup uses improved options, including a root margin based on the distance prop and a lower threshold, which better handles the trigger for loading more content.

Also applies to: 69-75, 78-78


80-84: Proper cleanup for IntersectionObserver.

The cleanup logic properly disconnects the observer when the component unmounts or is no longer needed, preventing potential memory leaks and ensuring resource efficiency.


86-98: Optimized scroll-based loading logic with debounce.

The debounced event listener for scroll events is a good optimization, preventing excessive loading triggers and enhancing performance during rapid scrolling.


103-103: Appropriate return values for external interaction.

Returning loaderRef and scrollContainerRef allows for external manipulation and interaction, which is essential for the hook's functionality in various scenarios.

packages/hooks/use-infinite-scroll/src/index.ts Outdated Show resolved Hide resolved
Copy link
Member

@wingkwong wingkwong left a comment

Choose a reason for hiding this comment

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

since you've modified code inside packages, please add a changeset file. The content should be like this.

---
"@nextui-org/use-infinite-scroll": patch
---

fix(table): resolve double fetch issue in useInfiniteScroll hook (#3251)

@wingkwong wingkwong changed the title fix(table): resolve double fetch issue in useInfiniteScroll hook (fix #3251) fix(table): resolve double fetch issue in useInfiniteScroll hook Jun 26, 2024
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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0a6cdb8 and 044b3f9.

Files selected for processing (1)
  • packages/hooks/use-infinite-scroll/src/index.ts (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/hooks/use-infinite-scroll/src/index.ts

@abhisektomar1
Copy link
Author

I noticed that there's a test failure related to the NextUI.Input component inside an Autocomplete component. However, my changes were only to the useInfiniteScroll hook and didn't touch these components. This seems to be a pre-existing issue in the test suite. Could someone from the maintenance team please advise on how to proceed?

@wingkwong wingkwong added this to the v2.4.3 milestone Jun 27, 2024
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.

[BUG] - Table useInfiniteScroll hook fetches twice
3 participants