Skip to content

fix(nuxt): trigger call once navigation even when no suspense #32827

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 3 commits into from
Aug 4, 2025

Conversation

danielroe
Copy link
Member

🔗 Linked issue

resolves #32811

📚 Description

page:start is only called when suspense initiates, meaning the previous implementation did not reset callOnce when synchronous navigation took place.

was there a reason we didn't use the router originally @TheAlexLichter?

@danielroe danielroe requested a review from TheAlexLichter July 31, 2025 07:15
Copy link

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

Copy link

coderabbitai bot commented Jul 31, 2025

Walkthrough

The changes update the mechanism by which the callOnce composable in a Nuxt application resets its state on navigation. The internal implementation now registers two hooks: one on the Nuxt app's 'page:start' event and another on the Vue Router's beforeResolve navigation guard, both sharing a cleanup callback that unregisters the hooks after execution. This replaces the previous single-use hook approach. Correspondingly, the test suite for this composable updates its navigation simulation by replacing a manual Nuxt hook trigger with an actual route navigation using navigateTo('/test'). No changes were made to the public API or exported declarations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 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 13a4336 and 0bd097f.

📒 Files selected for processing (1)
  • packages/nuxt/src/app/composables/once.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/nuxt/src/app/composables/once.ts
✨ 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/call-once-navigation

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

Copy link

pkg-pr-new bot commented Jul 31, 2025

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 0bd097f

Copy link

codspeed-hq bot commented Jul 31, 2025

CodSpeed Performance Report

Merging #32827 will not alter performance

Comparing fix/call-once-navigation (0bd097f) with main (052b98a)

Summary

✅ 10 untouched benchmarks

@TheAlexLichter
Copy link
Member

The only scenario I could think of that could be different would be triggering when a pageKey is set - but I've never tried it together with callOnce.

@danielroe danielroe merged commit 44c231c into main Aug 4, 2025
117 of 121 checks passed
@danielroe danielroe deleted the fix/call-once-navigation branch August 4, 2025 14:19
This was referenced Aug 4, 2025
This was referenced Aug 5, 2025
@thenetwrx
Copy link

@danielroe this doesn't solve the issue unless the behavior you expect is different from what i thought in the original issue. The repro is still the same but with nuxt dependency set at 4.0.3. the callback is still not executed on client side routing

@danielroe
Copy link
Member Author

callOnce does not automatically re-call the handler, and you called it in app.vue setup, which only runs once.

you could recall it in a watcher.

@thenetwrx
Copy link

I'm trying not to sound passive aggressive, but the docs say it will, specifically on client side navigation. What is the difference between the modes and importantly what should occur?

@danielroe
Copy link
Member Author

the docs may be unclear

the idea is if you call it in a page it will only run again if mode: navigation is set

it won't automatically run on navigation - you have to call it again

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.

callOnce navigation mode not working as expected
3 participants