Skip to content

fix(nuxt): reset page:loading:end hook before navigation #31504

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 7 commits into from
Mar 25, 2025

Conversation

Akryum
Copy link
Contributor

@Akryum Akryum commented Mar 22, 2025

🔗 Linked issue

Maybe a regression from #29009

📚 Description

  1. Go to a nested page
  2. Go to the same page with a new query param
  3. Go to a different nested page (sibling)

The nuxt loading indicator is stuck loading forever because the page:loading:end hook is not triggered.

This seems to be caused by the condition on pageLoadingEndHookAlreadyCalled which is true:

if (!pageLoadingEndHookAlreadyCalled) {

I have added in this PR a new test that currently fails and demonstrates the issue.

Copy link

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

Copy link

pkg-pr-new bot commented Mar 22, 2025

Open in Stackblitz

@nuxt/kit

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

nuxt

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

@nuxt/schema

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

@nuxt/rspack-builder

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 3f6a3b5

Copy link

codspeed-hq bot commented Mar 22, 2025

CodSpeed Performance Report

Merging #31504 will not alter performance

Comparing Akryum:fix/page-loading-hooks-not-fired (3f6a3b5) with main (c89e603)

Summary

✅ 10 untouched benchmarks

@Akryum Akryum marked this pull request as ready for review March 22, 2025 16:47
@Akryum Akryum requested a review from danielroe as a code owner March 22, 2025 16:47
Copy link

coderabbitai bot commented Mar 22, 2025

Walkthrough

The changes introduce additional logic to manage page loading events in a Nuxt application. In the runtime page component, a new conditional block checks for a client environment and sets up a router navigation guard that resets a flag associated with the loading end hook on every route change. A lifecycle hook is added to remove this subscription when the component unmounts, and a new variable refines the condition for triggering the hook, particularly when nested routes are involved. In the loading indicator composable, any pre-existing timeouts are cleared before starting a new loading process. Additionally, a new test file has been introduced to validate the loading indicator's behaviour during asynchronous route transitions.


📜 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 e025b58 and 3f6a3b5.

📒 Files selected for processing (3)
  • packages/nuxt/src/app/composables/loading-indicator.ts (1 hunks)
  • packages/nuxt/src/pages/runtime/page.ts (4 hunks)
  • test/nuxt/loading-indicator.test.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/nuxt/src/pages/runtime/page.ts
🧰 Additional context used
🧬 Code Definitions (1)
test/nuxt/loading-indicator.test.ts (1)
packages/nuxt/src/app/composables/loading-indicator.ts (1)
  • useLoadingIndicator (170-188)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: codeql (actions)
  • GitHub Check: code
🔇 Additional comments (5)
packages/nuxt/src/app/composables/loading-indicator.ts (1)

52-56: Good fix to clear timeouts before starting a new loading process.

Adding the _clearTimeouts() call at the beginning of the start method ensures that any existing timeouts related to hiding or resetting the loading indicator are properly cleared before initiating a new loading process. This prevents potential race conditions where timeouts from previous loading operations could interfere with new ones.

This fix directly addresses the issue where the loading indicator could get stuck in a loading state during certain navigation patterns, particularly when navigating between nested pages with query parameters.

test/nuxt/loading-indicator.test.ts (4)

1-129: Excellent test coverage for the loading indicator bug

This new test file thoroughly validates the fix for the loading indicator issue. The test specifically reproduces the problematic navigation pattern (nested page → same page with query parameter → different sibling nested page) that was causing the loading indicator to remain stuck.

The test structure is well-organised:

  • It sets up a router with nested routes that simulate asynchronous loading
  • It tracks loading state through hooks to verify start/end events are properly triggered
  • The expectNavigatesWithLoading helper function encapsulates the navigation logic and assertions
  • The test validates both the internal loading state and the visual representation of the loading indicator

This test will help prevent regression of this issue in the future.


73-98: Well-implemented navigation testing helper function

The expectNavigatesWithLoading function is a great example of test code reuse. It encapsulates all the necessary steps to validate the loading indicator's behaviour during navigation:

  1. Resetting counters before navigation
  2. Verifying that loading has started but not yet completed
  3. Checking the visual state of the loading indicator
  4. Allowing for custom assertions during the loading phase
  5. Waiting for loading to complete
  6. Verifying loading has properly finished
  7. Checking the final visual state of the loading indicator

This approach makes the test more readable and maintainable.


60-65: Good use of hook counters to track loading events

Using counters to track the number of times the loading hooks are triggered is an effective way to verify that the hooks are being called correctly. This approach helps ensure that:

  1. The page:loading:start hook is triggered exactly once per navigation
  2. The page:loading:end hook is also triggered exactly once per navigation
  3. No extra or missing hook calls occur during the test

This is crucial for validating the fix for the loading indicator issue, where the bug was specifically related to the end hook not being triggered.


109-125: Comprehensive test coverage for the specific bug scenario

This portion of the test directly addresses the bug scenario described in the PR objectives:

  1. Navigate to a nested page (/page-load-hook/subpage)
  2. Navigate to the same page with a new query parameter (?someQuery=toto)
  3. Navigate to a different sibling nested page (/page-load-hook/other-slug)

The test verifies that the loading indicator correctly shows and hides during each navigation step. This is exactly the scenario where the loading indicator was getting stuck, so this test provides confidence that the fix works as expected.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@danielroe danielroe changed the title fix: page:loading:end hook not triggered fix(nuxt): reset page:loading:end hook before navigation Mar 25, 2025
@danielroe danielroe requested a review from huang-julien March 25, 2025 10:03
@danielroe danielroe merged commit 1cc4b68 into nuxt:main Mar 25, 2025
46 checks passed
@github-actions github-actions bot mentioned this pull request Mar 25, 2025
@github-actions github-actions bot mentioned this pull request Mar 25, 2025
@Akryum Akryum deleted the fix/page-loading-hooks-not-fired branch April 9, 2025 14:35
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
pFad - Phonifier reborn

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

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy