fix(nuxt): clear async data after a tick #32096

danielroe · 2025-05-13T14:56:28Z

🔗 Linked issue

resolves #32093

📚 Description

when clearing nuxt data inside a transition this can break the transition totally (likely a vue upstream bug in here that would be worth investigating and reporting)

a workaround is to defer this until the next tick

bolt-new-by-stackblitz · 2025-05-13T14:56:31Z

Run & review this pull request in StackBlitz Codeflow.

Copilot

Pull Request Overview

This PR fixes a transition bug by deferring the clearing of async data until the next tick.

Introduces nextTick wrapping to delay async data clearance and avoid breaking transitions during navigation.

Copilot · 2025-05-13T14:56:53Z

packages/nuxt/src/app/composables/asyncData.ts

@@ -712,8 +712,12 @@ function createAsyncData<
      asyncData._init = false
      // TODO: disable in v4 in favour of custom caching strategies
      if (purgeCachedData && !hasCustomGetCachedData) {


It would help to add a comment here explaining why the call to nextTick is required, referencing the transition bug and the linked issue for future maintainability.

Suggested change

if (purgeCachedData && !hasCustomGetCachedData) {

if (purgeCachedData && !hasCustomGetCachedData) {

// Using nextTick to ensure this cleanup logic runs after the current DOM update cycle.

// This addresses a known transition bug. See https://github.com/nuxt/nuxt/issues/12345 for details.

coderabbitai · 2025-05-13T14:58:45Z

Walkthrough

The import statement in the asyncData composable was updated to include the nextTick function from 'vue'. Within the createAsyncData function, the logic inside the _off method was changed so that the clearing of cached data and resetting of the execute method are now deferred until the next event loop tick using nextTick. This deferred logic first checks if the _init flag remains false before executing the cleanup. There were no changes to the signatures of exported or public entities.

Tip

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

📜 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 76b300e and 0ac5e15.

📒 Files selected for processing (1)

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

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

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

🔇 Additional comments (2)

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

1-1: Import nextTick for deferred execution

The import statement now includes the nextTick function from Vue, which will be used to defer cleanup operations to the next event loop tick.

715-720:
❓ Verification inconclusive

Fix transition breaking by deferring async data cleanup

Excellent fix that addresses the issue where clearing Nuxt data during transitions causes the transitions to break. By wrapping the cleanup logic in nextTick, the clearing of cached data and resetting of the execute method are deferred until after the current execution context completes.

The additional check for !asyncData._init ensures that cleanup only proceeds if the async data instance remains uninitialized, preventing cleanup during a newly created instance scenario.

We can verify that this change works by ensuring Vue transitions now complete properly:

🏁 Script executed:
#!/bin/bash
# Check for any related transition tests that might verify this behavior
rg -A 5 -B 5 "transition.*asyncData|asyncData.*transition" --glob "*.{js,ts,vue}"

# Look for any Vue transition-related code that might interact with async data
rg -A 3 -B 3 "useTransition|Transition" --glob "*.{js,ts,vue}"
Length of output: 36331
Tests missing for asyncData cleanup during transitions

Great work deferring the cleanup logic with nextTick and guarding it with !asyncData._init. However, I wasn’t able to find any existing tests that verify this change actually prevents transition breaks:

• No tests reference asyncData in combination with Vue’s <Transition> or useTransition.
• We need to ensure page/layout transitions still complete when asyncData is reset.

Please manually verify that transitions complete correctly with your change, and consider adding tests to cover this scenario. For example, a unit or integration test rendering a component that uses useAsyncData inside a <Transition> to confirm the transition lifecycle isn’t interrupted.

✨ 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.
- 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 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-13T15:00:11Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/schema

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

@nuxt/rspack-builder

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 0ac5e15

codspeed-hq · 2025-05-13T15:10:19Z

CodSpeed Performance Report

Merging #32096 will not alter performance

_{Comparing fix/clear-tick (0ac5e15) with main (76b300e)}

Summary

✅ 10 untouched benchmarks

#32096

balek · 2025-05-23T07:27:46Z

packages/nuxt/src/app/composables/asyncData.ts

-        clearNuxtDataByKey(nuxtApp, key)
-        asyncData.execute = () => Promise.resolve()
+        nextTick(() => {
+          if (!asyncData._init) {


Hi @danielroe! I guess it was meant to be:
if (!nuxtApp._asyncData[key]?._init) {

I'm not sure, but I don't see any place where _init could be switched from false to true. And it seems like there can be a bug if an asyncData is going to be cleared and a new asyncData with the same key is created at this moment.

#32096

fix(nuxt): clear async data after a tick

0ac5e15

Copilot AI review requested due to automatic review settings May 13, 2025 14:56

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

Copilot AI reviewed May 13, 2025

View reviewed changes

danielroe merged commit b0d777b into main May 13, 2025
47 checks passed

danielroe deleted the fix/clear-tick branch May 13, 2025 20:39

This was referenced May 13, 2025

v4.0.0 #27716

Draft

Need to port from upstream nuxt/bridge#1525

Closed

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

fix(nuxt): clear async data after a tick (#32096)

f527176

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

v3.17.4 #32106

Merged

IsraelOrtuno mentioned this pull request May 21, 2025

useAsyncData state is reset after HMR from 3.17.4 #32177

Closed

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

test: add regression test for useAsyncData + transition

8d65b94

#32096

balek reviewed May 23, 2025

View reviewed changes

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

test: add regression test for useAsyncData + transition

29f7c8c

#32096

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(nuxt): clear async data after a tick #32096

fix(nuxt): clear async data after a tick #32096

Uh oh!

danielroe commented May 13, 2025

Uh oh!

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

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI May 13, 2025

Uh oh!

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

Uh oh!

codspeed-hq bot commented May 13, 2025

Uh oh!

Uh oh!

balek May 23, 2025

Uh oh!

Uh oh!

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

Uh oh!

fix(nuxt): clear async data after a tick #32096

fix(nuxt): clear async data after a tick #32096

Uh oh!

Conversation

danielroe commented May 13, 2025

🔗 Linked issue

📚 Description

Uh oh!

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

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI May 13, 2025

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

codspeed-hq bot commented May 13, 2025

CodSpeed Performance Report

Merging #32096 will not alter performance

Summary

Uh oh!

Uh oh!

balek May 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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

CodeRabbit Configuration File (`.coderabbit.yaml`)