internal: (studio) improve error reporting #31546
Open
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
ryanthemanuel
changed the title
cypress
|
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress
|
| Branch Review |
ryanm/feat/errors
|
| Run status |
|
| Run duration | 18m 44s |
| Commit |
|
| Committer | Ryan Manuel |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
9
|
Pending
|
1232
|
Skipped
|
0
|
Passing
|
32140
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
46.31%
|
|
|---|---|
|
Untested elements
|
184
|
|
Tested elements
|
163
|
Accessibility
92.63%
|
|
|---|---|
|
Failed rules
|
3 critical
8 serious
2 moderate
2 minor
|
|
Failed elements
|
887
|
There was a problem hiding this comment.
Pull Request Overview
This PR improves error reporting for studio by integrating cloud-based error notifications and updating existing API interfaces and test cases accordingly.
- Updated error reporting to call the cloud API when studio is initialized, falling back to an app-only version when it isn’t.
- Added a new studioHash option and revised import paths across the codebase.
- Updated tests to verify the new error reporting flow and refactored imports to reflect the new folder structure.
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/gulp/tasks/gulpCloudDeliveredTypes.ts | Updated import path for studio manager |
| scripts/after-pack-hook.js | Updated import path for getAndInitializeStudioManager |
| packages/types/src/studio/studio-server-types.ts | Extended interface with studioHash and reportError method |
| packages/server/test/unit/* | Revised tests to assert the new error reporting behavior |
| packages/server/lib/cloud/studio.ts | Modified reportError to delegate to the studio server’s error reporter |
| packages/server/lib/cloud/api/studio/* | Updated error reporting implementation and import paths |
| packages/server/lib/cloud/api/studio/get_and_initialize_studio_manager.ts | Adjusted error handling to use the new error reporting API |
mschile
reviewed
Apr 22, 2025
| import type { StudioCloudApi } from '@packages/types/src/studio/studio-server-types' | ||
| import Debug from 'debug' | ||
|
|
||
| const debug = Debug('cypress:server:cloud:api:studio:report_studio_errors') |
There was a problem hiding this comment.
Suggested change
| const debug = Debug('cypress:server:cloud:api:studio:report_studio_errors') | |
| const debug = Debug('cypress:server:cloud:api:studio:report_studio_error') |
mschile
approved these changes
Apr 22, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This PR sets up communication with studio in the cloud so that we can be notified when errors occur. Specifically it:
reportErrorto call out to the cloud if studio has been initialized<cloud-url>/studio/errorsstudioHashto the studio options so that version can properly be reportedSteps to test
How has the user experience changed?
PR Tasks
cypress-documentation?type definitions?