fix(nuxt): retain old data when computed key changes #32616

danielroe · 2025-07-14T20:46:03Z

🔗 Linked issue

resolves #31999

📚 Description

this preserves the current state of asyncData when fetching new data after a computed key changes. (it might be possible to build on it to solve #32102 by updating key but not updating contents if watch: false is set.

bolt-new-by-stackblitz · 2025-07-14T20:46:06Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-07-14T20:48:23Z

Walkthrough

The changes update the logic in the Nuxt async data composable to improve how cached data is handled when the async data key changes. Now, when the key changes and the previous key's data has already been fetched, that data is reused as the initial cached data for the new key. If no previous data exists, the system falls back to fetching cached data using the provided method. Additionally, a new test case was added to verify that the old data is retained until the new asynchronous fetch resolves when the key changes, ensuring expected behaviour during key transitions. No changes were made to exported or public entity declarations.

📜 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 281b559 and fbd5bbe.

📒 Files selected for processing (2)

packages/nuxt/src/app/composables/asyncData.ts (1 hunks)
test/nuxt/use-async-data.test.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

**/*.{ts,tsx}

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

.github/copilot-instructions.md

**/*.{ts,tsx,vue}

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

.github/copilot-instructions.md

**/*.{test,spec}.{ts,tsx}

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

.github/copilot-instructions.md

🧠 Learnings (3)

📓 Common learnings

Learnt from: Tofandel
PR: nuxt/nuxt#0
File: :0-0
Timestamp: 2024-11-11T12:34:22.648Z
Learning: Ensure that AI-generated summaries accurately reflect the key changes in the PR, focusing on notable changes such as the removal of unused imports and variables starting with underscores.

Learnt from: huang-julien
PR: nuxt/nuxt#29366
File: packages/nuxt/src/app/components/nuxt-root.vue:16-19
Timestamp: 2024-12-12T12:36:34.871Z
Learning: In `packages/nuxt/src/app/components/nuxt-root.vue`, when optimizing bundle size by conditionally importing components based on route metadata, prefer using inline conditional imports like:

```js
const IsolatedPage = route?.meta?.isolate ? defineAsyncComponent(() => import('#build/isolated-page.mjs')) : null
```

instead of wrapping the import in a computed property or importing the component unconditionally.

test/nuxt/use-async-data.test.ts (1)

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-30T13:48:28.134Z
Learning: Applies to **/*.{test,spec}.{ts,tsx} : Write unit tests for core functionality using vitest

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

Learnt from: huang-julien
PR: nuxt/nuxt#29366
File: packages/nuxt/src/app/components/nuxt-root.vue:16-19
Timestamp: 2024-12-12T12:36:34.871Z
Learning: In `packages/nuxt/src/app/components/nuxt-root.vue`, when optimizing bundle size by conditionally importing components based on route metadata, prefer using inline conditional imports like:

```js
const IsolatedPage = route?.meta?.isolate ? defineAsyncComponent(() => import('#build/isolated-page.mjs')) : null
```

instead of wrapping the import in a computed property or importing the component unconditionally.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

GitHub Check: build
GitHub Check: code

🔇 Additional comments (2)

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

336-343: Excellent implementation of data retention during key transitions.

The logic correctly prioritises reusing resolved data from the old key when transitioning to a new key, only falling back to getCachedData when no previous data exists. This prevents flickering and provides a smoother user experience when reactive keys change.

Note that initialFetchOptions.cachedData is only set when using getCachedData, which is correct behaviour as the old data doesn't need to be passed through the cached data mechanism.

test/nuxt/use-async-data.test.ts (1)

720-743: Comprehensive test coverage for key change behaviour.

The test case thoroughly validates the new data retention behaviour when computed keys change. It properly:

Uses fake timers to control async resolution timing

Verifies that old data persists during key transitions

Confirms new data eventually replaces old data after async resolution

Validates correct fetch function call counts

This test case directly validates the implementation changes and ensures the feature works as expected.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch fix/retained-data

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 auto-generate unit tests to generate unit tests for 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-07-14T20:49:41Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: fbd5bbe

codspeed-hq · 2025-07-14T21:00:55Z

CodSpeed Performance Report

Merging #32616 will not alter performance

_{Comparing fix/retained-data (fbd5bbe) with main (281b559)}

Summary

✅ 10 untouched benchmarks

danielroe added 2 commits July 14, 2025 22:38

fix(nuxt): retain old data when computed key changes

53ecae5

test: reset timers

fbd5bbe

danielroe requested review from TheAlexLichter and OrbisK July 14, 2025 20:46

github-actions bot added 4.x bug labels Jul 14, 2025

TheAlexLichter approved these changes Jul 15, 2025

View reviewed changes

danielroe merged commit 8a5309e into main Jul 15, 2025
83 of 84 checks passed

danielroe deleted the fix/retained-data branch July 15, 2025 06:34

This was referenced Jul 15, 2025

retain old data when computed key changes nuxt/bridge#1568

Open

v4.0.0 #27716

Merged

danielroe added a commit that referenced this pull request Jul 21, 2025

fix(nuxt): retain old data when computed key changes (#32616)

ecdd014

This was referenced Jul 21, 2025

v3.17.8 #32610

Closed

v3.18.0 #32713

Merged

GerryWilko mentioned this pull request Aug 1, 2025

useNuxtData has data from unrelated key when using reactive keys and useAsyncData #32836

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(nuxt): retain old data when computed key changes #32616

fix(nuxt): retain old data when computed key changes #32616

Uh oh!

danielroe commented Jul 14, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Jul 14, 2025

Uh oh!

coderabbitai bot commented Jul 14, 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 Jul 14, 2025

Uh oh!

codspeed-hq bot commented Jul 14, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(nuxt): retain old data when computed key changes #32616

fix(nuxt): retain old data when computed key changes #32616

Uh oh!

Conversation

danielroe commented Jul 14, 2025

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Jul 14, 2025

Uh oh!

coderabbitai bot commented Jul 14, 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 Jul 14, 2025

Uh oh!

codspeed-hq bot commented Jul 14, 2025

CodSpeed Performance Report

Merging #32616 will not alter performance

Summary

Uh oh!

Uh oh!

Uh oh!

CodeRabbit Configuration File (`.coderabbit.yaml`)