bug: react-router, redirecting from a pushed tab route leaves a second tab outlet visible on top

Ouverte
#31,709 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
55/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
Active
Stack technique
react, typescript
Domaine
frontend

Piste de recherche

Start with packages/react-router/src/ReactRouter/StackManager.tsx, especially transitionPage, runCommit, and the ionPageWaitTimeout fallback. Trace both redirect timings in the linked reproduction: the proposed change addresses the stale animated commit, while the immediate redirect still leaves the previous tab visible. Done means both paths leave only the page for the current pathname visible; add or run focused React Router tests for both cases.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

package: react type: bug
Prerequisites
Ionic Framework Version

v9.x

Current Behavior

When the app pushes a route in an IonTabs outlet and that route immediately redirects
(for example an auth guard that renders <Navigate replace to="/login" />), the tabs
outlet can end up with two pages that are not hidden. No error is thrown and the URL is
correct.

<ion-router-outlet class="apple-outlet ion-page can-go-back" style="z-index: 101;">…</ion-router-outlet>
<ion-router-outlet class="banana-outlet ion-page can-go-back" style="z-index: 101;"></ion-router-outlet>

Which page is left visible depends on how soon the redirect follows the push:

  • Path A: the redirect lands while the forward transition to the redirecting route
    is still running. The empty ionPage outlet of the redirecting route is left visible
    on top. It is transparent, so the screen looks right, but it takes every click: the
    app stops responding to taps on the page, and after switching tabs, the other tab's
    buttons cannot be pressed either.
  • Path B: the redirect lands before the redirecting route's page registers. The tab
    the user pushed from is never hidden. It keeps no ion-page-hidden or aria-hidden.
    In the reproduction it sits behind the new page and is cleared when that tab is
    pressed again.
Expected Behavior

After the redirect, only the page for the current pathname is visible in the tabs
outlet. The redirecting route's outlet and the tab the user pushed from are both hidden.

Steps to Reproduce
  1. Clone the reproduction, check out stale-commit-reshows-entering-page, then run
    npm install and npm run dev.
  2. Open /apple. The Apple tab is shown.
  3. Press the Orange tab.
  4. Press Redirect after 10 ms. The app calls
    router.push('/banana/redirect?delay=10', 'forward', 'push'). That route renders
    <Navigate replace to="/apple" /> after 10 ms.
  5. Observe: the URL is /apple and the Apple page is shown, but the status bar above the
    tab bar reports 10 ms: apple + banana (empty) ← BUG path A. Clicking the Apple page
    hits the empty banana-outlet element. Press the Orange tab: the Orange page is
    shown, but its buttons do not respond.
  6. Reload, then repeat steps 3–4 with Redirect after 0 ms. Observe:
    0 ms: apple + orange (empty) ← BUG path B. The Orange outlet is not hidden.

Reload between tries, because path A leaves the page unable to take clicks.

How reliably it reproduces (Chromium, md mode, fresh load each try):

Button Result
Redirect after 0 ms stale 10/10 runs: mostly path B, sometimes path A
Redirect after 10 ms path A 5/5 runs
Redirect after 20 ms path A 4/10 runs
Redirect after 50 ms 5/5 runs correct (control: the transition finishes first)

The timing window depends on the machine. If 10 ms does not show path A, try 0 ms or
20 ms.

The redirecting route must be an ionPage outlet. With a plain
<Route path="/banana/redirect" element={<Navigate … />} /> in the tabs outlet, every
run ends with only Apple visible. The route shape:

<IonRouterOutlet>
  <Route path="*" element={
    <IonTabs>
      <IonRouterOutlet>
        <Route path="/apple/*" element={<IonRouterOutlet ionPage>…</IonRouterOutlet>} />
        <Route path="/orange/*" element={<IonRouterOutlet ionPage>…</IonRouterOutlet>} />
        <Route path="/banana/*" element={
          <IonRouterOutlet ionPage>
            <Route path="redirect" element={<RedirectToApple />} />
          </IonRouterOutlet>
        } />
      </IonRouterOutlet>
      <IonTabBar slot="bottom">…</IonTabBar>
    </IonTabs>
  } />
</IonRouterOutlet>
Code Reproduction URL

https://github.com/ptmkenny/ionic-react-router-6-test/tree/stale-commit-reshows-entering-page

Ionic Info
Ionic:

   Ionic CLI       : 7.2.1 (/home/node/.npm/_npx/f6fddb685269761d/node_modules/@ionic/cli)
   Ionic Framework : @ionic/react 9.0.10

