test(docs-e2e): add mobile and tablet tests for docs site

JeremyFriesenGitHub commented 2 months ago

Added mobile and tablet layout tests (by following a similar suite of tests for desktop)
Needed to use Playwright Codegen (had to use the page variable instead of docsLayoutPage) for specific interactions with elements that are unavailable to desktop (i.e., hamburger icon, 3 dots, etc.)
Used beforeEach tests as well to properly initialize mobile and tablet layouts
Updated docs home page Edit on GitHub button href in order to run successful tests for that link

Summary by Sourcery

Add mobile and tablet layout tests for the documentation site using Playwright, ensuring compatibility and functionality across different device sizes. Update the 'Edit on GitHub' button href to facilitate successful test execution.

New Features:

Introduce mobile and tablet layout tests for the documentation site using Playwright.

Enhancements:

Update the 'Edit on GitHub' button href on the docs home page to ensure successful test execution.

Tests:

Add comprehensive test suites for mobile and tablet layouts, including checks for page titles, header elements, and interactive components like the hamburger icon and search functionality.

Summary by CodeRabbit

New Features
- Enhanced test reliability with automatic retries for flaky tests.
- Added new device-specific project configurations for improved clarity.
- Introduced a utility function for streamlined navigation in tests.
- Expanded UI element management for mobile and tablet interfaces in the documentation layout.
- Improved test execution workflow with separate commands for each test suite and enhanced reporting capabilities.
Bug Fixes
- Corrected URL paths in documentation links to ensure accurate navigation.
Documentation
- Improved test suite organization for better coverage across mobile, tablet, and desktop views.

netlify[bot] commented 2 months ago

Deploy Preview for cuhacking-docs failed.

Name	Link
Latest commit	4a2b55907cc93a8e9a0c7420144cd5c3cd9556c7
Latest deploy log	https://app.netlify.com/sites/cuhacking-docs/deploys/66d0e7de9787f4000849dd7f

sourcery-ai[bot] commented 2 months ago

Reviewer's Guide by Sourcery

This pull request adds mobile and tablet layout tests for the docs site. It extends the existing test suite to cover responsive design elements and interactions specific to smaller screen sizes. The changes include new test cases for mobile and tablet layouts, updates to existing tests, and modifications to accommodate different viewport sizes.

File-Level Changes

Change	Details	Files
Added mobile layout tests	Implemented tests for mobile header elements Added tests for hamburger icon functionality Created tests for mobile-specific page elements Included viewport size adjustments for mobile tests	`apps/docs-e2e/src/docs.spec.ts`
Added tablet layout tests	Implemented tests for tablet header elements Added tests for 3-dots icon functionality Created tests for tablet-specific page elements Included viewport size adjustments for tablet tests	`apps/docs-e2e/src/docs.spec.ts`
Updated constant definitions and URLs	Added new constants for various URLs Updated existing URL constants	`apps/docs-e2e/src/docs.spec.ts`
Modified 'Edit on GitHub' button functionality	Updated the href attribute to correctly point to the file in the GitHub repository	`apps/docs/src/app/docs/[[...slug]]/page.tsx`

Tips

- Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.

netlify[bot] commented 2 months ago

Deploy Preview for cuhacking-portal-dev failed. Why did it fail? →

Name	Link
Latest commit	1569eb2fb6fa7ef6aa89cf23451073cc16449adb
Latest deploy log	https://app.netlify.com/sites/cuhacking-portal-dev/deploys/66db7d6ec4f0a40008ac8494

MFarabi619 commented 2 months ago

@JeremyFriesenGitHub

Kebab case filenames please
The docs commit should be of type fix instead. Because you didn't add documentation, but rather fixed the broken button that appears on all pages.

HasithDeAlwis commented 2 months ago

@MFarabi619 any idea why the e2e tests timeout during the pipeline?

MFarabi619 commented 2 months ago

Great stuff

I like the screen size prefix for the tests

In the future you can also do this at a config level and have it show up as a project, that way it won't pollute your test names

JeremyFriesenGitHub commented 2 months ago

@sourcery-ai review

coderabbitai[bot] commented 2 months ago

[!WARNING]

Rate limit exceeded

@JeremyFriesenGitHub has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 21 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](https://coderabbit.ai/docs/faq) for further information.

Commits
Files that changed from the base of the PR and between 539609678f65759ed538629c1a581ba983b85402 and 1569eb2fb6fa7ef6aa89cf23451073cc16449adb.

Walkthrough

The changes involve updates to the Playwright configuration for enhanced test reliability and clarity, including the addition of retry logic and renaming browser projects to specify device types. The test suite for the documentation layout has been reorganized to improve coverage across mobile, tablet, and desktop views. A new navigation utility function has been introduced, alongside adjustments to the GitHub Actions workflow for better test management.

Changes

Files	Change Summary
`apps/docs-e2e/playwright.config.ts`	Added `retries: 2` for test retries; renamed browser projects to indicate device types; added a WebKit tablet project.
`apps/docs-e2e/src/docs.spec.ts`	Introduced `clickAndGoToPage` helper function; reorganized tests by device type; updated test descriptions and logic for skipping tests.
`.github/workflows/TEST_e2e.yml`	Increased test job timeout from 5 minutes to 10 minutes; separated test commands for each suite with HTML reporting; added unique names for report uploads.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TestSuite
    participant ClickAndGoToPage

    User->>TestSuite: Initiate Test
    TestSuite->>ClickAndGoToPage: Call Function
    ClickAndGoToPage->>User: Simulate Button Click
    ClickAndGoToPage->>TestSuite: Wait for New Page
    TestSuite->>User: Test Results

Poem

🐰 In the meadow, hops a rabbit bright,
With changes afoot, oh what a delight!
Tests now retry, with clarity they play,
Mobile and desktop, all in a ballet.
Hooray for the helpers, the paths now align,
A joyful leap forward, all will be fine! 🌼

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

cuhacking / 2025