chore: (cy.prompt) ensure to strip out paths from all data when reporting errors in prompt #32134
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
…ng errors in prompt
…/sanitize-error-reporting-prompt
ryanthemanuel
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR corrects file naming inconsistencies for the cy-prompt error reporting module and ensures path stripping is applied consistently across all data when reporting errors.
- Fixes import paths that incorrectly used hyphens instead of underscores in the filename
- Adds path stripping to cyPromptMethodArgs data to prevent sensitive path information from being exposed in error reports
- Includes a check to skip error reporting when CYPRESS_CRASH_REPORTS is disabled
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/server/test/unit/cloud/cy-prompt/CyPromptLifecycleManager_spec.ts | Updates import path to use correct underscore-separated filename |
| packages/server/test/unit/cloud/api/cy-prompt/report_cy_prompt_error_spec.ts | Adds comprehensive test coverage for the error reporting function |
| packages/server/lib/cloud/cy-prompt/CyPromptLifecycleManager.ts | Updates import path to use correct underscore-separated filename |
| packages/server/lib/cloud/api/cy-prompt/report_cy_prompt_error.ts | Adds path stripping to cyPromptMethodArgs and crash reports check |
Comments suppressed due to low confidence (3)
packages/server/test/unit/cloud/api/cy-prompt/report_cy_prompt_error_spec.ts:129
- This test assertion assumes that the stack trace will contain the test file name, but it doesn't verify that the stripPath function is actually working correctly. Consider testing with a known path structure to ensure stripPath functionality is properly validated.
stack: sinon.match((stack) => stack.includes('<stripped-path>report_cy_prompt_error_spec.ts')),
packages/server/test/unit/cloud/api/cy-prompt/report_cy_prompt_error_spec.ts:199
- Similar to the previous assertion, this test doesn't adequately verify that stripPath is working correctly on the stack trace. The test should use a more controlled stack trace to validate the path stripping behavior.
stack: sinon.match((stack) => stack.includes('<stripped-path>report_cy_prompt_error_spec.ts')),
packages/server/test/unit/cloud/api/cy-prompt/report_cy_prompt_error_spec.ts:236
- This is the third instance of the same inadequate test pattern. Consider creating a test case that explicitly verifies stripPath functionality with known input/output pairs rather than relying on the actual test file's stack trace.
stack: sinon.match((stack) => stack.includes('<stripped-path>report_cy_prompt_error_spec.ts')),
cypress
|
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress
|
| Branch Review |
ryanm/chore/sanitize-error-reporting-prompt
|
| Run status |
|
| Run duration | 19m 16s |
| Commit |
|
| Committer | Ryan Manuel |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
11
|
Pending
|
1232
|
Skipped
|
4
|
Passing
|
32198
|
| View all changes introduced in this branch ↗︎ | |
Warning
Partial Report: The results for the Application Quality reports may be incomplete.
UI Coverage
45.56%
|
|
|---|---|
|
Untested elements
|
191
|
|
Tested elements
|
164
|
Accessibility
98.14%
|
|
|---|---|
|
Failed rules
|
3 critical
8 serious
2 moderate
2 minor
|
|
Failed elements
|
99
|
estrada9166
approved these changes
Aug 4, 2025
ryanthemanuel
added a commit
that referenced
this pull request
Oct 4, 2025
* Create cy-prompt-development.md * chore: cy prompt infrastructure (#31748) * feat: cy prompt infrastructure * refactor and add tests * refactor * rename experimental config * prompt * fix test * Update cy-prompt-development.md * Update cy-prompt-development.md * PR comments * Update packages/server/lib/cloud/api/cy-prompt/get_cy_prompt_bundle.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * PR comments --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fix test * Delete packages/server/lib/cloud/StudioLifecycleManager.ts * Delete packages/server/test/unit/cloud/StudioLifecycleManager_spec.ts * chore: add cdp connection to cy prompt (#31806) * chore: add cdp connection to cy prompt * minor fix * fix type build * try to fix build * Update packages/server/lib/browsers/browser-cri-client.ts Co-authored-by: Bill Glesias <bglesias@gmail.com> * Update packages/server/lib/browsers/browser-cri-client.ts Co-authored-by: Bill Glesias <bglesias@gmail.com> * do not support prompt in firefox or webkit * rework timing of lifecycle * refactor * fix tests * troubleshooting * troubleshooting * fix tests * additional troubleshooting * additional troubleshooting * additional troubleshooting * attempt to fix build * add back * debugging * debugging * debugging * debugging * clean up * fix unit tests * rework --------- Co-authored-by: Bill Glesias <bglesias@gmail.com> * chore: create infrastructure to support backend function in cy.prompt (#31803) * chore: add promptBackend as an additional Cypress-attached function * Update packages/app/src/runner/event-manager.ts * update types * fix types * fix spacing * refactor * additional refactor * fix type build * fix build * refactor * reword messages * fix * debugging * undo debugging * PR comment * fix tests * fix tests * fix tests * fix test * chore: add watcher for cy-prompt development (#31810) * chore: add watcher for cy-prompt development * test caching * fix types * chore: turn on beta deployments for cy-prompt * internal: (cy.prompt) handle errors better in the command definition (#31835) * internal: (cy.prompt) handle errors better in the command definition * internal: (cy.prompt) add timeout and handle loading errors more cleanly * add process environment variable * clean up test * update JSDoc * chore: handle errors (#31854) * chore: handle errors * Fix ts, add test * Fix error title * Fix ts * Fix ts * chores: (cy.prompt) refactor routing to support both app and driver (#31891) * chore: Share error utils with the cloud (#31887) * share error utils with cloud * additional rework * Fix command, add isOpenMode * Add / fix test * fix ts --------- Co-authored-by: Ryan Manuel <ryanm@cypress.io> * internal: (cy.prompt) add infrastructure to support a Get Code modal (#31904) * chore: (cy.prompt) add infrastructure to support a Get Code modal * fix tests * fix code paths * Update eject button styles * handle errors * update types * Update packages/server/lib/socket-base.ts * Fix cy test * update readme --------- Co-authored-by: estrada9166 <estrada9166@gmail.com> * chore: (cy.prompt) refactor getTestsState to take a runnable id (#31965) * chore: (cy.prompt) refactor getTestsState to take a runnable id * fix tests * minor tweak * chore: (cy.prompt) add manifest for all of the cloud delivered files (#31922) * chore: (cy.prompt) add manifest for all of the cloud delivered files * fix tests and remove environment variables * update strategy * fix build * rework * require manifest * clean up * refactor * refactor * Update packages/server/lib/cloud/cy-prompt/CyPromptLifecycleManager.ts Co-authored-by: Matt Schile <mschile@cypress.io> * fix test --------- Co-authored-by: Matt Schile <mschile@cypress.io> * feat: add cy prompt more info needed modal (WIP) (#31970) * feat: add cy prompt more info needed modal * Reset promptStore * additional things exposed for more info * rework * fix tests * fix build * fix types * fix types * Update packages/app/src/runner/event-manager.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * reefactor * chore: (cy.prompt) rework the file save lifecycle * rework types * add unit tests --------- Co-authored-by: estrada9166 <estrada9166@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fix: (cy.prompt) ensure that we do not attach a vue ref to the react root in the cy.prompt modals (#32011) * fix: (studio) ensure that we do not attach a vue ref to the react root in the studio panel * fix test * chore: Handle cy-prompt error to the cloud (#32009) Co-authored-by: Ryan Manuel <ryanm@cypress.io> * chore: display prompt error message (#32016) * add createCloudRequest to cloudApi, handle errors during createCyPromptServer * render the get code button on failure * chore: update types * chore: move CT and browser error to cloud (#32077) * feat: (cy.prompt) give cy.prompt access to recording information (#32110) * feat: (cy.prompt) give cy.prompt access to recording information * undo bad refactor * undo bad refactor * undo bad refactor * rename * fix typo * Update packages/server/test/unit/modes/record_spec.js * Update packages/server/test/unit/modes/record_spec.js * Update packages/server/test/unit/modes/record_spec.js * Update packages/server/test/unit/modes/record_spec.js * Update packages/server/test/unit/modes/record_spec.js * Update cy-prompt-development.md * Update cy-prompt-development.md * Update cy-prompt-development.md * chore: add CYPRESS_INTERNAL_SIMULATE_OPEN_MODE to simulate running Cypress tests in open mode (#32114) * chore: (cy.prompt) ensure to strip out paths from all data when reporting errors in prompt (#32134) * fix: (cy.prompt) ensure to strip out paths from all data when reporting errors in prompt * refactor * update tests * fix logic error with protocol * add event manager to get code * Apply suggestions from code review * fix: (cy.prompt) improve the get project options performance by running promises in parallel (#32196) * fix: (cy.prompt) improve the get project options performance by running promises in parallel * add awaits in test * bump cache * Update packages/server/lib/cloud/studio/StudioLifecycleManager.ts * fix build * chore: cleanup * blank * Update trigger-publish-binary-pipeline.js * Update packages/server/test/unit/socket_spec.js * get rid of environment variable * fix: (cy.prompt) ensure to reset the prompt state when the event manager is torn down (indicating that we're no longer on the runner page) (#32301) * fix: (cy.prompt) ensure to reset the prompt state when the event manager is torn down (indicating that we're no longer on the runner page) * move test * fix lint issue * feat: (cy.prompt) introduce the concept of log collapse state being open/closed by default (#32262) * feat: (cy.prompt) introduce the concept of logs' collapse state being open/closed by default * update tests * rename * PR comments * fix test due to bad merge of develop * chore: Only allow experimentalPromptCommand within e2e config (#32435) * chore: Only allow experimentalPromptCommand within e2e config * Fix config * Update tests * Update test, update types * Fix test and types * fix tests * Add types * Update cli/types/cypress.d.ts Co-authored-by: Ryan Manuel <ryanm@cypress.io> --------- Co-authored-by: Ryan Manuel <ryanm@cypress.io> * Update workflows.yml * Add optional cyPromptManagerPromise property * Implement error handling in CyPromptManager Added a new method to handle errors uniformly in CyPromptManager. * Fix indentation in socket_spec.js * fix: (cy.prompt) handle when the prompt is executed by in CT or when the experiment is not enabled (#32470) * fix: (cy.prompt) handle when the prompt is executed by in CT or when the experiment is not enabled * Update packages/driver/cypress/e2e/commands/prompt/prompt.cy.ts * Update packages/driver/cypress/e2e/commands/prompt/prompt.cy.ts * update name of errors * Bump cache version to 9-15-2025 * update yarn.lock * fixes * fix snapshot * fix snapshot * internal: fix get code button to be purple with correct margin (#32504) * feat: (cy.prompt) update the types of prompt (#32529) * fix: move currentMoreInfoNeededModalInfo.onCancel to onClose (#32559) * internal: (cy.prompt) various improvements to error messages and time outs (#32582) * internal: (cy.prompt) various improvements to error messages and timeouts * fix test * remove dead code * Update packages/driver/src/cy/commands/prompt/index.ts * update prompt experiment description * fix build * fix tests * fix tests * fix test * update error message * Update packages/server/lib/experiments.ts Co-authored-by: Tim Griesser <tgriesser10@gmail.com> --------- Co-authored-by: Tim Griesser <tgriesser10@gmail.com> * internal: (cy.prompt) ensure that get code can properly work with prompts in cy.origin (#32596) * internal: (cy.prompt) ensure that get code can properly work with prompts in cy.origin * additional tests * additional tests * Apply suggestions from code review * code review comment * fix merge * fix merge * Update packages/data-context/graphql/schemaTypes/index.ts * update workflow * blank * persist binaries * chore: display custom link title (#32567) * chore: display custom link title * Add test * Pass docs as second argument of the error * Revert changes * Use openExternal for links --------- Co-authored-by: Jennifer Shehane <jennifer@cypress.io> * update * internal: (cy.prompt) do not retry on cert failures (#32624) * internal: (cy.prompt) do not retry on cert failures * tests and clean up * additional cleanup and add error message for prompt * fix unit tests * Update report_studio_error.ts * Update packages/network/lib/agent.ts * cursor comment * fix build * fix build * fix test * fix build * fix build * fix build * fix build * fix build * revert * Update packages/driver/src/cypress/error_messages.ts * Update packages/driver/cypress/e2e/commands/prompt/prompt-initialization-error.cy.ts * fix build * cursor comment * add changelog entry * clean up * Update packages/app/src/store/prompt-store.ts * Bump cache version to 10-3-2025 Updated cache version to trigger CI cache recreation. * Revise CHANGELOG for new features and fixes Updated changelog with new features and bug fixes. * index on feat/cy-prompt: 3cbcf6c Bump cache version to 10-3-2025 * index on feat/cy-prompt: 3cbcf6c Bump cache version to 10-3-2025 * index on feat/cy-prompt: 3cbcf6c Bump cache version to 10-3-2025 * blank * fix build --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Bill Glesias <bglesias@gmail.com> Co-authored-by: Alejandro Estrada <estrada9166@gmail.com> Co-authored-by: Matt Schile <mschile@cypress.io> Co-authored-by: Tim Griesser <tgriesser10@gmail.com> Co-authored-by: Jennifer Shehane <jennifer@cypress.io> Co-authored-by: Jennifer Shehane <shehane.jennifer@gmail.com> Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com>
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
We missed a spot where we were stripping paths in cy.prompt. This updates the logic to ensure we are properly stripping paths everywhere.
Steps to test
How has the user experience changed?
PR Tasks
cypress-documentation?type definitions?