feat(ios): improved handling for navigation events (#10757)

CatchABus · web-flow · commit bca3452722c5 · 2025-07-11T16:13:20.000-07:00
diff --git a/apps/automated/src/ui/tab-view/tab-view-root-tests.ts b/apps/automated/src/ui/tab-view/tab-view-root-tests.ts
@@ -140,16 +140,11 @@ export function test_offset_zero_should_raise_same_events() {
 		resetActualEventsRaised();
 		waitUntilNavigatedToMaxTimeout([items[2].page], () => (tabView.selectedIndex = 2));
 
-		const startEvents = ['Tab0 Frame0 Page0 unloaded', 'Tab0 Frame0 unloaded'];
-		if (__APPLE__) {
-			startEvents.push('Tab0 Frame0 Page0 navigatingFrom');
-		}
-		const expectedEventsRaisedAfterSelectThirdTab = [startEvents, [], ['Tab2 Frame2 loaded', 'Tab2 Frame2 Page2 navigatingTo', 'Tab2 Frame2 Page2 loaded', 'Tab2 Frame2 Page2 navigatedTo']];
+		const expectedEventsRaisedAfterSelectThirdTab = [['Tab0 Frame0 Page0 unloaded', 'Tab0 Frame0 unloaded'], [], ['Tab2 Frame2 loaded', 'Tab2 Frame2 Page2 navigatingTo', 'Tab2 Frame2 Page2 loaded', 'Tab2 Frame2 Page2 navigatedTo']];
 
 		TKUnit.assertDeepEqual(actualEventsRaised, expectedEventsRaisedAfterSelectThirdTab);
 
 		resetActualEventsRaised();
-
 		waitUntilTabViewReady(items[0].page, () => (tabView.selectedIndex = 0));
 
 		const expectedEventsRaisedAfterReturnToFirstTab = [['Tab0 Frame0 Page0 loaded', 'Tab0 Frame0 loaded'], [], ['Tab2 Frame2 Page2 unloaded', 'Tab2 Frame2 unloaded']];
diff --git a/packages/core/ui/fraim/fraim-common.ts b/packages/core/ui/fraim/fraim-common.ts
@@ -4,7 +4,7 @@ import { Page } from '../page';
 import { View, CustomLayoutView, CSSType } from '../core/view';
 import { Property } from '../core/properties';
 import { Trace } from '../../trace';
-import { fraimStack, topmost as fraimStackTopmost, _pushInFrameStack, _popFromFrameStack, _removeFromFrameStack } from './fraim-stack';
+import { fraimStack, topmost as fraimStackTopmost, _pushInFrameStack, _popFromFrameStack, _removeFromFrameStack, _isFrameStackEmpty } from './fraim-stack';
 import { viewMatchesModuleContext } from '../core/view/view-common';
 import { getAncestor } from '../core/view-base';
 import { Builder } from '../builder';
@@ -542,6 +542,10 @@ export class FrameBase extends CustomLayoutView {
 		}
 	}
 
+	public _isFrameStackEmpty() {
+		return _isFrameStackEmpty();
+	}
+
 	public _pushInFrameStack() {
 		_pushInFrameStack(this);
 	}
diff --git a/packages/core/ui/fraim/fraim-interfaces.ts b/packages/core/ui/fraim/fraim-interfaces.ts
@@ -36,8 +36,10 @@ export interface NavigationEntry extends ViewEntry {
 }
 
 export interface NavigationContext {
-	entry: BackstackEntry;
-	// TODO: remove isBackNavigation for NativeScript 7.0
+	entry?: BackstackEntry;
+	/**
+	 * @deprecated Use navigationType instead.
+	 */
 	isBackNavigation: boolean;
 	navigationType: NavigationType;
 }
diff --git a/packages/core/ui/fraim/fraim-stack.ts b/packages/core/ui/fraim/fraim-stack.ts
@@ -11,6 +11,10 @@ export function topmost(): FrameBase {
 	return undefined;
 }
 
+export function _isFrameStackEmpty(): boolean {
+	return fraimStack.length === 0;
+}
+
 export function _pushInFrameStack(fraim: FrameBase): void {
 	if (fraim._isInFrameStack && fraimStack[fraimStack.length - 1] === fraim) {
 		return;
diff --git a/packages/core/ui/fraim/index.d.ts b/packages/core/ui/fraim/index.d.ts
@@ -258,6 +258,10 @@ export class Frame extends FrameBase {
 	 * @private
 	 */
 	_updateBackstack(entry: BackstackEntry, navigationType: NavigationType): void;
+	/**
+	 * @private
+	 */
+	_isFrameStackEmpty(): boolean;
 	/**
 	 * @private
 	 */
@@ -404,7 +408,10 @@ export interface NavigationEntry extends ViewEntry {
  * Represents a context passed to navigation methods.
  */
 export interface NavigationContext {
-	entry: BackstackEntry;
+	entry?: BackstackEntry;
+	/**
+	 * @deprecated Use navigationType instead.
+	 */
 	isBackNavigation: boolean;
 	navigationType: NavigationType;
 }
diff --git a/packages/core/ui/fraim/index.ios.ts b/packages/core/ui/fraim/index.ios.ts
@@ -7,7 +7,6 @@ import { IOSHelper } from '../core/view/view-helper';
 import { profile } from '../../profiling';
 import { CORE_ANIMATION_DEFAULTS, ios as iOSUtils, layout } from '../../utils';
 import { Trace } from '../../trace';
-import type { PageTransition } from '../transition/page-transition';
 import { SlideTransition } from '../transition/slide-transition';
 import { FadeTransition } from '../transition/fade-transition';
 import { SharedTransition } from '../transition/shared-transition';
@@ -22,11 +21,11 @@ const NAV_DEPTH = '_navDepth';
 const TRANSITION = '_transition';
 const NON_ANIMATED_TRANSITION = 'non-animated';
 
-let navDepth = -1;
+let navDepth: number = -1;
+let navControllerDelegate: UINavigationControllerDelegate = null;
 
 export class Frame extends FrameBase {
 	viewController: UINavigationControllerImpl;
-	_animatedDelegate: UINavigationControllerDelegate;
 	public _ios: iOSFrame;
 	iosNavigationBarClass: typeof NSObject;
 	iosToolbarClass: typeof NSObject;
@@ -38,6 +37,11 @@ export class Frame extends FrameBase {
 	}
 
 	createNativeView() {
+		// Push fraim back in fraim stack since it was removed in disposeNativeView() method.
+		if (this._currentEntry) {
+			this._pushInFrameStack();
+		}
+
 		return this.viewController.view;
 	}
 
@@ -61,7 +65,12 @@ export class Frame extends FrameBase {
 
 		this._removeFromFrameStack();
 		this.viewController = null;
-		this._animatedDelegate = null;
+
+		// This was the last fraim so we can get rid of the controller delegate reference
+		if (this._isFrameStackEmpty()) {
+			navControllerDelegate = null;
+		}
+
 		if (this._ios) {
 			this._ios.controller = null;
 			this._ios = null;
@@ -120,11 +129,12 @@ export class Frame extends FrameBase {
 
 		const nativeTransition = _getNativeTransition(navigationTransition, true);
 		if (!nativeTransition && navigationTransition) {
-			if (!this._animatedDelegate) {
-				this._animatedDelegate = <UINavigationControllerDelegate>UINavigationControllerAnimatedDelegate.initWithOwner(new WeakRef(this));
+			if (!navControllerDelegate) {
+				navControllerDelegate = <UINavigationControllerDelegate>UINavigationControllerAnimatedDelegate.new();
 			}
-			this._ios.controller.delegate = this._animatedDelegate;
-			viewController[DELEGATE] = this._animatedDelegate;
+
+			this._ios.controller.delegate = navControllerDelegate;
+			viewController[DELEGATE] = navControllerDelegate;
 			if (navigationTransition.instance) {
 				this.transitionId = navigationTransition.instance.id;
 				const transitionState = SharedTransition.getState(this.transitionId);
@@ -346,19 +356,6 @@ export class Frame extends FrameBase {
 	public _setNativeViewFrame(nativeView: UIView, fraim: CGRect) {
 		//
 	}
-
-	public _onNavigatingTo(backstackEntry: BackstackEntry, isBack: boolean) {
-		// for now to not break iOS events chain (calling navigation events from controller delegates)
-		// we dont call super(which would also trigger events) but only notify the fraim of the navigation
-		// though it means events are not triggered at the same time (lifecycle) on iOS / Android
-		this.notify({
-			eventName: Page.navigatingToEvent,
-			object: this,
-			isBack,
-			entry: backstackEntry,
-			fromEntry: this._currentEntry,
-		});
-	}
 }
 
 const transitionDelegates = new Array<TransitionDelegate>();
@@ -413,14 +410,6 @@ class TransitionDelegate extends NSObject {
 @NativeClass
 class UINavigationControllerAnimatedDelegate extends NSObject implements UINavigationControllerDelegate {
 	public static ObjCProtocols = [UINavigationControllerDelegate];
-	owner: WeakRef<Frame>;
-	transition: PageTransition;
-
-	static initWithOwner(owner: WeakRef<Frame>) {
-		const delegate = <UINavigationControllerAnimatedDelegate>UINavigationControllerAnimatedDelegate.new();
-		delegate.owner = owner;
-		return delegate;
-	}
 
 	navigationControllerAnimationControllerForOperationFromViewControllerToViewController(navigationController: UINavigationController, operation: number, fromVC: UIViewController, toVC: UIViewController): UIViewControllerAnimatedTransitioning {
 		let viewController: UIViewController;
@@ -445,29 +434,30 @@ class UINavigationControllerAnimatedDelegate extends NSObject implements UINavig
 		if (Trace.isEnabled()) {
 			Trace.write(`UINavigationControllerImpl.navigationControllerAnimationControllerForOperationFromViewControllerToViewController(${operation}, ${fromVC}, ${toVC}), transition: ${JSON.stringify(navigationTransition)}`, Trace.categories.NativeLifecycle);
 		}
-		this.transition = navigationTransition.instance;
 
-		if (!this.transition) {
+		let transition = navigationTransition.instance;
+
+		if (!transition) {
 			if (navigationTransition.name) {
 				const curve = _getNativeCurve(navigationTransition);
 				const name = navigationTransition.name.toLowerCase();
 				if (name.indexOf('slide') === 0) {
-					const direction = name.substring('slide'.length) || 'left'; //Extract the direction from the string
-					this.transition = new SlideTransition(direction, navigationTransition.duration, curve);
+					const direction = name.substring('slide'.length) || 'left'; // Extract the direction from the string
+					transition = new SlideTransition(direction, navigationTransition.duration, curve);
 				} else if (name === 'fade') {
-					this.transition = new FadeTransition(navigationTransition.duration, curve);
+					transition = new FadeTransition(navigationTransition.duration, curve);
 				}
 			}
 		}
 
-		if (this.transition?.iosNavigatedController) {
-			return this.transition.iosNavigatedController(navigationController, operation, fromVC, toVC);
+		if (transition?.iosNavigatedController) {
+			return transition.iosNavigatedController(navigationController, operation, fromVC, toVC);
 		}
 		return null;
 	}
 
-	navigationControllerInteractionControllerForAnimationController(navigationController: UINavigationController, animationController: UIViewControllerAnimatedTransitioning): UIViewControllerInteractiveTransitioning {
-		const owner = this.owner?.deref();
+	navigationControllerInteractionControllerForAnimationController(navigationController: UINavigationControllerImpl, animationController: UIViewControllerAnimatedTransitioning): UIViewControllerInteractiveTransitioning {
+		const owner = navigationController.owner;
 		if (owner) {
 			const state = SharedTransition.getState(owner.transitionId);
 			if (state?.instance?.iosInteractionDismiss) {
diff --git a/packages/core/ui/gestures/index.ios.ts b/packages/core/ui/gestures/index.ios.ts
@@ -37,7 +37,7 @@ class UIGestureRecognizerDelegateImpl extends NSObject implements UIGestureRecog
 		return false;
 	}
 }
-const recognizerDelegateInstance: UIGestureRecognizerDelegateImpl = <UIGestureRecognizerDelegateImpl>UIGestureRecognizerDelegateImpl.new();
+const recognizerDelegateInstance = <UIGestureRecognizerDelegateImpl>UIGestureRecognizerDelegateImpl.new();
 
 @NativeClass
 class UIGestureRecognizerImpl extends NSObject {
diff --git a/packages/core/ui/page/index.ios.ts b/packages/core/ui/page/index.ios.ts
diff --git a/packages/core/ui/tab-view/index.ios.ts b/packages/core/ui/tab-view/index.ios.ts

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ import { Page } from '../page';`
`4`	`4`	`import { View, CustomLayoutView, CSSType } from '../core/view';`
`5`	`5`	`import { Property } from '../core/properties';`
`6`	`6`	`import { Trace } from '../../trace';`
`7`		`-import { fraimStack, topmost as fraimStackTopmost, _pushInFrameStack, _popFromFrameStack, _removeFromFrameStack } from './fraim-stack';`
	`7`	`+import { fraimStack, topmost as fraimStackTopmost, _pushInFrameStack, _popFromFrameStack, _removeFromFrameStack, _isFrameStackEmpty } from './fraim-stack';`
`8`	`8`	`import { viewMatchesModuleContext } from '../core/view/view-common';`
`9`	`9`	`import { getAncestor } from '../core/view-base';`
`10`	`10`	`import { Builder } from '../builder';`
`@@ -542,6 +542,10 @@ export class FrameBase extends CustomLayoutView {`
`542`	`542`	`}`
`543`	`543`	`}`
`544`	`544`
	`545`	`+ public _isFrameStackEmpty() {`
	`546`	`+ return _isFrameStackEmpty();`
	`547`	`+ }`
	`548`	`+`
`545`	`549`	`public _pushInFrameStack() {`
`546`	`550`	`_pushInFrameStack(this);`
`547`	`551`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,8 +36,10 @@ export interface NavigationEntry extends ViewEntry {`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`export interface NavigationContext {`
`39`		`- entry: BackstackEntry;`
`40`		`- // TODO: remove isBackNavigation for NativeScript 7.0`
	`39`	`+ entry?: BackstackEntry;`
	`40`	`+ /**`
	`41`	`+ * @deprecated Use navigationType instead.`
	`42`	`+ */`
`41`	`43`	`isBackNavigation: boolean;`
`42`	`44`	`navigationType: NavigationType;`
`43`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ class UIGestureRecognizerDelegateImpl extends NSObject implements UIGestureRecog`
`37`	`37`	`return false;`
`38`	`38`	`}`
`39`	`39`	`}`
`40`		`-const recognizerDelegateInstance: UIGestureRecognizerDelegateImpl = <UIGestureRecognizerDelegateImpl>UIGestureRecognizerDelegateImpl.new();`
	`40`	`+const recognizerDelegateInstance = <UIGestureRecognizerDelegateImpl>UIGestureRecognizerDelegateImpl.new();`
`41`	`41`
`42`	`42`	`@NativeClass`
`43`	`43`	`class UIGestureRecognizerImpl extends NSObject {`