Capacitor:

   Capacitor CLI      : 8.0.0
   @capacitor/android : not installed
   @capacitor/core    : 8.0.0
   @capacitor/ios     : not installed

Utility:

   cordova-res : not installed globally
   native-run  : 2.0.1

System:

   NodeJS : v26.13.0 (/usr/local/bin/node)
   npm    : 11.20.0
   OS     : Linux 6.18
Additional Information

I used AI (Opus 5.5) to prepare this issue report and reproduction.

Root cause

Names below refer to the three ionPage outlets in the reproduction's tabs outlet:

  • Orange (/orange/*): the tab the user is on when the app pushes.
  • Banana (/banana/*): the pushed route. Its only child, redirect, redirects.
  • Apple (/apple/*): the redirect target.

Both paths are in StackManager
(packages/react-router/src/ReactRouter/StackManager.tsx) for the tabs outlet. The
push from Orange to /banana/redirect starts one transition, and the redirect to
/apple starts a second one in the same outlet before the first is done.

Path A: a superseded animated commit shows its entering page.

  1. The push (direction forward) calls transitionPage with the Banana outlet entering
    and the Orange outlet leaving. The transition animates, so runCommit calls
    routerOutlet.commit(), which waits for the entering element to be ready before
    animating.

  2. The redirect (direction none) calls transitionPage again, which increments
    transitionGeneration. It does not animate, so it swaps visibility synchronously:
    Apple is shown, and the Banana outlet gets ion-page-hidden.

  3. The first commit() then runs its animation. Core's transition un-hides its
    entering element (the Banana outlet) and hides its leaving element (Orange).

  4. After the commit, runCommit checks for a newer transition:

    if (myGeneration !== this.transitionGeneration && leavingEl && leavingEl === this.transitionEnteringElement) {
      showIonPageElement(leavingEl);
    }
    

    That repairs a stale hide of the newer transition's page, but nothing re-hides the
    stale transition's own entering page. The Banana outlet stays visible with
    z-index: 101, on top of Apple.

Path B: the leaving view is looked up by the intermediate route.

  1. The push finds the Banana view, which has no page element yet, so
    handlePageTransition waits for its IonPage.
  2. The redirect arrives before the Banana outlet registers. The Apple outlet is ready,
    so the transition runs, but the leaving view is looked up from
    routeInfo.lastPathname, which is /banana/redirect. That view has no page element,
    so transitionPage gets no leaving view and hides nothing.
  3. The Orange outlet, which was visible before the push, is never hidden. Its child page
    is unmounted later, which leaves it empty but still without ion-page-hidden.

The ionPageWaitTimeout fallback in handlePageTransition already handles this for an
entering view that never gets a page. Its comment says it hides all other views because
"intermediate redirects (e.g., Navigate in nested routes) change the leaving view
reference". The path where the entering view is ready has no equivalent.

The transitionGeneration check that path A gets past and the ionPageWaitTimeout
fallback that path B misses were both added with the react-router 6 upgrade (#30831).

Proposed fix

For path A, re-hide the entering page of a superseded commit unless the newer transition
is showing that same page:

       if (myGeneration !== this.transitionGeneration && leavingEl && leavingEl === this.transitionEnteringElement) {
         showIonPageElement(leavingEl);
       }
+
+      /**
+       * A newer transitionPage call ran while this commit was in flight and showed a
+       * different page. The core commit has just made this transition's entering page
+       * visible, so hide it again.
+       */
+      if (myGeneration !== this.transitionGeneration && enteringEl !== this.transitionEnteringElement) {
+        hideIonPageElement(enteringEl);
+      }

Applied to the built @ionic/react-router 9.0.10 in the reproduction, the 10 ms and
20 ms buttons end with only Apple visible in 12/12 runs (6 at each delay). Unpatched,
path A shows in 5/5 runs at 10 ms and 4/10 at 20 ms. It does not affect path B: the
0 ms button still leaves Orange visible in 6/6 runs.

I have not written a fix for path B. A direction would be for the ready-entering-view
path to fall back the way the ionPageWaitTimeout path does when the leaving view
lookup finds no page: hide the other visible views in the outlet.

Langage dominant
TypeScript
Étoiles
52.8k
Forks
13.3k
Merge moyen
3 j 1 h
PR mergées (30 j)
86

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de ionic-team/ionic-framework

Toutes les issues de ionic-team/ionic-framework

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.