fix(nuxt): ensure legacy async data remains reactive #32134

danielroe · 2025-05-17T08:23:35Z

🔗 Linked issue

resolves #29368
closes #29518

📚 Description

this ensures we don't 'freeze' the value in legacy asyncData but keep it reactive

bolt-new-by-stackblitz · 2025-05-17T08:23:38Z

Run & review this pull request in StackBlitz Codeflow.

Copilot

Pull Request Overview

This PR addresses an issue where legacy asyncData values were frozen by ensuring they remain reactive by wrapping each property in computed getters and setters.

Updated asyncData handling in component.ts to wrap properties in computed getters/setters.
Added a new test in composables.test.ts to verify that calling refreshNuxtData properly updates the rendered output.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
test/nuxt/composables.test.ts	Added a test case to validate reactive updates via refreshNuxtData for Options API asyncData.
packages/nuxt/src/app/composables/component.ts	Modified asyncData processing to expose properties as computed values ensuring reactivity.

test/nuxt/composables.test.ts

coderabbitai · 2025-05-17T08:25:46Z

Walkthrough

The changes update the internal logic of the runLegacyAsyncData function in the Nuxt composable, replacing the use of Vue's reactive and toRefs with computed properties for each key in data.value. This adjustment alters how asyncData results are proxied, now using explicit computed getters and setters for reactivity. Additionally, a new test case was added to verify that asyncData remains reactive and updates correctly when refreshNuxtData is called in a component using the Options API. No changes were made to exported or public entity signatures.

📜 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 ea59800 and 3dee6e1.

📒 Files selected for processing (2)

packages/nuxt/src/app/composables/component.ts (2 hunks)
test/nuxt/composables.test.ts (1 hunks)

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

GitHub Check: codeql (javascript-typescript)
GitHub Check: build
GitHub Check: code

🔇 Additional comments (3)

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

1244-1265: Good addition of test coverage for Options API reactivity

This test effectively verifies that the asyncData property remains reactive when using the Options API and can be refreshed via refreshNuxtData(). The test covers a critical edge case by confirming that changes to the data are properly reflected in the rendered output after refresh.

I particularly like that you're:

Testing a real-world use case with incrementing counter values

Directly accessing the internal Vue instance to verify reactivity

Asserting the rendered output before and after the refresh

packages/nuxt/src/app/composables/component.ts (2)

1-1: Updated imports to align with implementation changes

The import statement correctly removes reactive and toRefs while adding computed, which aligns with the implementation changes below.

35-44: Excellent fix for ensuring legacy asyncData remains reactive

This change is the core of the fix that ensures Options API asyncData remains reactive. Rather than using toRefs(reactive(data.value)) which creates a disconnection between the original reactive data and the component, you've implemented a computed property approach that maintains a direct link to the underlying reactive state.

The implementation has several strengths:

Using computed properties with both getters and setters ensures two-way reactivity

The null check with data.value ||= {} in the setter gracefully handles edge cases

Each property independently proxies to its corresponding data value, maintaining granular reactivity

This change addresses the core issue described in PR #32134 by preventing the legacy asyncData from being "frozen" and maintaining its reactivity throughout the component lifecycle.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate Unit Tests

Create PR with Unit Tests
Commit Unit Tests in branch fix/legacy-async-data-refresh
Post Copyable Unit Tests in Comment

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 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-05-17T08:27:19Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/schema

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

@nuxt/rspack-builder

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 3dee6e1

codspeed-hq · 2025-05-17T08:37:24Z

CodSpeed Performance Report

Merging #32134 will not alter performance

_{Comparing fix/legacy-async-data-refresh (3dee6e1) with main (ea59800)}

Summary

✅ 10 untouched benchmarks

danielroe added 2 commits May 17, 2025 10:21

fix(nuxt): ensure legacy async data remains reactive

5da0671

test: remove next tick

3dee6e1

Copilot AI review requested due to automatic review settings May 17, 2025 08:23

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

Copilot AI reviewed May 17, 2025

View reviewed changes

test/nuxt/composables.test.ts Show resolved Hide resolved

danielroe merged commit 7decdf4 into main May 17, 2025
83 of 84 checks passed

danielroe deleted the fix/legacy-async-data-refresh branch May 17, 2025 09:41

This was referenced May 17, 2025

Need to port from upstream nuxt/bridge#1527

Closed

v4.0.0 #27716

Merged

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

fix(nuxt): ensure legacy async data remains reactive (#32134)

1d51019

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

v3.17.4 #32106

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(nuxt): ensure legacy async data remains reactive #32134

fix(nuxt): ensure legacy async data remains reactive #32134

Uh oh!

danielroe commented May 17, 2025

Uh oh!

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

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

coderabbitai bot commented May 17, 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 17, 2025

Uh oh!

codspeed-hq bot commented May 17, 2025

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Uh oh!

fix(nuxt): ensure legacy async data remains reactive #32134

fix(nuxt): ensure legacy async data remains reactive #32134

Uh oh!

Conversation

danielroe commented May 17, 2025

🔗 Linked issue

📚 Description

Uh oh!

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

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

coderabbitai bot commented May 17, 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 17, 2025

Uh oh!

codspeed-hq bot commented May 17, 2025

CodSpeed Performance Report

Merging #32134 will not alter performance

Summary

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

CodeRabbit Configuration File (`.coderabbit.yaml`)