fix(autocomplete): controlled state logic

[chirokas]

Closes #2955

📝 Description

Revise autocomplete controlled state logic.

⛳️ 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

• Bug Fixes
  • Improved the autocomplete functionality to better handle controlled state scenarios.
  • Enhanced the logic to update the selected key and input value only when necessary, ensuring more accurate behavior in autocomplete features.

[changeset-bot]

🦋 Changeset detected

Latest commit: 06dbf22

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

This PR includes changesets to release 2 packages

Name	Type
@nextui-org/autocomplete	Patch
@nextui-org/react	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

[vercel]

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	May 24, 2024 9:36pm

[vercel]

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

A member of the Team first needs to authorize it.

[coderabbitai]

Warning

Rate Limit Exceeded

@jrgarciadev has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 56 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 0839b0a and 06dbf22.

Walkthrough

This update introduces a crucial patch to the @nextui-org/autocomplete package, specifically addressing an issue where the autocomplete component fails to update its selection when the labels and keys of the items are identical. The patch modifies the logic in the useAutocomplete function to ensure the component's state updates correctly under these conditions.

Changes

File Path	Change Summary
.changeset/proud-moles-fix.md	Introduced a patch for the @nextui-org/autocomplete package to fix issues with the controlled state and autocomplete functionality.
.../autocomplete/__tests__/autocomplete.test.tsx	Added AutocompleteProps to imports and introduced a ControlledAutocomplete function component for testing.
.../autocomplete/src/use-autocomplete.ts	Added a condition in useAutocomplete to check the item's existence and its text value against the state's input value before setting the selected key and input value.

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Change Autocomplete selection when labels and keys are the same (#2955)	✅
Ensure labels and keys being the same doesn't affect autocomplete behavior (#2955)	✅

The modifications in the useAutocomplete function directly tackle the issue described, ensuring that the component behaves as expected even when labels and keys are identical, thus meeting the objectives laid out in the linked 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

• 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>.
  • 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/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]

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 633f9d2 and 0839b0a.

Files selected for processing (3)

• .changeset/proud-moles-fix.md (1 hunks)
• packages/components/autocomplete/tests/autocomplete.test.tsx (3 hunks)
• packages/components/autocomplete/src/use-autocomplete.ts (1 hunks)

Files skipped from review due to trivial changes (1)

• .changeset/proud-moles-fix.md

Additional comments not posted (3)

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

51-63: The ControlledAutocomplete component is well-implemented for testing controlled behavior.

---

268-290: The test case "should work when key equals textValue (controlled)" is correctly implemented to verify the component's behavior in a controlled environment.

packages/components/autocomplete/src/use-autocomplete.ts (1)

311-311: The modification to the condition in useAutocomplete correctly prevents unnecessary state updates when the labels and keys are identical.

[jrgarciadev]

Thanks! @chirokas