chore: pass file preprocesor override to protocol as debug data #31171
Conversation
This file contains 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 base branch from
develop
to
ryanm/chore/studio-types
ryanthemanuel
changed the title
cypress
|
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress
|
| Branch Review |
ryanm/chore/pass-file-preprocessor-override-to-protocol
|
| Run status |
|
| Run duration | 17m 59s |
| Commit |
|
| Committer | Ryan Manuel |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
11
|
Pending
|
1232
|
Skipped
|
0
|
Passing
|
32101
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
46.15%
|
|
|---|---|
|
Untested elements
|
184
|
|
Tested elements
|
162
|
Accessibility
92.55%
|
|
|---|---|
|
Failed rules
|
3 critical
8 serious
2 moderate
2 minor
|
|
Failed elements
|
877
|
…eprocessor-override-to-protocol
AtofStryker
approved these changes
Feb 27, 2025
mschile
reviewed
Feb 27, 2025
Comment on lines
131
to
132
| registerChildEvent('file:preprocessor', this._getDefaultPreprocessor(initialConfig), true) | ||
| } |
There was a problem hiding this comment.
Instead of updating registerChildEvent which seems odd since we would need to update all of our registerChildEvent calls to pass true, can we do something like:
Suggested change
| registerChildEvent('file:preprocessor', this._getDefaultPreprocessor(initialConfig), true) | |
| } | |
| registerChildEvent('file:preprocessor', this._getDefaultPreprocessor(initialConfig), true) | |
| } else { | |
| const handler = this.registeredEventsById[this.registeredEventsByName['file:preprocessor']].handler | |
| this.ipc.send('file:preprocessor:overridden', { handlerString: handler.toString() }) | |
| } |
There was a problem hiding this comment.
I like it. Updated: 1a261e2 (#31171)
mschile
reviewed
Feb 27, 2025
| @@ -238,6 +244,12 @@ export class ProjectConfigIpc extends EventEmitter { | |||
| reject(err) | |||
| }) | |||
|
|
|||
| this.once('file:preprocessor:overridden', ({ handlerString }) => { | |||
| this.onDebugData({ | |||
| filePreprocessorHandlerString: handlerString, | |||
There was a problem hiding this comment.
Suggested change
| filePreprocessorHandlerString: handlerString, | |
| filePreprocessorHandlerText: handlerFunctionText, |
There was a problem hiding this comment.
Good call. Updated: 1a261e2 (#31171)
mschile
requested changes
Feb 27, 2025
mschile
reviewed
Feb 28, 2025
| @@ -238,6 +244,12 @@ export class ProjectConfigIpc extends EventEmitter { | |||
| reject(err) | |||
| }) | |||
|
|
|||
| this.once('file:preprocessor:overridden', ({ handlerString }) => { | |||
There was a problem hiding this comment.
Suggested change
| this.once('file:preprocessor:overridden', ({ handlerString }) => { | |
| this.once('file:preprocessor:overridden', ({ handlerText }) => { |
There was a problem hiding this comment.
mschile
approved these changes
Feb 28, 2025
ryanthemanuel
deleted the
ryanm/chore/pass-file-preprocessor-override-to-protocol
branch
|
Released in This comment thread has been locked. If you are still experiencing this issue after upgrading to |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
In order to improve troubleshooting source map issues as a part of test generation, we are going to start capturing any
file:preprocessoroverrides. This will hopefully give us insight into whether or not sourcemaps have not been properly enabled. This PR captures the function string and passes it from the child process to main Cypress where it's stored as a debug property on ProjectConfigLifecycleManager. There it can be passed to protocol where it will be stored as a debug event.Steps to test
How has the user experience changed?
PR Tasks
cypress-documentation?type definitions?