fix: ensure debugging your ci failures message displays #31563
Conversation
ryanthemanuel
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR fixes an issue where a message prompting users to check Cypress Cloud on CI failures was not displayed, caused by hoisting changes affecting dependency paths.
- Update to force no-rewrite entry in the snapshot builder configuration
- Revision of the cloud recommendation message in the server print-run utility
- Adjustment of branch filters in CircleCI workflows to support the change
Reviewed Changes
Copilot reviewed 7 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tooling/v8-snapshot/src/setup/force-no-rewrite.ts | Updated the dependency entry to use a suffix instead of full paths |
| system-tests/test/ci_failure_spec.ts | Added a new test to validate the updated CI failure message |
| system-tests/snapshots/ci_failure_spec_ts.js | Updated snapshot reflecting the changed CI failure output |
| packages/server/lib/util/print-run.ts | Revised the cloud recommendation message for clarity and consistency |
| cli/vue2/README.md | Added documentation for the Vue 2 integration package |
| cli/CHANGELOG.md | Documented the fix in the changelog |
| .circleci/workflows.yml | Updated branch filter names for consistent v8 snapshot cache testing |
Files not reviewed (2)
- cli/vue2/package.json: Language not supported
- tooling/v8-snapshot/package.json: Language not supported
Comments suppressed due to low confidence (3)
packages/server/lib/util/print-run.ts:32
- [nitpick] The updated cloud recommendation message changes the tone and length of the previous message. Consider verifying that the new message displays properly and in context with other user-facing texts.
Debug faster with full visibility.
.circleci/workflows.yml:41
- [nitpick] The branch filter name 'ryanm/fix/having-trouble-debugging-your-ci-failures-minimal' is quite verbose; consider simplifying the name for easier maintenance while still conveying the purpose.
- 'ryanm/fix/having-trouble-debugging-your-ci-failures-minimal'
tooling/v8-snapshot/src/setup/force-no-rewrite.ts:72
- Using a suffix-based entry like 'ci-info/index.js' may potentially match unintended paths if there are similarly named modules. Please verify that this change is sufficiently specific to avoid false positives.
'ci-info/index.js',
…580494 fix: ensure having trouble debugging your ci failures message displays
…580494 fix: ensure having trouble debugging your ci failures message displays
…580494 fix: ensure having trouble debugging your ci failures message displays
…580494 fix: ensure having trouble debugging your ci failures message displays
…580494 fix: ensure having trouble debugging your ci failures message displays
…580494 fix: ensure having trouble debugging your ci failures message displays
| Debug faster with full visibility. | ||
| Record to Cypress Cloud and get instant access to full test details and replays. | ||
| Inspect the DOM, network events, and console logs exactly as they ran in CI. | ||
| >> https://on.cypress.io/cloud-get-started |
There was a problem hiding this comment.
@ryanthemanuel This snapshot doesn't have the line spacing I would expect here.
There was a problem hiding this comment.
Are the newlines stripped out of the snapshot? I don't remember that being the case.
There was a problem hiding this comment.
It's passing for me locally?
There was a problem hiding this comment.
Hmmm. Something is fishy.
There was a problem hiding this comment.
I think that should fix it. My guess is my IDE auto formatted something. Weird that it was passing for me locally though...
ryanthemanuel
deleted the
ryanm/fix/having-trouble-debugging-your-ci-failures-minimal
branch
cypress
|
||||||||||||||||||||||||||||
| Project |
cypress
|
| Branch Review |
ryanm/fix/having-trouble-debugging-your-ci-failures-minimal
|
| Run status |
|
| Run duration | 17m 50s |
| Commit |
|
| Committer | Ryan Manuel |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
3
|
Pending
|
771
|
Skipped
|
0
|
Passing
|
5754
|
| View all changes introduced in this branch ↗︎ | |
Warning
No Report: Something went wrong and we could not generate a report for the Application Quality products.
|
Released in This comment thread has been locked. If you are still experiencing this issue after upgrading to |
Additional details
Due to some hoisting changes,
ci-info/index.jsmoved from the server node_modules directory to the top level node_modules directory. This caused this entry to no longer flag the dependency asno-rewrite. This entry was necessary for this message to display properly.To fix this (and to future proof this type of scenario from occurring again), this PR:
force-no-rewritefile to not spell out the full path since the snapshot builder uses these force no rewrite entries as suffixesThere will be a follow up PR to future proof the v8 snapshot workflow so we don't run into this problem again.
Steps to test
How has the user experience changed?
(Ignore coloring)
Before
After
PR Tasks
cypress-documentation?type definitions?