fix(nuxt): do not clear data if custom `getCachedData` is provided #32003

danielroe · 2025-05-05T12:36:25Z

🔗 Linked issue

resolves #31999

📚 Description

this reverts an unintentional breaking change in v3.17, and will only now clear getCachedData if there has not been a custom getCachedData function provided (which might rely on accessing payload.data).

We intend to add custom caching utilities that will mean people can migrate off of getCachedData in the next minor.

bolt-new-by-stackblitz · 2025-05-05T12:36:29Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-05-05T12:38:35Z

Walkthrough

The changes move the getDefault and getDefaultCachedData functions from being defined inside the useAsyncData function to the module scope at the bottom of the file. The assignment of options.default and options.getCachedData within useAsyncData is updated to reference these module-scoped functions. In the createAsyncData function, a new boolean flag, hasCustomGetCachedData, is introduced to determine if a custom getCachedData function is provided. A new hook subscription, unsubRefreshAsyncData, is added to listen for 'app:data:refresh' events and refresh async data when relevant keys are updated. The _off cleanup function is modified to unsubscribe from the refresh hook, set _init to false, and clear cached data only when no custom caching is used and purging is enabled. Cleanup logic in useAsyncData and useNuxtData is adjusted to avoid clearing cached data or resetting _init on zero dependencies. No exported or public function signatures are changed.

📜 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 32ea93a and b30c7ff.

📒 Files selected for processing (1)

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

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: codeql (actions)
GitHub Check: code

🔇 Additional comments (4)

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

601-602: Correctly identifies custom caching functions.

This addition creates a flag to determine if a custom getCachedData function has been provided, which is essential for the fix to prevent clearing custom cached data.

618-622: Proper event handling for data refresh.

Added a hook subscription to handle 'app:data:refresh' events, which ensures async data gets refreshed when requested. The implementation correctly checks if the current key is targeted before executing a refresh.

710-717: Fix prevents clearing custom cached data.

This change addresses the core issue by only clearing cached data when no custom getCachedData function is provided. The code now correctly respects custom caching implementations while maintaining the default cleanup behavior for standard usage.

The TODO comment indicates this is a temporary solution that will be replaced by better custom caching utilities in v4, which aligns with the PR objectives.

723-733: Appropriate refactoring of default function implementations.

Moving the getDefault and getDefaultCachedData functions to the module scope improves code organization and allows them to be referenced for comparison with custom implementations. The function logic remains unchanged, preserving the existing behavior.

✨ 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 · 2025-05-05T12:43:27Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/schema

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

@nuxt/rspack-builder

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: b30c7ff

codspeed-hq · 2025-05-05T12:56:04Z

CodSpeed Performance Report

Merging #32003 will not alter performance

_{Comparing fix/custom-cached-data (b30c7ff) with main (32ea93a)}

Summary

✅ 10 untouched benchmarks

…32003)

fix(nuxt): do not clear data if custom getCachedData is provided

b30c7ff

danielroe requested a review from TheAlexLichter May 5, 2025 12:36

github-actions bot added 3.x bug labels May 5, 2025

danielroe merged commit 28661df into main May 8, 2025
47 checks passed

danielroe deleted the fix/custom-cached-data branch May 8, 2025 09:42

This was referenced May 8, 2025

Need to port from upstream nuxt/bridge#1521

Open

v4.0.0 #27716

Merged

danielroe added a commit that referenced this pull request May 8, 2025

fix(nuxt): do not clear data if custom getCachedData is provided (#…

e7ba9f9

…32003)

github-actions bot mentioned this pull request May 8, 2025

v3.17.3 #32025

Merged

danielroe mentioned this pull request May 20, 2025

Utilizing a custom getCachedData implementation with TTL no longer functional as of 3.17.0 #31949

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(nuxt): do not clear data if custom `getCachedData` is provided #32003

fix(nuxt): do not clear data if custom `getCachedData` is provided #32003

Uh oh!

danielroe commented May 5, 2025

Uh oh!

bolt-new-by-stackblitz bot commented May 5, 2025

Uh oh!

coderabbitai bot commented May 5, 2025

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

pkg-pr-new bot commented May 5, 2025

Uh oh!

codspeed-hq bot commented May 5, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(nuxt): do not clear data if custom getCachedData is provided #32003

fix(nuxt): do not clear data if custom getCachedData is provided #32003

Uh oh!

Conversation

danielroe commented May 5, 2025

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented May 5, 2025

Uh oh!

coderabbitai bot commented May 5, 2025

Walkthrough

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pkg-pr-new bot commented May 5, 2025

Uh oh!

codspeed-hq bot commented May 5, 2025

CodSpeed Performance Report

Merging #32003 will not alter performance

Summary

Uh oh!

Uh oh!

Uh oh!

fix(nuxt): do not clear data if custom `getCachedData` is provided #32003

fix(nuxt): do not clear data if custom `getCachedData` is provided #32003

CodeRabbit Configuration File (`.coderabbit.yaml`)