fix(nuxt): do not include components of key in `useFetch` watch sources #31903

danielroe · 2025-04-25T18:44:29Z

🔗 Linked issue

resolves #31896

📚 Description

For some fetch options, they both affect the generation of the hashed key and are manually added via fetchOptions.

This PR:

~~removes auto-generating keys from useFetch (as this was never being used)~~
creates a subset of fetch options to be watched (as the rest are already watched via the now-reactive key

bolt-new-by-stackblitz · 2025-04-25T18:44:32Z

Run & review this pull request in StackBlitz Codeflow.

pkg-pr-new · 2025-04-25T18:48:39Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

@nuxt/schema

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

commit: 5d08db0

coderabbitai · 2025-04-25T18:48:42Z

Walkthrough

The changes in this update focus on the internal implementation of the useFetch, useLazyFetch, and useLazyAsyncData composables in the Nuxt framework, as well as their associated tests. In useFetch, the computed key generation process was streamlined by directly prefixing the hash with '$f' and removing a redundant computed property. The typing of the reactive _fetchOptions object was made explicit, and the logic for determining the watch sources in _asyncDataOptions was updated to conditionally include either _fetchOptions or a function returning a modified version of it, depending on the presence of opts.key. The setting of the private _functionName property in development mode was simplified in both useFetch and useLazyFetch, removing the client/server distinction and using logical assignment. Similarly, in useLazyAsyncData, the _functionName property is now set in all development environments. A new test was also added to verify that useFetch correctly responds to changes in reactive keys. No changes were made to the signatures or declarations of exported or public entities.

📜 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 726bd2f and 5d08db0.

📒 Files selected for processing (1)

packages/nuxt/src/app/composables/fetch.ts (4 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

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

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

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

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

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.

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (2)

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

96-103: Third-argument “autoKey” is now ignored – remove or deprecate explicitly

useFetch() still accepts a third positional argument (passed by useLazyFetch) but it is silently discarded after the refactor.
Leaving a seemingly-supported parameter that has no effect can confuse end-users or internal contributors.

Consider either:

Removing the arg2 parameter entirely (and adjusting useLazyFetch), or

Emitting a deprecation warning when a truthy arg2 is supplied, explaining that custom keys should now be provided via opts.key.

This keeps the public surface predictable and avoids future maintenance surprises.
test/nuxt/composables.test.ts (1)
637-654: Clean up test-specific endpoints to avoid cross-test bleed-through

registerEndpoint adds global handlers that persist for the whole Vitest run.
If another suite registers the same path (/api/initial or /api/updated) with different behaviour, tests may interfere with one another.

Add a teardown to remove or overwrite these endpoints after the case finishes:
const unregisterInitial = registerEndpoint('/api/initial', defineEventHandler(() => ({ url: '/api/initial' })))
const unregisterUpdated = registerEndpoint('/api/updated', defineEventHandler(() => ({ url: '/api/updated' })))

try {
  // ...test logic...
} finally {
  unregisterInitial?.()
  unregisterUpdated?.()
}
(or push the registrations into beforeEach/afterEach).

This keeps the test suite hermetic and prevents flaky failures when tests run in parallel.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 317ced7 and eec2ab9.

📒 Files selected for processing (4)

packages/nuxt/src/app/composables/fetch.ts (3 hunks)
packages/nuxt/src/core/plugins/composable-keys.ts (0 hunks)
packages/schema/src/config/build.ts (0 hunks)
test/nuxt/composables.test.ts (1 hunks)

💤 Files with no reviewable changes (2)

packages/schema/src/config/build.ts
packages/nuxt/src/core/plugins/composable-keys.ts

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

GitHub Check: build
GitHub Check: code

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

codspeed-hq · 2025-04-25T18:58:32Z

CodSpeed Performance Report

Merging #31903 will not alter performance

_{Comparing fix/fetch-watch (5d08db0) with main (c60070b)}

Summary

✅ 10 untouched benchmarks

huang-julien · 2025-04-25T22:15:48Z

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

-  if (!_key.value || typeof _key.value !== 'string') {
-    throw new TypeError('[nuxt] [useFetch] key must be a string: ' + _key.value)
+  const key = computed(() => toValue(opts.key) || ('$f' + hash([typeof _request.value === 'string' ? _request.value : '', ...generateOptionSegments(opts)])))
+  if (!key.value || typeof key.value !== 'string') {


is this still needed ? key should be always Ref<string>

probably not!

…es (#31903)

this reverts #31903

fix(nuxt): do not include components of key in useFetch watch sources

eec2ab9

danielroe requested review from TheAlexLichter and huang-julien April 25, 2025 18:44

github-actions bot added 3.x bug labels Apr 25, 2025

coderabbitai bot reviewed Apr 25, 2025

View reviewed changes

packages/nuxt/src/app/composables/fetch.ts Outdated Show resolved Hide resolved

danielroe added 2 commits April 25, 2025 22:21

fix: use custom function name on client too

b067704

fix: revert removal of auto-key for useFetch

31fe772

huang-julien reviewed Apr 25, 2025

View reviewed changes

danielroe added 2 commits April 26, 2025 11:37

Merge remote-tracking branch 'origin/main' into fix/fetch-watch

726bd2f

fix: use newly-defined reactive

5d08db0

danielroe merged commit bb56d3d into main Apr 26, 2025
81 of 83 checks passed

danielroe deleted the fix/fetch-watch branch April 26, 2025 13:11

This was referenced Apr 26, 2025

Need to port from upstream nuxt/bridge#1503

Open

v4.0.0 #27716

Draft

danielroe added a commit that referenced this pull request Apr 26, 2025

fix(nuxt): do not include components of key in useFetch watch sourc…

dcb126c

…es (#31903)

github-actions bot mentioned this pull request Apr 26, 2025

v3.17.0 #31687

Merged

huang-julien mentioned this pull request Apr 27, 2025

perf(nuxt): remove unecessary type check for useFetch #31910

Merged

danielroe added a commit that referenced this pull request Apr 28, 2025

refactor(nuxt): simplify async data watchers

b44725e

this reverts #31903

danielroe mentioned this pull request Apr 28, 2025

fix(nuxt): reinitialise stale async data #31940

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(nuxt): do not include components of key in `useFetch` watch sources #31903

fix(nuxt): do not include components of key in `useFetch` watch sources #31903

Uh oh!

danielroe commented Apr 25, 2025 •

edited

Loading

Uh oh!

bolt-new-by-stackblitz bot commented Apr 25, 2025

Uh oh!

pkg-pr-new bot commented Apr 25, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Apr 25, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

codspeed-hq bot commented Apr 25, 2025 •

edited

Loading

Uh oh!

huang-julien Apr 25, 2025

Uh oh!

danielroe Apr 26, 2025

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

fix(nuxt): do not include components of key in useFetch watch sources #31903

fix(nuxt): do not include components of key in useFetch watch sources #31903

Uh oh!

Conversation

danielroe commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Apr 25, 2025

Uh oh!

pkg-pr-new bot commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codspeed-hq bot commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #31903 will not alter performance

Summary

Uh oh!

huang-julien Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

danielroe Apr 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

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

fix(nuxt): do not include components of key in `useFetch` watch sources #31903

fix(nuxt): do not include components of key in `useFetch` watch sources #31903

danielroe commented Apr 25, 2025 •

edited

Loading

pkg-pr-new bot commented Apr 25, 2025 •

edited

Loading

coderabbitai bot commented Apr 25, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codspeed-hq bot commented Apr 25, 2025 •

edited

Loading