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(tabs): After the global style is changed, an error is reported in the UI screenshot of tabs. #80

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

chenxi-20
Copy link
Collaborator

@chenxi-20 chenxi-20 commented Oct 15, 2024

PR

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

  • Tests
    • Introduced a new test case for capturing UI screenshots of the tabs component in various positions.

@chenxi-20 chenxi-20 added the bug Something isn't working label Oct 15, 2024
Copy link

coderabbitai bot commented Oct 15, 2024

Walkthrough

The changes introduce a new test case in the tests/tabs/xdesign.spec.ts file for the tabs component. The test, titled '各个位置--UI截图', focuses on capturing UI screenshots for different tab positions. It includes setting up a page error handler, navigating to a specific URL, verifying the visibility of the demo element, and capturing screenshots for various tab positions after user interactions.

Changes

File Change Summary
tests/tabs/xdesign.spec.ts Added a new test case '各个位置--UI截图' to capture UI screenshots for different tab positions.

Possibly related PRs

  • test: add tabs UI e2e test #46: This PR adds end-to-end tests for the tabs UI component, which directly relates to the main PR that introduces a new test case for the tabs component in the same file (tests/tabs/xdesign.spec.ts).

Suggested reviewers

  • zzcr

Poem

In the land of tabs, where we play,
New tests are hopping in today!
With screenshots bright, and positions right,
Our UI shines, a lovely sight!
So let’s click and cheer, it’s time to sway! 🐇✨


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

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

🧹 Outside diff range and nitpick comments (1)
tests/tabs/xdesign.spec.ts (1)

55-71: Good test structure, consider these enhancements

The new test case for different tab positions is well-structured and covers important scenarios. Here are some suggestions to improve its robustness:

  1. Consider adding a test for the 'top' position to ensure all possible positions are covered.
  2. Add explicit waits or assertions after changing positions to ensure the UI has updated before taking screenshots. This can prevent flaky tests.
  3. Verify that the tab position has actually changed before taking screenshots. This could be done by checking a specific CSS property or class that indicates the position.

Here's a suggested enhancement to the test case:

test('各个位置--UI截图', async ({ page }) => {
  page.on('pageerror', (exception) => expect(exception).toBeNull())
  await page.goto('tabs#position')
  const demo = page.locator('#position .pc-demo .tiny-tabs')
  await expect(demo).toBeInViewport()

  // Helper function to change position and verify
  async function changePositionAndCapture(position: string) {
    await page.locator('label').filter({ hasText: `${position} 显示` }).click()
    await expect(demo).toHaveAttribute('data-position', position)
    await expect(demo).toBeInViewport()
    await expect(demo).toHaveScreenshot(`${position}.png`)
  }

  // Test all positions
  await expect(demo).toHaveAttribute('data-position', 'left')
  await expect(demo).toHaveScreenshot('left.png')

  await changePositionAndCapture('top')
  await changePositionAndCapture('bottom')
  await changePositionAndCapture('right')
}

This enhancement adds a test for the 'top' position, includes a wait for the position to change (assuming there's a data-position attribute), and uses a helper function to reduce code duplication.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6fcf6a9 and 9a71b3e.

⛔ Files ignored due to path filters (18)
  • tests/tabs/xdesign.spec.ts-snapshots/basic-usage-chromium-win32.png is excluded by !**/*.png
  • tests/tabs/xdesign.spec.ts-snapshots/basic-usage-click-chromium-win32.png is excluded by !**/*.png
  • tests/tabs/xdesign.spec.ts-snapshots/bottom-chromium-win32.png is excluded by !**/*.png
  • tests/tabs/xdesign.spec.ts-snapshots/left-chromium-win32.png is excluded by !**/*.png
  • tests/tabs/xdesign.spec.ts-snapshots/more-show-all-btn-hover-chromium-win32.png is excluded by !**/*.png
  • tests/tabs/xdesign.spec.ts-snapshots/more-show-all-chromium-win32.png is excluded by !**/*.png
  • tests/tabs/xdesign.spec.ts-snapshots/more-show-all-click-chromium-win32.png is excluded by !**/*.png
  • tests/tabs/xdesign.spec.ts-snapshots/right-chromium-win32.png is excluded by !**/*.png
  • tests/tabs/xdesign.spec.ts-snapshots/size-chromium-win32.png is excluded by !**/*.png
  • tests/tabs/xdesign.spec.ts-snapshots/size-hover-0-chromium-win32.png is excluded by !**/*.png
  • tests/tabs/xdesign.spec.ts-snapshots/size-hover-1-chromium-win32.png is excluded by !**/*.png
  • tests/tabs/xdesign.spec.ts-snapshots/size-hover-2-chromium-win32.png is excluded by !**/*.png
  • tests/tabs/xdesign.spec.ts-snapshots/tabs-second-layer-chromium-win32.png is excluded by !**/*.png
  • tests/tabs/xdesign.spec.ts-snapshots/tabs-second-layer-currency-chromium-win32.png is excluded by !**/*.png
  • tests/tabs/xdesign.spec.ts-snapshots/tabs-second-layer-hover-chromium-win32.png is excluded by !**/*.png
  • tests/tabs/xdesign.spec.ts-snapshots/tabs-second-layer-selected-chromium-win32.png is excluded by !**/*.png
  • tests/tabs/xdesign.spec.ts-snapshots/tabs-separator-chromium-win32.png is excluded by !**/*.png
  • tests/tabs/xdesign.spec.ts-snapshots/tabs-separator-hover-chromium-win32.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • tests/tabs/xdesign.spec.ts (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
tests/tabs/xdesign.spec.ts (1)

55-71: Overall, good addition to the test suite

This new test case for different tab positions is a valuable addition to the test suite. It aligns well with the PR objectives of addressing UI issues related to tabs. The test covers multiple positions and includes user interactions, which will help catch potential regressions in the tab positioning functionality.

While the test is generally well-structured, implementing the suggested enhancements would further improve its reliability and coverage. Great job on expanding the test coverage!

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.

1 participant