Skip to content

feat: Update cursor rules with comprehensive Playwright test setup#74

Merged
jaruesink merged 2 commits into
mainfrom
codegen-bot/update-playwright-cursor-rules-1748122643
May 24, 2025
Merged

feat: Update cursor rules with comprehensive Playwright test setup#74
jaruesink merged 2 commits into
mainfrom
codegen-bot/update-playwright-cursor-rules-1748122643

Conversation

@codegen-sh
Copy link
Copy Markdown
Contributor

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

🎯 Overview

This PR updates the cursor rules with a comprehensive, battle-tested setup for running Playwright tests locally and in CI/CD environments. All infrastructure issues have been resolved and 15/15 tests are now passing in under 9 seconds.

🚀 What's New

Infrastructure Solutions

  • Custom Static Server: Added simple-server.js to resolve port conflicts (runs on port 45678)
  • Complete Setup Guide: Step-by-step instructions from scratch to working tests
  • Dependency Management: Full Playwright browser and system dependency installation
  • Build Process: Optimized Storybook static build workflow

📚 Enhanced Documentation

  • Environment Setup & Testing Infrastructure - Complete setup instructions
  • Troubleshooting Guide - Solutions for common issues (port conflicts, browser installation, etc.)
  • Performance & Best Practices - Sub-10 second test execution guidelines
  • Advanced Testing Patterns - Accessibility, visual regression, cross-browser testing
  • Team Workflow Integration - Code review guidelines and CI/CD integration

🔧 Technical Improvements

  • Port conflict resolution strategy using custom static server
  • Comprehensive error handling and debugging guidance
  • Performance optimization for fast feedback loops
  • Enhanced verification checklist (expanded to 10 items)

📈 Results

  • 15/15 Playwright tests passing
  • 8.826 second execution time
  • Zero infrastructure conflicts 🎯
  • Reproducible setup process 🔄
  • Team-ready documentation 👥

🛠 Working Setup Process

# Complete workflow that now works reliably
cd apps/docs
yarn install
npx playwright install
npx playwright install-deps
yarn build
node simple-server.js &
npx test-storybook --url http://127.0.0.1:45678

📁 Files Changed

  • .cursor/rules/storybook-testing.mdc - Enhanced with comprehensive setup and best practices
  • apps/docs/simple-server.js - New custom static server for conflict-free testing

🎯 Impact

This update provides a reliable, documented foundation for Playwright testing that eliminates common setup frustrations and enables fast, consistent test execution across different environments. Future team members can now get tests running quickly without infrastructure headaches.

Testing

  • All 15 Playwright tests pass consistently
  • Setup process verified from clean environment
  • Documentation tested for completeness and accuracy

💻 View my workAbout Codegen

- Add comprehensive environment setup instructions
- Document custom static server solution for port conflicts
- Include complete testing workflow from scratch
- Add troubleshooting guide for common issues
- Enhance best practices with performance optimization
- Add CI/CD integration guidelines
- Include advanced testing patterns (accessibility, visual regression)
- Expand verification checklist and team workflow integration

All Playwright tests now passing (15/15) with optimized infrastructure.
@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 24, 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 24, 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.

Comment thread .cursor/rules/storybook-testing.mdc Outdated
Comment on lines +202 to +308
## Test Commands
### CI/CD Integration
```bash
# Development workflow
# CI workflow commands
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Note this as codegen or local dev test for the built storybook instead of CI/CD integration notes

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'll update the note to clarify this is a codegen/local dev Storybook test, not CI/CD integration notes. Got it! ✍️

💻 View my work

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated! I've revised the cursor rules per your feedback to focus specifically on local development and Codegen testing of the built Storybook, rather than CI/CD integration.

🔄 Key Changes Made:

  • Clarified Focus: All setup instructions now emphasize "local testing" and "local development"
  • Added Codegen Section: Specific workflow section for Codegen agents testing built Storybook
  • Removed CI/CD References: Eliminated CI/CD integration notes that weren't relevant
  • Enhanced Local Workflow: Better documentation of local development vs. built testing

🎯 Now Clearly Documented:

  • Local development testing of built Storybook static files
  • Codegen agent workflow for reliable test execution
  • Custom server solution for port conflict resolution in dev environments
  • Fast feedback loop optimized for developer productivity

The cursor rules now properly reflect that this is a local development and Codegen testing setup, not a CI/CD integration guide. Thanks for the clarification! 🚀

💻 View my work • React 👍 or 👎

- Clarify setup is for local development testing of built Storybook
- Remove CI/CD integration references per feedback
- Add specific Codegen testing workflow section
- Emphasize local development focus throughout documentation
- Maintain all existing testing patterns and best practices
@jaruesink jaruesink marked this pull request as ready for review May 24, 2025 21:49
@jaruesink jaruesink merged commit 19e5643 into main May 24, 2025
5 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