chore: use cloud validations for packages/server api request/response types #32632
Conversation
cypress
|
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress
|
| Branch Review |
chore/use-api-typedefs
|
| Run status |
|
| Run duration | 19m 19s |
| Commit |
|
| Committer | Cacie Prins |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
2
|
Flaky
|
13
|
Pending
|
1102
|
Skipped
|
4
|
Passing
|
26711
|
| View all changes introduced in this branch ↗︎ | |
Warning
Partial Report: The results for the Application Quality reports may be incomplete.
UI Coverage
45.27%
|
|
|---|---|
|
Untested elements
|
186
|
|
Tested elements
|
158
|
Accessibility
97.97%
|
|
|---|---|
|
Failed rules
|
4 critical
8 serious
2 moderate
2 minor
|
|
Failed elements
|
101
|
Tests for review
commands/files.cy.js • 1 failed test • 5x-driver-firefox
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
| .catch((err: any) => { | ||
| onError(err) | ||
|
|
||
| return responseDidFail |
There was a problem hiding this comment.
do we no longer need this logic?
There was a problem hiding this comment.
It's still there, just without the boolean flag. This "hanging" behavior is further down in the catch block that BugBot is complaining about.
| "dev": "node index.js", | ||
| "docker": "cd ../.. && WORKING_DIR=/packages/server ./scripts/run-docker-local.sh", | ||
| "postinstall": "patch-package", | ||
| "postinstall": "patch-package && yarn sync-cloud-validations", |
There was a problem hiding this comment.
if we are doing this at the package level, do we still need to call it in CI after the build? Would be nice to get rid of this https://github.com/cypress-io/cypress/blob/develop/.circleci/src/pipeline/@pipeline.yml#L201
There was a problem hiding this comment.
That's a fully separate cloud validations download, combining them was out of scope for this
2 participants
Additional details
System tests currently fetch typescript definitions and example payloads for API endpoints when they run. This ensures our api calls are supported properly by the server.
This adds the same functionality to packages/server, so we can make sure our api functions use up-to-date typedefs from Cypress Cloud
Steps to test
How has the user experience changed?
PR Tasks
cypress-documentation?type definitions?Note
Switches server API request/response typing to Cloud-provided validations and adds a script/workflow to sync those typedefs; updates related call sites and error handling.
lib/cloud/api/create_instance.tsandlib/cloud/api/index.ts(e.g.,PostRun*,PostInstance*,PutInstance*).createRun,createInstance,postInstanceTests,postInstanceResults,updateInstanceStdout,updateInstanceArtifacts).testingType._postInstanceTeststo async/try-catch; centralize error conversion tocloudCannotProceedErr.onTestsReceivederror path and keep SKIP handling (emitendwithskippedSpec: true).user.getBaseLoginUrlasync and readdashboardAuthUrlfromgetAuthUrls()result.scripts/sync-cloud-validations.shand new npm scripts (sync-cloud-validations,ensure-cloud-validations); run duringpostinstalland before build/type-check.zoddep; update@tooling/v8-snapshotbuild to ensure typedefs.lib/validationsvia.gitignore.Written by Cursor Bugbot for commit c537692. This will update automatically on new commits. Configure here.