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(e2e): [tooltip,select] fix the security that causes e2e test failures. #2743

Merged
merged 3 commits into from
Jan 6, 2025

Conversation

shenjunjian
Copy link
Collaborator

@shenjunjian shenjunjian commented Jan 6, 2025

PR

1、修复popper文件中,出现ResizeObserver造成测试失败
2、修复select示例中,中文和数字添加了空格, 造成测试失败。
3、修复select嵌套树时,不需要select去过滤。

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Bug Fixes

    • Improved input handling for dropdown grid component, requiring specific input patterns for correct behavior.
    • Enhanced resize observer initialization for better browser compatibility.
    • Optimized query change handling for tree-type select components to prevent redundant processing.
  • Refactor

    • Simplified code for resize observer checks.
    • Streamlined query change function logic.

Copy link

coderabbitai bot commented Jan 6, 2025

Warning

Rate limit exceeded

@shenjunjian has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 37 minutes and 41 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

Reviewing files that changed from the base of the PR and between 3a04d3b and b94c3a5.

📒 Files selected for processing (1)
  • packages/vue-common/src/breakpoint.ts (1 hunks)

Walkthrough

The pull request encompasses changes across multiple files, focusing on input handling and component initialization. In the test file for a dropdown grid component, input fill operations have been modified to require specific space characters. The Popper dependency initialization has been updated to check for ResizeObserver support more robustly. Additionally, the select component's handleQueryChange function now includes an early return mechanism for tree-type render scenarios, preventing potential filtering errors.

Changes

File Change Summary
examples/sites/demos/pc/app/select/nest-grid-remote.spec.ts Modified input fill operations to require two spaces or a single space in test cases
packages/renderless/src/common/deps/popper.ts Enhanced ResizeObserver initialization with additional type checking
packages/renderless/src/select/index.ts Added early return logic for Tree render type in handleQueryChange function
packages/vue-common/src/breakpoint.ts Updated createMatchMedia to check if matchMedia is a function before returning a mock object

Possibly related PRs

Suggested labels

e2e-test

Suggested reviewers

  • zzcr

Poem

🐰 In the realm of code, where spaces dance,
Two hops instead of one, a testing chance!
Resize and filter, with rabbit-like grace,
Our components now leap at a different pace.
A sprinkle of magic, a touch of delight,
Code evolves softly in the coder's moonlight! 🌙


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.

CodeRabbit Configuration 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.

@github-actions github-actions bot added the bug Something isn't working label Jan 6, 2025
Copy link

Walkthrough

This PR addresses issues causing e2e test failures by making three key fixes: 1) Adjusting the ResizeObserver in the popper file to prevent test failures, 2) Correcting spacing issues in the select example that affected tests, and 3) Modifying select behavior in nested trees to avoid unnecessary filtering.

Changes

Files Changed Summary
examples/sites/demos/pc/app/select/nest-grid-remote.spec.ts Adjusted spacing in test inputs to match new example requirements.
packages/renderless/src/common/deps/popper.ts Updated ResizeObserver initialization to check for function existence.
packages/renderless/src/select/index.ts Added condition to prevent unnecessary filtering in nested tree selects.

entry.target.popperVm.update()
}
const resizeOb =
isBrowser && typeof ResizeObserver === 'function'

Choose a reason for hiding this comment

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

Ensure that ResizeObserver is supported in the environment to prevent runtime errors. This change adds a check for the existence of ResizeObserver before instantiation.

@zzcr zzcr changed the title fix(e2e): fix the security that causes e2e test failures. fix(e2e): [tooltip] fix the security that causes e2e test failures. Jan 6, 2025
Copy link

github-actions bot commented Jan 6, 2025

[e2e-test-warn]
The component to be tested is missing.

The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".

Please make sure you've read our contributing guide

@zzcr zzcr changed the title fix(e2e): [tooltip] fix the security that causes e2e test failures. fix(e2e): [tooltip,select] fix the security that causes e2e test failures. Jan 6, 2025
Copy link

@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 (3)
examples/sites/demos/pc/app/select/nest-grid-remote.spec.ts (3)

63-64: Provide context for " " usage.
It's not immediately clear why a single space matches all rows while two spaces match no rows. Consider adding an explanatory comment or constant clarifying this behavior to ease future maintenance.


83-83: Maintain consistency in test data input.
The duplication of await input.fill(' ' + ' ') across multiple tests suggests that a test helper function could reduce repetition and clearly convey intent.


131-131: Document reason for two spaces.
As with lines 63-64, clarify the decision to use two spaces for empty data results. This ensures test maintainability if the underlying product logic changes or extends.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a76d9d1 and 5491414.

📒 Files selected for processing (3)
  • examples/sites/demos/pc/app/select/nest-grid-remote.spec.ts (3 hunks)
  • packages/renderless/src/common/deps/popper.ts (1 hunks)
  • packages/renderless/src/select/index.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: PR Unit Test
  • GitHub Check: PR E2E Test (pnpm test:e2e3)
🔇 Additional comments (3)
examples/sites/demos/pc/app/select/nest-grid-remote.spec.ts (1)

88-88: Ensure stable test coverage.
If ' ' (single space) is expected to match some data, confirm that this won't conflict with future changes or added rows. A single space can often be fragile as a matching pattern in real-world use cases.

packages/renderless/src/select/index.ts (1)

219-224: Validate early return for Tree render type.
These lines prevent the default query filtering logic from running after tree-based filters. While this may prevent double-filter errors, ensure that no other side effects (e.g. additional event emissions or data transformations) were intended to occur in defaultOnQueryChange.

packages/renderless/src/common/deps/popper.ts (1)

277-286: Guarded usage of ResizeObserver looks good.
Checking for typeof ResizeObserver === 'function' avoids runtime errors in unsupported browsers. Verify that the fallback behavior (i.e., null) gracefully degrades.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants