Skip to content

fix(nuxt): ensure appConfig sources are not duplicated #32216

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 4 commits into from
May 27, 2025

Conversation

larbish
Copy link
Contributor

@larbish larbish commented May 27, 2025

🔗 Linked issue

nuxtlabs/docus#1077

📚 Description

This issue is related to how Nuxt Content handles HMR:

Updating Markdown content in local development with HMR triggers duplication of bottom links in the table of content of Docus v2 (currently WIP). Those links are represented by an array in the app.config.ts file.

Nuxt Content is calling updateTemplates to update dump and manifest templates and ensure database integrity.

This call triggers the builder:generateApp which itself call the resolveApp method. Since resolveApp is also called by Nuxt HMR it results in multiple call happening at the same time and updating the same app instance.

In this case same config files are push to app.configs and are duplicated.

I'm simply ensuring that config file are push only if they do not already exist.

Here is a video to explain the issue:

docus-duplicate-code.mp4

PS1: I'll be happy to provide a reproduction in test but I need help to create the test.

PS: It might also exists an issue with the way defufn is handling array merge here but I'm not sure how to provide a fix.

@Copilot Copilot AI review requested due to automatic review settings May 27, 2025 10:04
@larbish larbish requested a review from danielroe as a code owner May 27, 2025 10:04
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 where duplicate application configuration files were being pushed into the app configurations array.

  • Prevent duplicate app config paths by checking for existence before pushing
  • Addresses an HMR-related bug that causes duplicated config entries
Comments suppressed due to low confidence (1)

packages/nuxt/src/core/app.ts:227

  • Adding a duplicate check is a necessary fix, but ensure that appConfigPath values are consistently formatted (e.g., resolved to absolute paths) to reliably prevent duplicates.
if (appConfigPath && !app.configs.includes(appConfigPath)) {

Copy link

coderabbitai bot commented May 27, 2025

Walkthrough

The change updates the comment above the final normalization and deduplication step in the resolveApp function to explicitly include app.configs alongside plugins and middleware. It adds deduplication of app.configs by converting it to a Set and back to an array after the app:resolve hook is called. The deduplication of app.middleware and app.plugins remains unchanged. No changes were made to the declarations of exported or public entities.


📜 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 6621ad9 and f050a13.

📒 Files selected for processing (1)
  • packages/nuxt/src/core/app.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/nuxt/src/core/app.ts
⏰ Context from checks skipped due to timeout of 90000ms (14)
  • GitHub Check: test-fixtures (ubuntu-latest, built, rspack, async, manifest-on, json, 20)
  • GitHub Check: test-fixtures (ubuntu-latest, built, webpack, default, manifest-on, json, 20)
  • GitHub Check: test-fixtures (ubuntu-latest, built, vite, async, manifest-on, json, 20)
  • GitHub Check: test-fixtures (ubuntu-latest, built, vite, default, manifest-off, json, 20)
  • GitHub Check: test-fixtures (ubuntu-latest, dev, vite, default, manifest-off, json, 20)
  • GitHub Check: test-fixtures (ubuntu-latest, built, vite, async, manifest-on, js, 20)
  • GitHub Check: test-fixtures (ubuntu-latest, dev, vite, async, manifest-off, json, 20)
  • GitHub Check: test-fixtures (ubuntu-latest, dev, vite, async, manifest-on, js, 20)
  • GitHub Check: test-fixtures (ubuntu-latest, built, vite, async, manifest-off, json, 20)
  • GitHub Check: release-pr
  • GitHub Check: test-size
  • GitHub Check: test-benchmark
  • GitHub Check: typecheck (ubuntu-latest, bundler)
  • 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 27, 2025

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: f050a13

Comment on lines 227 to 229
if (appConfigPath && !app.configs.includes(appConfigPath)) {
app.configs.push(appConfigPath)
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Middleware and plugin deduplication occur after app:resolve. If this should be deduplicated, perhaps it should happen there, too.

Copy link
Member

@atinux atinux May 27, 2025

Choose a reason for hiding this comment

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

Nice catch, we should also deduplicate after the app:resolve hook.

An easy way as uniqueBy is for array with objects would be to do on lines 230 and 238:

app.configs = [...new Set(app.configs)]

Copy link
Contributor Author

@larbish larbish May 27, 2025

Choose a reason for hiding this comment

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

Just updated the code, not sure both dedup are useful, the last one is enough to fix my issue.

Also, seems that md files in content/ folder can be ignored on Nuxt Content to not trigger resolveApp from buidler:watch hook. Checking this with @farnabaz

Copy link

codspeed-hq bot commented May 27, 2025

CodSpeed Performance Report

Merging #32216 will not alter performance

Comparing larbish:main (f050a13) with main (bd2dffe)

Summary

✅ 10 untouched benchmarks

@danielroe
Copy link
Member

danielroe commented May 27, 2025

interesting. I wonder if the root cause is the source of #30267.

if so it may be that we can solve all these issues at source (or it's possible that deduplicating is the correct option - I'm very happy with this approach too)

@danielroe danielroe changed the title fix(app): ensure app configs are not duplicated fix(nuxt): ensure appConfig sources are not duplicated May 27, 2025
larbish and others added 2 commits May 27, 2025 15:28
Co-authored-by: Daniel Roe <daniel@roe.dev>
@danielroe danielroe merged commit 726ac60 into nuxt:main May 27, 2025
46 checks passed
@danielroe
Copy link
Member

thank you ❤️

@github-actions github-actions bot mentioned this pull request May 27, 2025
@github-actions github-actions bot mentioned this pull request May 31, 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.

4 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