Skip to content

fix: simplify dom render + use minimal css for iframe #670

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.

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

Merged
merged 1 commit into from
Jul 6, 2025

Conversation

amhsirak
Copy link
Member

@amhsirak amhsirak commented Jun 30, 2025

ref: #656

Summary by CodeRabbit

  • Refactor
    • Simplified the CSS injected into replayed session snapshots for a cleaner and more maintainable appearance.
    • Improved logic for injecting styles into the snapshot, reducing complexity and potential rendering issues.

Copy link

coderabbitai bot commented Jun 30, 2025

Walkthrough

The rendering logic for rrweb snapshot HTML within an iframe was simplified. The previous approach of injecting extensive CSS, including font-face declarations and external stylesheets, was replaced with a minimal CSS block. The CSS injection method was also streamlined, reducing overall complexity while maintaining core styling and behavior controls.

Changes

File(s) Change Summary
src/components/recorder/DOMBrowserRenderer.tsx Simplified CSS injection for rrweb snapshot rendering; replaced regex-based injection with string check; reduced injected CSS to a minimal set.

Suggested labels

Type: Enhancement

Poem

A rabbit hopped through lines of code,
Where CSS once overflowed.
Now lighter, leaner, swift and neat,
The snapshot renders—what a feat!
With minimal flair and scrollbars gone,
The bunny cheers, "Hop on, hop on!"
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 64d53fd and 859be3f.

📒 Files selected for processing (1)
  • src/components/recorder/DOMBrowserRenderer.tsx (1 hunks)
🔇 Additional comments (1)
src/components/recorder/DOMBrowserRenderer.tsx (1)

792-810: LGTM! Excellent simplification of CSS injection.

The minimal CSS approach is a significant improvement that maintains core functionality while reducing complexity. The conditional pointer-events for links based on capture mode is particularly well-implemented.

Comment on lines +812 to 822
if (rebuiltHTML.includes("<head>")) {
rebuiltHTML = rebuiltHTML.replace(
headTagRegex,
`<head>${cssInjection}`
"<head>",
`<head><base href="${snapshotData.baseUrl}">${minimalCSS}`
);
} else {
} else if (rebuiltHTML.includes("<html>")) {
rebuiltHTML = rebuiltHTML.replace(
/<html[^>]*>/i,
`<html><head>${cssInjection}</head>`
"<html>",
`<html><head><base href="${snapshotData.baseUrl}">${minimalCSS}</head>`
);
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add fallback case for malformed HTML.

The simplified injection logic is much cleaner, but there's a potential edge case where HTML might not contain either <head> or <html> tags, leaving no CSS or base href injected.

Consider adding a fallback case to ensure CSS and base href are always injected:

 if (rebuiltHTML.includes("<head>")) {
   rebuiltHTML = rebuiltHTML.replace(
     "<head>",
     `<head><base href="${snapshotData.baseUrl}">${minimalCSS}`
   );
 } else if (rebuiltHTML.includes("<html>")) {
   rebuiltHTML = rebuiltHTML.replace(
     "<html>",
     `<html><head><base href="${snapshotData.baseUrl}">${minimalCSS}</head>`
   );
+} else {
+  // Fallback: prepend to the entire HTML if no head/html tags found
+  rebuiltHTML = `<head><base href="${snapshotData.baseUrl}">${minimalCSS}</head>${rebuiltHTML}`;
 }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if (rebuiltHTML.includes("<head>")) {
rebuiltHTML = rebuiltHTML.replace(
headTagRegex,
`<head>${cssInjection}`
"<head>",
`<head><base href="${snapshotData.baseUrl}">${minimalCSS}`
);
} else {
} else if (rebuiltHTML.includes("<html>")) {
rebuiltHTML = rebuiltHTML.replace(
/<html[^>]*>/i,
`<html><head>${cssInjection}</head>`
"<html>",
`<html><head><base href="${snapshotData.baseUrl}">${minimalCSS}</head>`
);
}
if (rebuiltHTML.includes("<head>")) {
rebuiltHTML = rebuiltHTML.replace(
"<head>",
`<head><base href="${snapshotData.baseUrl}">${minimalCSS}`
);
} else if (rebuiltHTML.includes("<html>")) {
rebuiltHTML = rebuiltHTML.replace(
"<html>",
`<html><head><base href="${snapshotData.baseUrl}">${minimalCSS}</head>`
);
} else {
// Fallback: prepend to the entire HTML if no head/html tags found
rebuiltHTML = `<head><base href="${snapshotData.baseUrl}">${minimalCSS}</head>${rebuiltHTML}`;
}
🤖 Prompt for AI Agents
In src/components/recorder/DOMBrowserRenderer.tsx around lines 812 to 822, the
current logic injects CSS and base href only if the HTML contains <head> or
<html> tags, missing cases where these tags are absent. Add a fallback else case
to prepend a minimal HTML structure including <head> with the base href and CSS
to the rebuiltHTML string, ensuring the injection always occurs even for
malformed HTML.

@amhsirak amhsirak added Type: Bug Something isn't working Scope: Recorder All issues/PRs related to recorder labels Jun 30, 2025
@amhsirak amhsirak requested a review from RohitR311 June 30, 2025 11:01
@amhsirak amhsirak merged commit c572c6b into develop Jul 6, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Scope: Recorder All issues/PRs related to recorder Type: Bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant