[SuperReader][SuperReader][iOS] Fix crash when pushing a route with a delegatedTransition. (Resolves #2794) (#2797)

Author: angelosilvestre

super_editor/lib/src/default_editor/document_gestures_touch_ios.dart

@@ -1517,9 +1517,10 @@ class SuperEditorIosToolbarOverlayManagerState extends State<SuperEditorIosToolb
 
     _controlsController = SuperEditorIosControlsScope.rootOf(context);
 
-    WidgetsBinding.instance.addPostFrameCallback((_) {
-      // There's some stupid Flutter error that happens without this post frame callback
-      // where the error is "OverlayPortalController.show() should not be called during build.".
+    // It's possible that `didChangeDependencies` is called during build when pushing a route
+    // that has a delegated transition. We need to wait until the next frame to show the overlay,
+    // otherwise this widget crashes, since we can't call `OverlayPortalController.show()` during build.
+    onNextFrame((timeStamp) {
       _overlayPortalController.show();
     });
   }
@@ -1584,9 +1585,10 @@ class SuperEditorIosMagnifierOverlayManagerState extends State<SuperEditorIosMag
     super.didChangeDependencies();
     _controlsController = SuperEditorIosControlsScope.rootOf(context);
 
-    WidgetsBinding.instance.addPostFrameCallback((_) {
-      // There's some stupid Flutter error that happens without this post frame callback
-      // where the error is "OverlayPortalController.show() should not be called during build.".
+    // It's possible that `didChangeDependencies` is called during build when pushing a route
+    // that has a delegated transition. We need to wait until the next frame to show the overlay,
+    // otherwise this widget crashes, since we can't call `OverlayPortalController.show` during build.
+    onNextFrame((timeStamp) {
       _overlayPortalController.show();
     });
   }

super_editor/lib/src/super_reader/read_only_document_ios_touch_interactor.dart

@@ -1077,7 +1077,13 @@ class SuperReaderIosToolbarOverlayManagerState extends State<SuperReaderIosToolb
     super.didChangeDependencies();
 
     _controlsContext = SuperReaderIosControlsScope.rootOf(context);
-    _overlayPortalController.show();
+
+    // It's possible that `didChangeDependencies` is called during build when pushing a route
+    // that has a delegated transition. We need to wait until the next frame to show the overlay,
+    // otherwise this widget crashes, since we can't call `OverlayPortalController.show` during build.
+    onNextFrame((timeStamp) {
+      _overlayPortalController.show();
+    });
   }
 
   @override
@@ -1138,7 +1144,12 @@ class SuperReaderIosMagnifierOverlayManagerState extends State<SuperReaderIosMag
 
     _controlsContext = SuperReaderIosControlsScope.rootOf(context);
 
-    _overlayPortalController.show();
+    // It's possible that `didChangeDependencies` is called during build when pushing a route
+    // that has a delegated transition. We need to wait until the next frame to show the overlay,
+    // otherwise this widget crashes, since we can't call `OverlayPortalController.show` during build.
+    onNextFrame((timeStamp) {
+      _overlayPortalController.show();
+    });
   }
 
   @override

super_editor/test/super_editor/supereditor_route_test.dart

@@ -0,0 +1,83 @@
+import 'package:flutter/material.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:flutter_test_runners/flutter_test_runners.dart';
+
+import 'supereditor_test_tools.dart';
+
+void main() {
+  group('SuperEditor > routes >', () {
+    testWidgetsOnAllPlatforms('can be used with a route with a delegated transition on top', (tester) async {
+      await tester //
+          .createDocument()
+          .withSingleParagraph()
+          .withCustomWidgetTreeBuilder(
+            (superEditor) => MaterialApp(
+              home: Scaffold(
+                body: Column(
+                  children: [
+                    Expanded(
+                      child: superEditor,
+                    ),
+                    Builder(builder: (context) {
+                      return ElevatedButton(
+                        child: const Text('delegatedTransition'),
+                        onPressed: () {
+                          Navigator.of(context).push(_TestRoute());
+                        },
+                      );
+                    }),
+                  ],
+                ),
+              ),
+            ),
+          )
+          .pump();
+
+      await tester.tap(find.byType(ElevatedButton));
+      await tester.pump();
+
+      // Reaching this point means that the editor did not crash when the route with
+      // a delegated transition was pushed on top of it.
+      // See https://github.com/Flutter-Bounty-Hunters/super_editor/issues/2794 for details.
+    });
+  });
+}
+
+/// A [ModalRoute] that uses a delegated transition.
+class _TestRoute extends ModalRoute<void> {
+  _TestRoute();
+
+  @override
+  DelegatedTransitionBuilder? get delegatedTransition =>
+      (context, animation, secondaryAnimation, allowSnapshotting, child) {
+        return FadeTransition(
+          opacity: animation,
+          child: child,
+        );
+      };
+
+  @override
+  Color? get barrierColor => null;
+
+  @override
+  String? get barrierLabel => null;
+
+  @override
+  bool get barrierDismissible => true;
+
+  @override
+  Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation) {
+    return const Center(
+      child: Text('Hello'),
+    );
+  }
+
+  @override
+  bool get maintainState => true;
+
+  @override
+  bool get opaque => false;
+
+  @override
+  Duration get transitionDuration => const Duration(milliseconds: 300);
+}

super_editor/test/super_reader/super_reader_route_test.dart

@@ -0,0 +1,83 @@
+import 'package:flutter/material.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:flutter_test_runners/flutter_test_runners.dart';
+
+import 'reader_test_tools.dart';
+
+void main() {
+  group('SuperReader > routes >', () {
+    testWidgetsOnAllPlatforms('can be used with a route with a delegated transition on top', (tester) async {
+      await tester //
+          .createDocument()
+          .withSingleParagraph()
+          .withCustomWidgetTreeBuilder(
+            (superReader) => MaterialApp(
+              home: Scaffold(
+                body: Column(
+                  children: [
+                    Expanded(
+                      child: superReader,
+                    ),
+                    Builder(builder: (context) {
+                      return ElevatedButton(
+                        child: const Text('delegatedTransition'),
+                        onPressed: () {
+                          Navigator.of(context).push(_TestRoute());
+                        },
+                      );
+                    }),
+                  ],
+                ),
+              ),
+            ),
+          )
+          .pump();
+
+      await tester.tap(find.byType(ElevatedButton));
+      await tester.pump();
+
+      // Reaching this point means that the reader did not crash when the route with
+      // a delegated transition was pushed on top of it.
+      // See https://github.com/Flutter-Bounty-Hunters/super_editor/issues/2794 for details.
+    });
+  });
+}
+
+/// A [ModalRoute] that uses a delegated transition.
+class _TestRoute extends ModalRoute<void> {
+  _TestRoute();
+
+  @override
+  DelegatedTransitionBuilder? get delegatedTransition =>
+      (context, animation, secondaryAnimation, allowSnapshotting, child) {
+        return FadeTransition(
+          opacity: animation,
+          child: child,
+        );
+      };
+
+  @override
+  Color? get barrierColor => null;
+
+  @override
+  String? get barrierLabel => null;
+
+  @override
+  bool get barrierDismissible => true;
+
+  @override
+  Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation) {
+    return const Center(
+      child: Text('Hello'),
+    );
+  }
+
+  @override
+  bool get maintainState => true;
+
+  @override
+  bool get opaque => false;
+
+  @override
+  Duration get transitionDuration => const Duration(milliseconds: 300);
+}