feat(nuxt): add private option to useAsyncData (#29064)

[cjpearson]

🔗 Linked issue

https://github.com/nuxt/nuxt/issues/29064

📚 Description

This change adds a new private option to useAsyncData. This option changes the default value of server based on the cache settings of the page.

The intended use-case is for composables and components which may be used in different pages and rely on useAsyncData. When fetching private data on cached routes it is important that the fetch is not done in SSR so that the cached page will not include the sensitive data. But it's perfectly fine to do so on non-cached pages.

The current implementation is based on the event.context.cache property from Nitro 2.10, but I've also tried reading the routeRules when working with older Nitro version.

  const routeRules = nuxtApp.ssrContext?.event?.context._nitro.routeRules
  const cachedRoute = !!(routeRules?.cache || routeRules?.isr || routeRules?.swr)

I'm also not sure what the best for the option behavior/naming is. The current approach just modifies the defaulting of the server option, but perhaps it would be better to extend the server option? Something like defining the option as server: undefined | boolean | 'private'?

[bolt-new-by-stackblitz[bot]]

Run & review this pull request in StackBlitz Codeflow.

[coderabbitai[bot]]

Walkthrough

The changes involve updates to the documentation and implementation of the useAsyncData composable. A new private option has been added to the AsyncDataOptions interface, affecting the behavior of the server option based on the caching state of pages. The documentation has been refined for clarity, including important notes and warnings about the usage of the composable. These modifications enhance understanding and control over data fetching mechanisms in relation to caching.

Changes

File Path	Change Summary
docs/3.api/2.composables/use-async-data.md	Updated documentation to include the new private option and refined notes and return values.
packages/nuxt/src/app/composables/asyncData.ts	Added private property to AsyncDataOptions interface and updated logic for the server option.

Possibly related PRs

• #29755: This PR discusses documentation related to useAsyncData, which is directly relevant to the changes made in the main PR regarding the useAsyncData composable and its options.
• #29910: This PR corrects a reference in the documentation from useFetch to useAsyncData, which is related to the main PR's focus on enhancing the documentation for useAsyncData.

Suggested labels

documentation, 3.x

Suggested reviewers

• danielroe

Poem

In the land of code where rabbits play,
New options sprout, brightening the day.
With private set, the server knows,
How to fetch data, as caching flows.
Hops of clarity, in docs we find,
A joyful leap for the curious mind! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

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 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.