Skip to content

test: add case for key only changes with immediate: false #32473

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 25, 2025

Conversation

OrbisK
Copy link
Collaborator

@OrbisK OrbisK commented Jun 25, 2025

🔗 Linked issue

📚 Description

This PR introduces a small test for asyncData to track the immediate: false behaviour when key is changed, without altering any watch sources.

@Copilot Copilot AI review requested due to automatic review settings June 25, 2025 11:56
@OrbisK OrbisK requested a review from danielroe as a code owner June 25, 2025 11:56
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds tests to verify that useAsyncData behaves correctly when the key changes while immediate is set to false, and introduces a new (incomplete) test case for useFetch refetch behavior.

  • Added a test in useAsyncData to ensure that no execution occurs when only the key changes with immediate: false.
  • Introduced a placeholder test for useFetch refetch behavior.
Comments suppressed due to low confidence (1)

test/nuxt/composables.test.ts:916

  • The test case 'should refetch' appears incomplete with no implementation or assertions. Consider completing the test to ensure it covers the intended refetch behavior.
  it('should refetch ')

Comment on lines 915 to 916

it('should refetch ')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
it('should refetch ')

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to add the same test for useFetch, but since we are using experimental.alwaysRunFetchOnKeyChange: true for tests, so I had to test the opposite. 👍🏽

Copy link

coderabbitai bot commented Jun 25, 2025

Walkthrough

Two new test cases were added to the test suite. The first test in the useAsyncData suite verifies that when the immediate option is set to false, changing only the reactive key does not trigger execution of the async data fetch function, with the status remaining 'idle'. The second test in the useFetch suite checks that with immediate: false and a reactive key, changing the key triggers a fetch, indicated by the status changing from 'idle' to 'pending'. There were no changes to any 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 7e1bf06 and 9297a67.

📒 Files selected for processing (1)
  • test/nuxt/composables.test.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • test/nuxt/composables.test.ts
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • 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 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d9e57c6 and 7e1bf06.

📒 Files selected for processing (1)
  • test/nuxt/composables.test.ts (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.ts`: Follow standard TypeScript conventions and best practices

**/*.ts: Follow standard TypeScript conventions and best practices

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

  • test/nuxt/composables.test.ts
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: codeql (javascript-typescript)
  • GitHub Check: codeql (actions)
  • GitHub Check: build
  • GitHub Check: code
🔇 Additional comments (1)
test/nuxt/composables.test.ts (1)

747-759: Well-implemented test case for the specified scenario.

This test correctly validates that when immediate: false is set, changing only the reactive key does not trigger the async data fetch function. The implementation properly uses mocking, reactive refs, and appropriate assertions to verify the expected behaviour.

Copy link

pkg-pr-new bot commented Jun 25, 2025

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 9297a67

Copy link

codspeed-hq bot commented Jun 25, 2025

CodSpeed Performance Report

Merging #32473 will not alter performance

Comparing OrbisK:test/async-data-immediate (9297a67) with main (d9e57c6)

Summary

✅ 10 untouched benchmarks

@danielroe danielroe merged commit 24e663f into nuxt:main Jun 25, 2025
46 checks passed
@github-actions github-actions bot mentioned this pull request Jun 24, 2025
@github-actions github-actions bot mentioned this pull request Jul 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants