Skip to content

fix: commented HTML prevents injected cypress script from working #33057

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
alexsch01 wants to merge 24 commits into
base: develop
Choose a base branch
from
Open

fix: commented HTML prevents injected cypress script from working #33057

alexsch01 wants to merge 24 commits into from
+67 −38

Conversation

@alexsch01
Copy link
Contributor

@alexsch01 alexsch01 commented Dec 3, 2025 •
edited by cursor bot
Loading

Additional details

Instead of trying to fit the injected cypress script into the head element, it's less error-prone to put it as a top level <script> tag before the HTML

  • one exception is the DOCTYPE, which needs to be the first line of text, so we are keeping insertAfter for that case

Original HTML

<!DOCTYPE html>
<html>
<!-- <head>
<title>Test</title> 
</head> -->
</html>

Before PR

<!DOCTYPE html>
<html>
<!-- <head> <script type='text/javascript'> CYPRESS_INJECTION(); </script>
<title>Test</title> 
</head> -->
</html>

After PR

<!DOCTYPE html>
<script type='text/javascript'> CYPRESS_INJECTION(); </script>
<html>
<!-- <head>
<title>Test</title> 
</head> -->
</html>

Steps to test

How has the user experience changed?

PR Tasks

Note

Injects Cypress HTML after <!DOCTYPE> when present, or at top-level otherwise, handling commented/XML-prefixed HTML; adds unit tests and updates changelog.

  • Proxy/Rewriter (packages/proxy/lib/http/util/rewriter.ts)
    • Replace head/body/html insertion with simpler strategy: insert after <!DOCTYPE> if found, otherwise prepend injection at top-level via new htmlHelper().
    • Broaden doctype detection regex to handle leading comments and XML declarations.
    • Preserve security stripping; refactor to use helper and remove unused insertion paths.
  • Tests (packages/proxy/test/unit/http/util/rewriter.spec.ts)
    • Add unit tests covering DOCTYPE, commented DOCTYPE, XML declaration, and mixed-comment scenarios.
  • Changelog (cli/CHANGELOG.md)
    • Note bugfix for commented HTML breaking DOM injection.

Written by Cursor Bugbot for commit 63fb635. This will update automatically on new commits. Configure here.

@cypress-app-bot
Copy link
Collaborator

cypress-app-bot commented Dec 3, 2025

cursor[bot]
cursor bot reviewed Dec 3, 2025
View reviewed changes
@alexsch01 alexsch01 marked this pull request as draft December 5, 2025 05:52
@alexsch01 alexsch01 marked this pull request as ready for review December 5, 2025 12:04
cursor[bot]
cursor bot reviewed Dec 5, 2025
View reviewed changes
@alexsch01
Copy link
Contributor Author

alexsch01 commented Dec 8, 2025

@jennifer-shehane @AtofStryker @mschile this is kinda a big change, let me know what you think of it
The regex isn't perfect, but I don't want a commented out DOCTYPE to be matched since that would cause the same issue this PR is fixing

@jennifer-shehane
Copy link
Member

jennifer-shehane commented Dec 8, 2025

@alexsch01 Going to run the tests

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cursor cursor[bot] cursor[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@alexsch01 alexsch01

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

commented HTML code prevents packages/proxy/lib/http/util/rewriter.ts from working properly

3 participants

@alexsch01 @cypress-app-bot @jennifer-shehane