Prerequisites
Ionic Framework Version
v8.x
Current Behavior
In production we consistently see this unhandled error coming from the iOS swipe-back gesture (Angular + Capacitor app, mode: 'ios'):
TypeError: Cannot read properties of undefined (reading 'animationBuilder')
at StackController.startBackTransition (@ionic/angular/fesm2022/ionic-angular-common.mjs)
Stack trace (from Sentry, @ionic/angular 8.7.17):
node_modules/@ionic/core/components/index3.js (pointerMove)
node_modules/@ionic/core/components/index3.js (tryToCapturePan)
node_modules/@ionic/core/components/index3.js (fireOnStart)
node_modules/@ionic/core/components/ion-router-outlet.js (onStart)
node_modules/@ionic/angular/fesm2022/ionic-angular-common.mjs (StackController.startBackTransition)
const customAnimation = enteringView.animationBuilder;
The root cause is a race between canStart and onStart of the swipe-back gesture:
canStart runs at pointer-down and checks this.stackCtrl.canGoBack(1) && !this.stackCtrl.hasRunningTask() (
|
this.nativeEl.swipeHandler = swipe |
|
? { |
|
canStart: () => this.stackCtrl.canGoBack(1) && !this.stackCtrl.hasRunningTask(), |
|
onStart: () => this.stackCtrl.startBackTransition(), |
|
onEnd: (shouldContinue) => this.stackCtrl.endBackTransition(shouldContinue), |
)
onStart runs later, only once the pan gesture passes the capture threshold (pointerMove -> tryToCapturePan -> fireOnStart)
If a navigation pops the stack in that window (for example a programmatic navCtrl.back() finishing, a guard redirect, or a route replace), by the time onStart fires the stack contains a single view, so in startBackTransition views[views.length - 2] is undefined and the next line throws:
|
startBackTransition(): Promise<boolean> | Promise<void> { |
|
const leavingView = this.activeView; |
|
if (leavingView) { |
|
const views = this.getStack(leavingView.stackId); |
|
const enteringView = views[views.length - 2]; |
|
const customAnimation = enteringView.animationBuilder; |
startBackTransition(): Promise<boolean> | Promise<void> {
const leavingView = this.activeView;
if (leavingView) {
const views = this.getStack(leavingView.stackId);
const enteringView = views[views.length - 2]; // undefined when the stack has 1 view
const customAnimation = enteringView.animationBuilder; // TypeError
Because it is a narrow timing window it is rare per user (almost always 1 event per user), but at our traffic volume it produces a steady stream of unhandled errors: roughly 200 events from about 200 users in the last 90 days, on both WebKit ("undefined is not an object (evaluating 'enteringView.animationBuilder')") and V8 ("Cannot read properties of undefined") engines. We have been seeing it continuously from Ionic 7 through 8.7.17, and the unguarded line is still present on current main.
Expected Behavior
When the entering view no longer exists at gesture-capture time, the swipe-back should be a no-op (same as when canStart returns false), not an unhandled TypeError, e.g.:
const enteringView = views[views.length - 2];
if (!enteringView) {
return Promise.resolve();
}
This would match every other consumer of the stack (canGoBack, pop, getLastUrl), all of which check the stack length before indexing into it.
Steps to Reproduce
The bug is a race, so it does not reproduce on every attempt, but the window can be hit with the standard Angular starter (blank template plus one pushed page) on an iOS device or simulator:
- Navigate from page A to page B (stack now has 2 views).
- Tap a button that calls
navCtrl.back() (or any navigation that pops/replaces the stack).
- Immediately, before the back navigation completes, start a left-edge swipe and keep the finger moving.
- When the pan gesture is captured after the threshold,
onStart calls startBackTransition() on a stack that now has a single view and it throws.
The defect is also visible statically: startBackTransition guards leavingView but not enteringView.
Code Reproduction URL
No repository; the race is timing-dependent and fully explained by the linked source lines above (standard Angular starter + the steps from "Steps to Reproduce").
Ionic Info
Ionic:
@ionic/angular: 8.7.17
@ionic/core: 8.7.17
Angular: 20.3.25
Capacitor:
@capacitor/core: 8.3.3
Platforms: iOS and Android (Capacitor WebView, app runs in ios mode)
Additional Information
No response
Prerequisites
Ionic Framework Version
v8.x
Current Behavior
In production we consistently see this unhandled error coming from the iOS swipe-back gesture (Angular + Capacitor app,
mode: 'ios'):Stack trace (from Sentry, @ionic/angular 8.7.17):
The root cause is a race between
canStartandonStartof the swipe-back gesture:canStartruns at pointer-down and checksthis.stackCtrl.canGoBack(1) && !this.stackCtrl.hasRunningTask()(ionic-framework/packages/angular/common/src/directives/navigation/router-outlet.ts
Lines 104 to 108 in b716c1c
onStartruns later, only once the pan gesture passes the capture threshold (pointerMove -> tryToCapturePan -> fireOnStart)If a navigation pops the stack in that window (for example a programmatic
navCtrl.back()finishing, a guard redirect, or a route replace), by the timeonStartfires the stack contains a single view, so instartBackTransitionviews[views.length - 2]isundefinedand the next line throws:ionic-framework/packages/angular/common/src/directives/navigation/stack-controller.ts
Lines 180 to 185 in b716c1c
Because it is a narrow timing window it is rare per user (almost always 1 event per user), but at our traffic volume it produces a steady stream of unhandled errors: roughly 200 events from about 200 users in the last 90 days, on both WebKit ("undefined is not an object (evaluating 'enteringView.animationBuilder')") and V8 ("Cannot read properties of undefined") engines. We have been seeing it continuously from Ionic 7 through 8.7.17, and the unguarded line is still present on current
main.Expected Behavior
When the entering view no longer exists at gesture-capture time, the swipe-back should be a no-op (same as when
canStartreturns false), not an unhandled TypeError, e.g.:This would match every other consumer of the stack (
canGoBack,pop,getLastUrl), all of which check the stack length before indexing into it.Steps to Reproduce
The bug is a race, so it does not reproduce on every attempt, but the window can be hit with the standard Angular starter (blank template plus one pushed page) on an iOS device or simulator:
navCtrl.back()(or any navigation that pops/replaces the stack).onStartcallsstartBackTransition()on a stack that now has a single view and it throws.The defect is also visible statically:
startBackTransitionguardsleavingViewbut notenteringView.Code Reproduction URL
No repository; the race is timing-dependent and fully explained by the linked source lines above (standard Angular starter + the steps from "Steps to Reproduce").
Ionic Info
Ionic:
@ionic/angular: 8.7.17
@ionic/core: 8.7.17
Angular: 20.3.25
Capacitor:
@capacitor/core: 8.3.3
Platforms: iOS and Android (Capacitor WebView, app runs in ios mode)
Additional Information
No response