nextui icon indicating copy to clipboard operation
nextui copied to clipboard

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

Open abhisektomar1 opened this issue 1 year ago • 5 comments

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

  • Closes #3251.

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.

abhisektomar1 avatar Jun 26 '24 10:06 abhisektomar1

🦋 Changeset detected

Latest commit: 35f54edcba6c248ffbf8d05d495146c05c125776

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

changeset-bot[bot] avatar Jun 26 '24 10:06 changeset-bot[bot]

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 Jul 6, 2024 2:20pm

vercel[bot] avatar Jun 26 '24 10:06 vercel[bot]

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

A member of the Team first needs to authorize it.

vercel[bot] avatar Jun 26 '24 10:06 vercel[bot]

Walkthrough

The useInfiniteScroll hook in packages/hooks/use-infinite-scroll/src/index.ts was updated to enhance performance and fix the issue of multiple fetches. The function now includes a loadMore callback using useCallback to handle data loading under specific conditions and introduces a debounce mechanism with useRef to avoid redundant calls. Additionally, an IntersectionObserver was integrated to trigger data loading when scrolling near the bottom of the content.

Changes

File Change Summary
packages/hooks/use-infinite-scroll/src/index.ts Updated to include loadMore callback and debounce mechanism, introduced IntersectionObserver for triggering data loads, improved performance to prevent redundant fetches.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Hook
    participant Observer
    participant API

    User ->> Hook: Initialize useInfiniteScroll
    Hook ->> Observer: Create IntersectionObserver
    Observer ->> Hook: Observe scroll position
    Hook ->> Hook: Check condition and debounce
    Hook ->> API: Fetch data
    API -->> Hook: Return data
    Hook -->> User: Update data state

Assessment against linked issues

Objective (Issue #3251) Addressed Explanation
Prevent multiple fetches on initial load
Implement a debounce mechanism to avoid redundant calls

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.

coderabbitai[bot] avatar Jun 26 '24 10:06 coderabbitai[bot]

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?

abhisektomar1 avatar Jun 27 '24 05:06 abhisektomar1