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.

Sign up for GitHub

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

Jump to bottom

fix(e2e): Finetune local timeout #17397

Merged
merged 2 commits into from
Mar 5, 2025
Merged

fix(e2e): Finetune local timeout #17397

merged 2 commits into from
Mar 5, 2025

Conversation

Vere-Grey
Copy link
Contributor

@Vere-Grey Vere-Grey commented Mar 4, 2025 •
edited
Loading

We had local test run timeout set to 1m. But some of our tests' runs average on 45s.
Add to that Solana slower network, busy machine where the test is run and you can get to a point where test timeouts while it didn't encounter any fatal problems

Increasing the local timeout by 30s to 90s but introducing actionTimeout of 15s. That way we wont have to wait way too much time on fail but we provide enough time for the local runs

Additionally adding option to override test timeout by .env variable TEST_TIMEOUT_OVERRIDE

@Vere-Grey Vere-Grey self-assigned this Mar 4, 2025
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Mar 4, 2025 •
edited
Loading

Walkthrough

The changes involve modifications to the timeout configuration in the end-to-end test setup within the playwright.config.ts file. The constant timeoutCIRun has been renamed to CI_TIMEOUT, and timeoutLocalRun has been renamed to LOCAL_TIMEOUT, with the latter updated from 1000 * 60 to 1000 * 90. A new function, getTimeout, has been introduced to determine the timeout value based on environment variables. The timeout property in the configuration object now calls this function instead of the constants directly. Additionally, a new property named actionTimeout has been added to the use configuration object, set to 1000 * 15. In the documentation, a new instruction regarding test timeouts has been added, and the section about artifacts on CI has been removed. An environment variable TEST_TIMEOUT_OVERRIDE has also been introduced in the example environment file.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 69e68b1 and 8ae4cd0.

📒 Files selected for processing (3)
  • docs/tests/e2e-playwright-suite.md (1 hunks)
  • packages/suite-desktop-core/.example.env (1 hunks)
  • packages/suite-desktop-core/e2e/playwright.config.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/suite-desktop-core/e2e/playwright.config.ts
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build-web
  • GitHub Check: Setup and Cache Dependencies
  • GitHub Check: Analyze with CodeQL (javascript)
🔇 Additional comments (3)
packages/suite-desktop-core/.example.env (2)

2-3: Clear and helpful documentation update.

The comment now explicitly states that the passphrase is mandatory, which improves clarity for users setting up the environment.

5-6: Good addition of timeout override option.

This new environment variable aligns perfectly with the PR objective of fine-tuning test timeouts. The clear explanation of its purpose and optional nature provides developers with flexibility for local test development.

docs/tests/e2e-playwright-suite.md (1)

73-74: Well-documented timeout configuration option.

This instruction clearly explains how to override the timeout settings when local test runs exceed the default limit. It's a valuable addition that aligns with the PR objective of fine-tuning timeouts for local environments, and it provides the necessary details about where to make the change and the need to restart the UI runner.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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.

@HajekOndrej HajekOndrej self-requested a review March 4, 2025 16:32
@Vere-Grey
fix(e2e): Finetune local run timeout
69e68b1 
Increase to 90s
Introduces actionTimeout of 15s
@Vere-Grey Vere-Grey force-pushed the fix/suite-desktop-core/unity-pw-e2e-timeout branch from 043a5da to 69e68b1 Compare March 5, 2025 07:13
@Vere-Grey Vere-Grey changed the title fix(e2e): Unite e2e test timeout to 3m fix(e2e): Finetune local timeout Mar 5, 2025
@Vere-Grey Vere-Grey merged commit d9685a0 into develop Mar 5, 2025
28 checks passed
@Vere-Grey Vere-Grey deleted the fix/suite-desktop-core/unity-pw-e2e-timeout branch March 5, 2025 09:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@HajekOndrej HajekOndrej HajekOndrej approved these changes

Assignees

@Vere-Grey Vere-Grey

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Vere-Grey @HajekOndrej