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

test(input): input interaction tests #4579

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

Conversation

Peterl561
Copy link
Contributor

@Peterl561 Peterl561 commented Jan 17, 2025

Closes #

📝 Description

  • test for user keyboard inputs
  • test for user highlighting content
  • test for click focus
  • added some missing act wrappers

⛳️ Current behavior (updates)

no changes

🚀 New behavior

no changes

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

No

📝 Additional Information

Summary by CodeRabbit

  • Tests
    • Enhanced input component test coverage
    • Added test cases for:
      • Keyboard input handling
      • Text highlighting with multi-clicks
      • Input focus on click
    • Improved test robustness by using act function for event handling

Copy link

changeset-bot bot commented Jan 17, 2025

⚠️ No Changeset found

Latest commit: 8236cc1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link

vercel bot commented Jan 17, 2025

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

Name Status Preview Comments Updated (UTC)
heroui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 17, 2025 5:24am
heroui-sb ❌ Failed (Inspect) Jan 17, 2025 5:24am

Copy link
Contributor

coderabbitai bot commented Jan 17, 2025

Walkthrough

The pull request introduces enhancements to the Input component's test suite in input.test.tsx. The changes focus on improving test coverage for user interactions, including keyboard input handling, text highlighting, and input focus behaviors. The modifications involve adding new test cases and refining existing tests by using the act function to ensure proper state management during testing. The core objective is to validate the robustness of the Input component's interaction mechanisms.

Changes

File Change Summary
packages/components/input/__tests__/input.test.tsx - Added test for keyboard input handling
- Implemented test for text highlighting with multi-clicks
- Added test for input focus on click
- Modified onFocus event handler test to use act function
- Simplified ref value update test

Sequence Diagram

sequenceDiagram
    participant User
    participant InputComponent
    participant TestEnvironment

    User->>InputComponent: Type characters
    InputComponent-->>TestEnvironment: Capture keyboard input
    
    User->>InputComponent: Multi-click to highlight
    InputComponent-->>TestEnvironment: Verify text selection
    
    User->>InputComponent: Click on input/wrapper
    InputComponent-->>TestEnvironment: Verify focus state
Loading

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>, 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. (Beta)
  • @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.

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.

@@ -138,8 +216,6 @@ describe("Input", () => {

ref.current!.value = value;

container.querySelector("input")?.focus();
Copy link
Contributor Author

@Peterl561 Peterl561 Jan 17, 2025

Choose a reason for hiding this comment

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

This test is a little dubious since it only passed because the state change caused by .focus() didn't happen until after the test finished as it wasn't wrapped by act. Any interaction with the input will reset input.value.

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

🧹 Nitpick comments (5)
packages/components/input/__tests__/input.test.tsx (5)

140-142: Replace act(focus()) with user.click().

For consistency and better simulation of real user behavior, use user.click() instead of directly calling focus().

-act(() => {
-  input.focus();
-});
+await user.click(input);

133-153: Consider adding more keyboard interaction tests.

The test could be more comprehensive by including:

  • Copy/paste operations
  • Selection with Shift+Arrow keys
  • Home/End key navigation

155-172: Add double-click text selection test.

The comment mentions that double-click selects the word, but this behavior isn't tested. Consider adding a test case for double-click word selection.

 // in react testing library, input dblClick selects the word/symbol, tripleClick selects the entire text
+await user.dblClick(input);
+expect(window.getSelection()?.toString()).toBe("Hello");  // Assumes cursor is at start
+await user.keyboard("Hi");
+expect(input.value).toBe("Hi World!");

 await user.tripleClick(input);

178-179: Use getByTestId instead of querySelector.

For more reliable and maintainable tests, prefer getByTestId over querySelector when selecting elements.

-const innerWrapper = document.querySelector("[data-slot='inner-wrapper']") as HTMLDivElement;
-const inputWrapper = document.querySelector("[data-slot='input-wrapper']") as HTMLDivElement;
+const innerWrapper = getByTestId("inner-wrapper") as HTMLDivElement;
+const inputWrapper = getByTestId("input-wrapper") as HTMLDivElement;

187-205: Reduce code duplication in blur verification.

Extract the repeated blur verification pattern into a helper function to improve maintainability.

+const verifyBlur = (input: HTMLInputElement) => {
+  act(() => {
+    input.blur();
+  });
+  expect(document.activeElement).not.toBe(input);
+};

 await user.click(input);
 expect(document.activeElement).toBe(input);
-act(() => {
-  input.blur();
-});
-expect(document.activeElement).not.toBe(input);
+verifyBlur(input);

 await user.click(innerWrapper);
 expect(document.activeElement).toBe(input);
-act(() => {
-  input.blur();
-});
-expect(document.activeElement).not.toBe(input);
+verifyBlur(input);
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 85913a8 and 8236cc1.

📒 Files selected for processing (1)
  • packages/components/input/__tests__/input.test.tsx (1 hunks)
🔇 Additional comments (2)
packages/components/input/__tests__/input.test.tsx (2)

123-128: LGTM! Proper use of act for focus management.

The changes correctly wrap focus/blur operations with act, ensuring that all state updates are processed before assertions.


210-210: LGTM! Good cleanup.

Removing the unnecessary container query simplifies the test without affecting its effectiveness.

@wingkwong wingkwong modified the milestones: v2.6.15, v2.7.0 Jan 21, 2025
@wingkwong wingkwong self-assigned this Jan 25, 2025
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.

2 participants