Skip to content

fix(nuxt): clear previous head in island-renderer #32100

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 2 commits into from
May 15, 2025

Conversation

Norbiros
Copy link
Contributor

🔗 Linked issue

📚 Description

This bug has been mentioned multiple times, such as in this comment. Essentially, the logic for clearing entries in head used a deprecated method that didn't function properly.

As a result, every server component in project that uses @nuxt/ui includes the entire css variables declaration, significantly impacting performance. The difference is striking: current code, the head size is 7778 bytes; after my changes, it's only 394 bytes—nearly a 20x difference, for a very simple markdown component.

@Copilot Copilot AI review requested due to automatic review settings May 13, 2025 17:47
@Norbiros Norbiros requested a review from danielroe as a code owner May 13, 2025 17:47
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes an issue with head management in Nuxt's island-renderer by ensuring that previously registered head entries are completely cleared. Key changes include:

  • Replacing the deprecated splice method with a clear() call to reset head entries.
  • Adding a test to verify that styles added via plugins are not re-applied in server-rendered output.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
test/basic.test.ts Adds a test to assert that plugin-provided head styles are not rendered
packages/nuxt/src/app/components/island-renderer.ts Replaces array splice with clear() to properly reset head entries
Comments suppressed due to low confidence (2)

test/basic.test.ts:2046

  • [nitpick] Consider adding further assertions to confirm that other head entries remain intact after clearing to ensure no unintended side effects occur.
    // head set using plugins should not be added again

packages/nuxt/src/app/components/island-renderer.ts:21

  • Ensure that head.entries is always defined before calling clear() to avoid potential runtime errors if the injected head does not implement a clear() method.
head.entries.clear()

Copy link

coderabbitai bot commented May 13, 2025

Walkthrough

The changes revise the clearing of head entries in the IslandRenderer component by replacing array splicing with a direct call to clear the entries collection. In the test suite, the expected page title was updated from including a suffix to a simpler form, and additional assertions were added to verify that a CSS style injected by a plugin is present in the server-rendered HTML. Several snapshot expectations related to titleTemplate in island component responses were removed. The plugin was modified to inject a CSS style setting the body text colour to red with specified properties. No changes were made to exported or public entity declarations.

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fc14617 and 3bedafc.

📒 Files selected for processing (1)
  • test/basic.test.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • test/basic.test.ts
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: codeql (javascript-typescript)
  • GitHub Check: build
  • GitHub Check: code
✨ 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

pkg-pr-new bot commented May 13, 2025

Open in StackBlitz

@nuxt/kit

npm i https://pkg.pr.new/@nuxt/kit@32100

nuxt

npm i https://pkg.pr.new/nuxt@32100

@nuxt/schema

npm i https://pkg.pr.new/@nuxt/schema@32100

@nuxt/rspack-builder

npm i https://pkg.pr.new/@nuxt/rspack-builder@32100

@nuxt/vite-builder

npm i https://pkg.pr.new/@nuxt/vite-builder@32100

@nuxt/webpack-builder

npm i https://pkg.pr.new/@nuxt/webpack-builder@32100

commit: 3bedafc

@Norbiros Norbiros marked this pull request as draft May 13, 2025 17:52
Copy link

codspeed-hq bot commented May 13, 2025

CodSpeed Performance Report

Merging #32100 will not alter performance

Comparing Norbiros:fix/clear-head-islands (3bedafc) with main (76b300e)

Summary

✅ 10 untouched benchmarks

@Norbiros Norbiros force-pushed the fix/clear-head-islands branch from f69363c to fc14617 Compare May 13, 2025 18:35
@Norbiros Norbiros marked this pull request as ready for review May 13, 2025 18:36
@danielroe danielroe changed the title fix(nuxt): properly clear previous head in island-renderer fix(nuxt): clear previous head in island-renderer May 13, 2025
@danielroe danielroe merged commit 55dd601 into nuxt:main May 15, 2025
47 checks passed
@github-actions github-actions bot mentioned this pull request May 15, 2025
@github-actions github-actions bot mentioned this pull request May 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy