Skip to content

fix(nuxt): immediately call asyncData within client-only components #31964

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
Merged
merged 2 commits into from
May 1, 2025
Merged

fix(nuxt): immediately call asyncData within client-only components #31964

merged 2 commits into from
May 1, 2025

Conversation

danielroe
Copy link
Member

🔗 Linked issue

resolves #31925

📚 Description

this handles immediately executing asyncData nested within client-only components

@bolt-new-by-stackblitz Bolt.new (by StackBlitz)
Copy link

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

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented May 1, 2025

Walkthrough

The changes introduce a mechanism to identify and handle components rendered exclusively on the client side within a Nuxt application. A new internal flag, _nuxtClientOnly, is added to Vue's ComponentInternalInstance via module augmentation, and is set to true in relevant setup functions within both the ClientOnly component and client-only page components. The clientOnlySymbol is also provided in these contexts for injection-based checks. In the asyncData composable, logic is added to detect if a component is within a client-only context using the new flag or symbol, and, if so, the initial data fetch on component mount is skipped to avoid unnecessary operations during hydration or lazy loading. A corresponding test is implemented to verify support for the Options API asyncData within a client-only hydration scenario. No changes are made to the signatures 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 b503fa2 and 0e9f2a9.

📒 Files selected for processing (5)
  • packages/nuxt/src/app/components/client-only.ts (1 hunks)
  • packages/nuxt/src/app/composables/asyncData.ts (2 hunks)
  • packages/nuxt/src/app/types/augments.d.ts (1 hunks)
  • packages/nuxt/src/components/runtime/client-component.ts (2 hunks)
  • test/nuxt/composables.test.ts (2 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
packages/nuxt/src/components/runtime/client-component.ts (1)
packages/nuxt/src/app/components/client-only.ts (1)
  • clientOnlySymbol (8-8)
packages/nuxt/src/app/composables/asyncData.ts (1)
packages/nuxt/src/app/components/client-only.ts (1)
  • clientOnlySymbol (8-8)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build
  • GitHub Check: code
🔇 Additional comments (9)
packages/nuxt/src/app/types/augments.d.ts (1)

45-45: Type augmentation for client-only components looks good.

This addition properly extends the Vue ComponentInternalInstance type to support the client-only detection feature, ensuring type safety throughout the application.

packages/nuxt/src/app/components/client-only.ts (1)

26-29: Well-structured implementation of client-only flag.

This change correctly sets the _nuxtClientOnly flag on the component instance, allowing for detection of client-only components. The code properly handles the case where the component instance might not be available with the conditional check.

packages/nuxt/src/app/composables/asyncData.ts (3)

1-1: Good import additions for the client-only functionality.

The additional imports for getCurrentInstance, inject and clientOnlySymbol are necessary for implementing the client-only detection mechanism.

Also applies to: 9-9

318-319: Clean detection mechanism for client-only contexts.

This line elegantly handles detection of client-only components by checking both the internal flag and the injected symbol, providing a robust way to identify components that should skip initial data fetching.

326-326: Effective conditional logic to skip fetches in client-only components.

This conditional check now prevents unnecessary data fetching during hydration for client-only components, improving performance by avoiding redundant network requests.

test/nuxt/composables.test.ts (2)

11-11: Good import addition for testing client-only components.

Adding the import for createClientPage is necessary to test the client-only component functionality with asyncData.

1128-1145: Comprehensive test for asyncData within client-only components.

This test effectively verifies that the asyncData functionality works correctly within client-only components during hydration. It:

  1. Sets up the hydration environment
  2. Creates a client-only page with asyncData
  3. Verifies the component renders correctly
  4. Properly cleans up by resetting hydration flags

The test provides good coverage for the new feature implementation.

packages/nuxt/src/components/runtime/client-component.ts (2)

1-1: Good addition of required imports

The imports have been properly expanded to include the necessary Vue functions (getCurrentInstance and provide) and the clientOnlySymbol from the client-only component. These additions align well with the implementation of client-only component detection.

Also applies to: 6-6

49-53: Well-implemented client-only context identification

The code correctly implements a dual mechanism for identifying client-only components:

  1. Using Vue's provide/inject system with clientOnlySymbol
  2. Setting the _nuxtClientOnly flag on the component instance

The defensive check for the existence of vm before setting the property is a good practice, as getCurrentInstance() might return null in certain scenarios.

✨ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented May 1, 2025

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/schema

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

@nuxt/rspack-builder

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 0e9f2a9

@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented May 1, 2025

CodSpeed Performance Report

Merging #31964 will not alter performance

Comparing fix/client-only-async-data (0e9f2a9) with main (b503fa2)

Summary

✅ 10 untouched benchmarks

@danielroe danielroe merged commit 534146a into main May 1, 2025
47 checks passed
@danielroe danielroe deleted the fix/client-only-async-data branch May 1, 2025 12:11
This was referenced May 1, 2025
Closed
Draft
danielroe added a commit that referenced this pull request May 1, 2025
@danielroe
fix(nuxt): immediately call asyncData within client-only components (#…
8305ee8 
…31964)
@github-actions github-actions bot mentioned this pull request Apr 30, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
3.x bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Legacy asyncData not working inside client-only page
1 participant
@danielroe
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