feat(driver): add timeout diagnostics and async vite loader #33022
+848
−8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ormance - Replace fs.readFileSync with async fs.readFile - Add proper error handling with debug logs - Improve performance by avoiding event loop blocking - Remove TODO comment about async fs methods This follows Node.js best practices and improves DX with faster build times.
- Replace fs.readFileSync with promisified fs.readFile for async operation - Implement lazy initialization with getLoaderPromise() to prevent unhandled promise rejections - Add proper blank lines to satisfy padding-line-between-statements ESLint rule - Maintain proper error handling with try/catch blocks
- Add catch handler to reset promise on failure for retry capability - Address Cursor Bot feedback about unhandled promise rejection - Maintain lazy initialization to prevent unnecessary promise creation - Improve error recovery for init file loading
Add smart diagnostic suggestions for timeout errors to improve DX
- Created TimeoutDiagnostics module with contextual error analysis
- Detects common timeout patterns:
* Dynamic/loading content selectors
* Complex and fragile selectors
* Dynamic ID selectors
* Network-related delays
* Animation issues
* Excessive DOM mutations
- Provides actionable suggestions with docs links
- Includes comprehensive test coverage (17 tests)
- Fully documented with examples and integration guide
Benefits:
- Reduces debugging time for developers
- Provides inline education about best practices
- Decreases frustration with clearer error messages
- Reduces support questions about timeouts
Example output:
`
cy.get() timed out waiting 4000ms
Diagnostic Suggestions:
1. The selector appears to target dynamic/loading content
a) Wait for the loading state to complete
b) Consider using data-cy attributes
c) Use cy.intercept() to wait for API requests
Learn more: https://on.cypress.io/best-practices
`
Related: Timeout errors are one of the most common issues users face
Fix critical bugs identified by Cursor Bot code review:
1. **Missing body tag handling in Vite plugin**
- Added check for missing </body> tag (lastIndexOf returns -1)
- Prevents malformed HTML with script at wrong position
- Gracefully appends script at end if body tag not found
- Added debug logging for missing body tag case
2. **Contradictory loading content suggestion**
- Fixed confusing suggestion for loading selectors
- Now suggests waiting for loading to disappear THEN get content
- Provides alternative to wait for API request
- Clarifies when user actually needs the loading element itself
3. **Unescaped quotes in generated code suggestions**
- All selectors now properly escaped before interpolation
- Prevents syntax errors like: cy.get('[data-test='value']')
- Correctly generates: cy.get('[data-test=\\'value\\']')
- Applied to all suggestion types (dynamic, complex, ID, general)
Test coverage:
- Added tests for quote escaping in selectors
- Verified proper handling of special characters
- All 19 tests passing
- Lint checks passing
Before:
- cy.get('[data-test='value']') // SYNTAX ERROR
After:
- cy.get('[data-test=\\'value\\']') // VALID
Related: Security and code quality improvements
Collaborator
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
|
|
lucgonp
force-pushed
the
feat/vite-with-timeout-backup
branch
from
a2372b4 to
5a0954b
Compare
lucgonp
force-pushed
the
feat/vite-with-timeout-backup
branch
from
1bcece7 to
3cc25e5
Compare
lucgonp
force-pushed
the
feat/vite-with-timeout-backup
branch
from
3cc25e5 to
2b93731
Compare
lucgonp
force-pushed
the
feat/vite-with-timeout-backup
branch
from
39864da to
3544244
Compare
lucgonp
force-pushed
the
feat/vite-with-timeout-backup
branch
from
8bc0ebb to
5e45cf4
Compare
lucgonp
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Additional details
Steps to test
How has the user experience changed?
PR Tasks
cypress-documentation?type definitions?Note
Introduces intelligent timeout diagnostics (with tests/docs) and updates the Vite dev server plugin to asynchronously and robustly load/inject the init script.
packages/driver/src/cypress/timeout_diagnostics.tsproviding contextual suggestions for timeout errors (analyze,formatSuggestions,enhanceTimeoutError).packages/driver/test/unit/cypress/timeout_diagnostics.spec.tscovering patterns, escaping, formatting, and edge cases.TIMEOUT_DIAGNOSTICS_README.mdexplaining features, API, and examples.npm/vite-dev-server/src/plugins/cypress.tsto readinitCypressTests.jsandindex.htmlvia async I/O with lazy, retryableloaderPromiseand improved error handling.<script>injection (handles missing</body>), and minor logging/cleanup.Written by Cursor Bugbot for commit 48815f6. This will update automatically on new commits. Configure here.