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: lazyMotion forwardRef issue #2622

Merged

Conversation

wingkwong
Copy link
Member

@wingkwong wingkwong commented Apr 1, 2024

Closes #

📝 Description

  • fixed lazy motion issue in ripple
  • include tests (accordion, modal, navbar, tab, tooltip)

⛳️ Current behavior (updates)

Please describe the current behavior that you are modifying

🚀 New behavior

Please describe the behavior or changes this PR adds

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

📝 Additional Information

Summary by CodeRabbit

  • Tests
    • Improved testing in components (Accordion, Dropdown, Modal, Navbar, Popover, Tabs) to enhance stability and prevent errors during user interactions.
  • Bug Fixes
    • Addressed issues in various components to ensure error-free behavior.
  • Documentation
    • Documented improvements for a specific component related to forwardRef handling.

Copy link

changeset-bot bot commented Apr 1, 2024

🦋 Changeset detected

Latest commit: 3830c6e

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

This PR includes changesets to release 9 packages
Name Type
@nextui-org/ripple Patch
@nextui-org/button Patch
@nextui-org/card Patch
@nextui-org/react Patch
@nextui-org/autocomplete Patch
@nextui-org/dropdown Patch
@nextui-org/popover Patch
@nextui-org/select Patch
@nextui-org/snippet 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
Contributor

coderabbitai bot commented Apr 1, 2024

Walkthrough

The recent updates focus on enhancing component testing across various UI elements like Accordions, Dropdowns, Modals, Navbars, Popovers, and Tabs. These improvements include adding spies to monitor console errors, particularly regarding refs in function components, and introducing test cases to ensure error-free interactions. Additionally, a minor functionality change in the Ripple component involves a structural adjustment. A patch is also introduced to address a specific issue related to forwardRef in the LazyMotion component.

Changes

File Path Change Summary
.../__tests__/accordion.test.tsx Added a spy to check for console errors related to refs when unmounting.
.../__tests__/dropdown.test.tsx Added a test case to verify no errors occur when clicking a button within the dropdown.
.../__tests__/modal.test.tsx Implemented a spy on console.error for warnings about function components not being given refs, and added an assertion on the spy call count.
.../__tests__/navbar.test.tsx Added a mock for window.scrollTo and a test case to ensure no errors after a toggle click.
.../__tests__/popover.test.tsx Added a test case to ensure no errors when clicking the trigger button.
.../__tests__/tabs.test.tsx Introduced a spy on console.error to ensure a specific error message is not logged.
.../src/ripple.tsx Wrapped the <m.span> element inside an additional empty fragment in the Ripple component.
.changeset/chilled-horses-type.md Introduced a patch for "@nextui-org/ripple" to fix the LazyMotion forwardRef issue.

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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/coderabbit-overrides.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

vercel bot commented Apr 1, 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 Apr 2, 2024 9:37am

Copy link

vercel bot commented Apr 1, 2024

@wingkwong 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 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 Status

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between c188e4d and ec88153.
Files selected for processing (9)
  • .changeset/chilled-horses-type.md (1 hunks)
  • packages/components/accordion/tests/accordion.test.tsx (1 hunks)
  • packages/components/dropdown/tests/dropdown.test.tsx (1 hunks)
  • packages/components/modal/tests/modal.test.tsx (2 hunks)
  • packages/components/navbar/tests/navbar.test.tsx (2 hunks)
  • packages/components/popover/tests/popover.test.tsx (1 hunks)
  • packages/components/ripple/src/ripple.tsx (1 hunks)
  • packages/components/tabs/tests/tabs.test.tsx (2 hunks)
  • packages/components/tooltip/tests/tooltip.test.tsx (1 hunks)
Additional comments not posted (9)
.changeset/chilled-horses-type.md (1)

5-5: The changeset description is clear and concise, directly addressing the issue fixed. Note that "LazyMotion" and "forwardRef" are specific terms related to the library's functionality, not spelling errors.

packages/components/ripple/src/ripple.tsx (1)

29-56: Wrapping the <m.span> element in a fragment is a valid approach to address specific React rendering issues. Ensure comprehensive testing, especially focusing on the component's behavior in various use cases, to confirm that no unintended side effects are introduced.

packages/components/tooltip/__tests__/tooltip.test.tsx (1)

17-31: The test case implementation for spying on console.error is correct and follows best practices. Consider adding a comment detailing the specific error message expected not to occur, enhancing the test's clarity and maintainability.

packages/components/modal/__tests__/modal.test.tsx (1)

5-14: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [8-26]

The test case for spying on console.error is correctly implemented. To improve clarity, consider adding a comment that specifies the exact error message this test aims to ensure does not occur, thereby enhancing the test's readability and purpose.

packages/components/popover/__tests__/popover.test.tsx (1)

23-48: The test case for ensuring no error is thrown when clicking the trigger button is correctly implemented. To enhance clarity and maintainability, consider adding a comment detailing the specific error message this test aims to ensure does not occur.

packages/components/navbar/__tests__/navbar.test.tsx (2)

14-14: Mocking window.scrollTo is a good practice to avoid issues in tests that involve scrolling behavior. Ensure that this mock is only used in tests where scrolling behavior is not being explicitly tested.


58-92: The test case for ensuring no error is thrown after a toggle click is correctly implemented. Consider adding comments to clarify the purpose of the test and the specific error message this test aims to ensure does not occur, enhancing the test's readability and purpose.

packages/components/tabs/__tests__/tabs.test.tsx (1)

31-40: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [34-56]

The test case for spying on console.error is correctly implemented. To improve clarity, consider adding a comment that specifies the exact error message this test aims to ensure does not occur, thereby enhancing the test's readability and purpose.

packages/components/accordion/__tests__/accordion.test.tsx (1)

10-24: The test case for ensuring no console error related to refs in function components is correctly implemented. To enhance clarity and maintainability, consider adding a comment detailing the specific error message this test aims to ensure does not occur.

packages/components/dropdown/__tests__/dropdown.test.tsx Outdated Show resolved Hide resolved
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 Status

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between ec88153 and 3830c6e.
Files selected for processing (7)
  • packages/components/accordion/tests/accordion.test.tsx (2 hunks)
  • packages/components/dropdown/tests/dropdown.test.tsx (2 hunks)
  • packages/components/modal/tests/modal.test.tsx (2 hunks)
  • packages/components/navbar/tests/navbar.test.tsx (2 hunks)
  • packages/components/popover/tests/popover.test.tsx (2 hunks)
  • packages/components/tabs/tests/tabs.test.tsx (2 hunks)
  • packages/components/tooltip/tests/tooltip.test.tsx (2 hunks)
Files skipped from review as they are similar to previous changes (7)
  • packages/components/accordion/tests/accordion.test.tsx
  • packages/components/dropdown/tests/dropdown.test.tsx
  • packages/components/modal/tests/modal.test.tsx
  • packages/components/navbar/tests/navbar.test.tsx
  • packages/components/popover/tests/popover.test.tsx
  • packages/components/tabs/tests/tabs.test.tsx
  • packages/components/tooltip/tests/tooltip.test.tsx

@jrgarciadev jrgarciadev merged commit 2e49e08 into nextui-org:main Apr 2, 2024
7 of 8 checks passed
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.

None yet

2 participants