Skip to content

Fix Bazza UI Filter Tests - Comprehensive Test Improvements#75

Merged
jaruesink merged 3 commits into
feature/bazza-ui-filtersfrom
codegen-bot/fix-bazza-ui-filter-tests-1748226517
May 26, 2025
Merged

Fix Bazza UI Filter Tests - Comprehensive Test Improvements#75
jaruesink merged 3 commits into
feature/bazza-ui-filtersfrom
codegen-bot/fix-bazza-ui-filter-tests-1748226517

Conversation

@codegen-sh
Copy link
Copy Markdown
Contributor

@codegen-sh codegen-sh Bot commented May 26, 2025

Overview

This PR addresses test failures in the Bazza UI filter tests by implementing comprehensive fixes and improvements based on cursor rules and best practices.

Changes Made

✅ Fixed Issues

  1. Pagination Component: Added navigation role and aria-label for accessibility
  2. Pagination Props: Enabled pagination prop on both server-side and client-side DataTable components
  3. Page Count Calculation: Fixed pageCount calculation for client-side filtering
  4. Accessibility: Added proper aria-labels to pagination buttons
  5. Navigation Handlers: Fixed pagination and sorting handlers to use setSearchParams consistently

🔧 Test Improvements

  1. Portal Content Handling: Added screen import from @storybook/test to handle portal-rendered content
  2. Timing Improvements: Increased wait times for filter value controller rendering
  3. Multiple Approaches: Implemented fallback strategies for finding filter options:
    • Text-based search
    • Role-based search
    • Content matcher functions
  4. Error Handling: Added try-catch blocks for robust test execution

📋 Current Status

  • 18 tests passing
  • 3 tests still failing ⚠️ (filter dropdown interaction)

🔍 Remaining Investigation

The filter dropdown tests are still failing because the "Todo" option cannot be found. This appears to be related to:

  • Portal rendering of dropdown content
  • Timing of filter value controller rendering
  • Possible differences in how CommandItem elements are rendered vs. expected

🎯 Next Steps

  1. Further investigate the DataTableFilter component structure
  2. Review how CommandItem elements are rendered and accessible
  3. Consider alternative test approaches based on actual DOM structure
  4. Potentially simplify the test to focus on core functionality

Testing

  • All existing tests continue to pass
  • Filter accessibility tests pass
  • Pagination and basic functionality tests pass
  • Only the complex filter interaction tests remain to be resolved

References

  • Followed cursor rules from .cursor/rules/storybook-testing.mdc
  • Used patterns from working dropdown-menu-select.stories.tsx
  • Applied best practices for portal content testing

💻 View my workAbout Codegen

codegen-sh Bot added 2 commits May 26, 2025 02:35
- Add navigation role and aria-label to DataTablePagination component
- Enable pagination prop on both server-side and client-side DataTable components
- Fix pageCount calculation for client-side filtering
- Add proper aria-labels to pagination buttons for better accessibility

This fixes the failing tests that were looking for pagination controls with role='navigation'.
… approaches

- Import screen from @storybook/test for portal content
- Increase wait time for filter value controller to render
- Try multiple approaches to find Todo option (text, role, content matcher)
- Fix pagination and sorting handlers to use setSearchParams
- Add better error handling for filter option selection

Still investigating why filter dropdown options are not being found in tests.
@bolt-new-by-stackblitz
Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 26, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Join our Discord community for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in this 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.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 26, 2025

📝 Storybook Preview: View Storybook

This preview will be updated automatically when you push new changes to this PR.

Note: The preview will be available after the workflow completes and the PR is approved for deployment.

Copy link
Copy Markdown
Contributor

@jaruesink jaruesink left a comment

Choose a reason for hiding this comment

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

@codegen-sh

I think adding the following decorator to SimpleFilterTest will help it render

decorators: [
withReactRouterStubDecorator({
routes: [
{
path: '/',
Component: SimpleDataTableFilterTest,
},
],
}),
],

I'll review adding the decorator to SimpleFilterTest! 🔍

💻 View my work

- Added withReactRouterStubDecorator to SimpleFilterTest story to fix useLocation() error
- Defined testSimpleFilter function that was missing
- Added proper routing configuration for SimpleDataTableFilterTest component

This should resolve the 'useLocation() may be used only in the context of a <Router> component' error and the 'testSimpleFilter is not defined' error.
@codegen-sh
Copy link
Copy Markdown
Contributor Author

codegen-sh Bot commented May 26, 2025

Perfect suggestion! 🎯 I've added the React Router decorator to the SimpleFilterTest story as you recommended. This should fix the "useLocation() may be used only in the context of a component" error.

Changes made:

  • Added withReactRouterStubDecorator with proper route configuration for SimpleDataTableFilterTest
  • Defined the missing testSimpleFilter function that was causing reference errors
  • Updated the story configuration to use the decorator properly

The decorator setup you suggested:

decorators: [
  withReactRouterStubDecorator({
    routes: [
      {
        path: '/',
        Component: SimpleDataTableFilterTest,
      },
    ],
  }),
],

This should resolve the Router context issue and allow the SimpleFilterTest to run properly. The changes have been pushed to the existing PR #75.

🔄 Updated PR #75 with your suggested fix!

💻 View my work • React 👍 or 👎

@jaruesink jaruesink marked this pull request as ready for review May 26, 2025 03:01
@jaruesink jaruesink merged commit 3e8b670 into feature/bazza-ui-filters May 26, 2025
4 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.

1 participant