[go_router] Fix requestFocus propagation to Navigator (#9177)

Fixes [166972](flutter/flutter#166972)

## Pre-Review Checklist

[^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling.

Author: KevynSM

packages/go_router/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 15.1.2
+
+- Fixes focus request propagation from `GoRouter` to `Navigator` by properly handling the `requestFocus` parameter.
+
 ## 15.1.1
 
 - Adds missing `caseSensitive` to `GoRouteData.$route`.

packages/go_router/lib/src/builder.dart

@@ -121,24 +121,25 @@ class RouteBuilder {
         configuration: configuration,
         errorBuilder: errorBuilder,
         errorPageBuilder: errorPageBuilder,
+        requestFocus: requestFocus,
       ),
     );
   }
 }
 
 class _CustomNavigator extends StatefulWidget {
-  const _CustomNavigator({
-    super.key,
-    required this.navigatorKey,
-    required this.observers,
-    required this.navigatorRestorationId,
-    required this.onPopPageWithRouteMatch,
-    required this.matchList,
-    required this.matches,
-    required this.configuration,
-    required this.errorBuilder,
-    required this.errorPageBuilder,
-  });
+  const _CustomNavigator(
+      {super.key,
+      required this.navigatorKey,
+      required this.observers,
+      required this.navigatorRestorationId,
+      required this.onPopPageWithRouteMatch,
+      required this.matchList,
+      required this.matches,
+      required this.configuration,
+      required this.errorBuilder,
+      required this.errorPageBuilder,
+      required this.requestFocus});
 
   final GlobalKey<NavigatorState> navigatorKey;
   final List<NavigatorObserver> observers;
@@ -155,6 +156,7 @@ class _CustomNavigator extends StatefulWidget {
   final String? navigatorRestorationId;
   final GoRouterWidgetBuilder? errorBuilder;
   final GoRouterPageBuilder? errorPageBuilder;
+  final bool requestFocus;
 
   @override
   State<StatefulWidget> createState() => _CustomNavigatorState();
@@ -283,19 +285,19 @@ class _CustomNavigatorState extends State<_CustomNavigator> {
         String? restorationScopeId,
       ) {
         return _CustomNavigator(
-          // The state needs to persist across rebuild.
-          key: GlobalObjectKey(navigatorKey.hashCode),
-          navigatorRestorationId: restorationScopeId,
-          navigatorKey: navigatorKey,
-          matches: match.matches,
-          matchList: matchList,
-          configuration: widget.configuration,
-          observers: observers ?? const <NavigatorObserver>[],
-          onPopPageWithRouteMatch: widget.onPopPageWithRouteMatch,
-          // This is used to recursively build pages under this shell route.
-          errorBuilder: widget.errorBuilder,
-          errorPageBuilder: widget.errorPageBuilder,
-        );
+            // The state needs to persist across rebuild.
+            key: GlobalObjectKey(navigatorKey.hashCode),
+            navigatorRestorationId: restorationScopeId,
+            navigatorKey: navigatorKey,
+            matches: match.matches,
+            matchList: matchList,
+            configuration: widget.configuration,
+            observers: observers ?? const <NavigatorObserver>[],
+            onPopPageWithRouteMatch: widget.onPopPageWithRouteMatch,
+            // This is used to recursively build pages under this shell route.
+            errorBuilder: widget.errorBuilder,
+            errorPageBuilder: widget.errorPageBuilder,
+            requestFocus: widget.requestFocus);
       },
     );
     final Page<Object?>? page =
@@ -437,6 +439,7 @@ class _CustomNavigatorState extends State<_CustomNavigator> {
         controller: _controller!,
         child: Navigator(
           key: widget.navigatorKey,
+          requestFocus: widget.requestFocus,
           restorationScopeId: widget.navigatorRestorationId,
           pages: _pages!,
           observers: widget.observers,

packages/go_router/pubspec.yaml

@@ -1,7 +1,7 @@
 name: go_router
 description: A declarative router for Flutter based on Navigation 2 supporting
   deep linking, data-driven routes and more
-version: 15.1.1
+version: 15.1.2
 repository: https://github.com/flutter/packages/tree/main/packages/go_router
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+go_router%22
 

packages/go_router/test/builder_test.dart

@@ -383,6 +383,61 @@ void main() {
           (shellNavigatorKey.currentWidget as Navigator?)?.restorationScopeId,
           'scope1');
     });
+
+    testWidgets('GoRouter requestFocus defaults to true',
+        (WidgetTester tester) async {
+      final GoRouter router = GoRouter(
+        routes: <RouteBase>[
+          GoRoute(
+            path: '/',
+            builder: (BuildContext context, GoRouterState state) =>
+                const Scaffold(
+              body: Center(child: Text('Home')),
+            ),
+          ),
+        ],
+      );
+
+      await tester.pumpWidget(
+        MaterialApp.router(
+          routerConfig: router,
+        ),
+      );
+
+      addTearDown(() => router.dispose());
+
+      final Navigator navigator =
+          tester.widget<Navigator>(find.byType(Navigator));
+      expect(navigator.requestFocus, isTrue);
+    });
+
+    testWidgets('GoRouter requestFocus can be set to false',
+        (WidgetTester tester) async {
+      final GoRouter router = GoRouter(
+        routes: <RouteBase>[
+          GoRoute(
+            path: '/',
+            builder: (BuildContext context, GoRouterState state) =>
+                const Scaffold(
+              body: Center(child: Text('Home')),
+            ),
+          ),
+        ],
+        requestFocus: false,
+      );
+
+      await tester.pumpWidget(
+        MaterialApp.router(
+          routerConfig: router,
+        ),
+      );
+
+      addTearDown(() => router.dispose());
+
+      final Navigator navigator =
+          tester.widget<Navigator>(find.byType(Navigator));
+      expect(navigator.requestFocus, isFalse);
+    });
   });
 }