[go_router] Navigate to route when user opens the app via a push notification

[JGeek00]

Is there an existing issue for this?

• I have searched the existing issues
• I have read the guide to filing a bug

Steps to reproduce

I'm trying to navigate to a route when the user clicks on a notification. I'm handling push notifications with FirebaseMessaging, and the notification system works fine. Currently the only step that is remaining to have the whole notification process working is to navigate to a route when the user opens the app via a notification.
I tried doing this on the main.dart initState

  void initState() {
    _pushNotificationService.initialize();

    super.initState();

    FirebaseMessaging.onMessageOpenedApp.listen((RemoteMessage message) {
      print(message.data);  // message.data contains the route to navigate
      WidgetsBinding.instance.addPostFrameCallback((_) {
        GoRouter.of(context).go("/route1");
      });
    });
  }

But it always throws this error: No GoRouter found in context

Actual results

I receive this error: No GoRouter found in context

Logs

Logs

<!-- Paste your logs here -->

Flutter Doctor output

Doctor output

[√] Flutter (Channel stable, 3.13.5, on Microsoft Windows [Version 10.0.19044.3448], locale es-ES)
    • Flutter version 3.13.5 on channel stable at C:\flutter
    • Upstream repository https://github.com/flutter/flutter.git
    • Framework revision 12fccda598 (3 weeks ago), 2023-09-19 13:56:11 -0700
    • Engine revision bd986c5ed2
    • Dart version 3.1.2
    • DevTools version 2.25.0

[√] Windows Version (Installed version of Windows is version 10 or higher)

[√] Android toolchain - develop for Android devices (Android SDK version 34.0.0)
    • Android SDK at C:\Users\jgilsanz\AppData\Local\Android\sdk
    • Platform android-34, build-tools 34.0.0
    • Java binary at: C:\Program Files\Android\Android Studio\jbr\bin\java
    • Java version OpenJDK Runtime Environment (build 17.0.6+0-b2043.56-10027231)
    • All Android licenses accepted.

[√] Chrome - develop for the web
    • Chrome at C:\Program Files\Google\Chrome\Application\chrome.exe

[!] Visual Studio - develop Windows apps (Visual Studio Build Tools 2019 16.11.15)
    • Visual Studio at C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools
    • Visual Studio Build Tools 2019 version 16.11.32510.428
    • Windows 10 SDK version 10.0.19041.0
    X The current Visual Studio installation is incomplete. Please reinstall Visual Studio.

[√] Android Studio (version 2022.3)
    • Android Studio at C:\Program Files\Android\Android Studio
    • Flutter plugin can be installed from:
       https://plugins.jetbrains.com/plugin/9212-flutter
    • Dart plugin can be installed from:
       https://plugins.jetbrains.com/plugin/6351-dart
    • Java version OpenJDK Runtime Environment (build 17.0.6+0-b2043.56-10027231)

[√] VS Code (version 1.83.0)
    • VS Code at C:\Users\jgilsanz\AppData\Local\Programs\Microsoft VS Code
    • Flutter extension version 3.74.0

[√] Connected device (4 available)
    • sdk gphone x86 64 (mobile) • emulator-5554 • android-x64    • Android 13 (API 33) (emulator)
    • Windows (desktop)          • windows       • windows-x64    • Microsoft Windows [Version 10.0.19044.3448]
    • Chrome (web)               • chrome        • web-javascript • Google Chrome 117.0.5938.149
    • Edge (web)                 • edge          • web-javascript • Microsoft Edge 117.0.2045.31

[√] Network resources
    • All expected network resources are available.

! Doctor found issues in 1 category.

[darshankawar]

Thanks for the report @JGeek00
Can you provide a runnable reproducible code sample along with complete error log you are getting ?

[JGeek00]

This is not a bug report. I want to navigate to a route (instead of oppening the app on the initialRoute that is set on the go_router configuration) when the user opens the app via a push notification. I'm handling push notifications with FirebaseMessaging. I just want to open the app on "/screen2" instead of the initialRoute "/" when the user opens taps on the push notification.

I tried setting the listener (following code block) on main.dart initState and triggering the navigation with GoRouter.of(context).go("/screen2") from there but I receive the No GoRouter found in context error, I assume that's because the router still isn't initialized.

FirebaseMessaging.onMessageOpenedApp.listen((RemoteMessage message) {
      GoRouter.of(context).go("/route1");
    });

I hope you can help me with this situation and give me some tricks and hints to achieve that result because I didn't found much information about this on the internet.

[darshankawar]

Please check this and see if it helps in your case or not.

Also if you are looking for a code implementation solution, StackOverflow is a better platform to ask such.

[JGeek00]

Finally I managed to solve it. Here's my solution for other people with the same issue

Handle background and terminated state notification tap with go_router and authentication

main.dart

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  ...

  final UserDataProvider userDataProvider = UserDataProvider();

  await Firebase.initializeApp(options: DefaultFirebaseOptions.currentPlatform);

  PushNotificationService().initialize();
  final initialMessage = await FirebaseMessaging.instance.getInitialMessage();

  runApp(
    MultiProvider(
      providers: [
        Provider<AppRouter>(create: (_) => AppRouter(userDataProvider)),
        ChangeNotifierProvider(
          create: (context) => userDataProvider,
        ),
        ...
      ],
      child: App(initialMessage: initialMessage),
    ),
  );
}

class App extends StatefulWidget {
  final RemoteMessage? initialMessage;

  const App({
    super.key, 
    this.initialMessage,
  });

  @override
  State<App> createState() => _AppState();
}

class _AppState extends State<App> {
  Future<void> setupInteractedMessage() async {
    final initialMessage = await FirebaseMessaging.instance.getInitialMessage();
    
    if (initialMessage != null) {
      _handleMessage(initialMessage);
    }

    FirebaseMessaging.onMessageOpenedApp.listen(_handleMessage);
  }

  void _handleMessage(RemoteMessage message) {
    if (message.data['route']) {
      final appRouter = Provider.of<AppRouter>(context, listen: false);
      appRouter.setRouteNavigate(message.data['route']);
      appRouter.router.go(message.data['route']);
    }
  }

  @override
  void initState() {
    Provider.of<UserDataProvider>(context, listen: false).loadUserData();

    setupInteractedMessage();
    
    super.initState();
  }

  @override
  Widget build(BuildContext context) {
    final userDataProvider = Provider.of<UserDataProvider>(context);
    final appRouter = Provider.of<AppRouter>(context);

    return MaterialApp.router(
      ...
      routerConfig: appRouter.router,
    );
  }
}

push_notification_service.dart

class PushNotificationService {
  final FirebaseMessaging _fcm = FirebaseMessaging.instance;

  Future initialize() async {
    await requestPermission();
    final token = await getToken();
    print("fcm token: $token");
  }

  Future<NotificationSettings> requestPermission() async {
    NotificationSettings settings = await _fcm.requestPermission(
      alert: true,
      announcement: false,
      badge: true,
      carPlay: false,
      criticalAlert: false,
      provisional: false,
      sound: true,
    );
    return settings;
  }

  Future<String?> getToken() async {
    final String? token = await _fcm.getToken();
    return token;
  }
}

router.dart

class AppRouter {
  late final UserDataProvider userDataProvider;
  GoRouter get router => _goRouter;

  AppRouter(this.userDataProvider);

  String? _routeNavigate;

  void setRouteNavigate(String route) {
    _routeNavigate = route;
  }

  late final GoRouter _goRouter = GoRouter(
    initialLocation: RoutesNames.root,
    refreshListenable: userDataProvider,
    redirect: (context, state) {
      final userDataProvider = Provider.of<UserDataProvider>(
        context,
        listen: false,
      );

      if (userDataProvider.token == null) {
        return RoutesNames.login;
      }

      if (userDataProvider.firstLoad == true &&
          userDataProvider.loadStatus == LoadStatus.loading) {
        return RoutesNames.root;
      } else if (userDataProvider.firstLoad == true &&
          userDataProvider.loadStatus == LoadStatus.loaded) {
        userDataProvider.setFirstLoad(false);
        return _routeNavigate ?? RoutesNames.home;
      } else {
        return null;
      }
    },
    routes: [
      GoRoute(
        path: RoutesNames.root,
        pageBuilder: (context, state) => const NoTransitionPage(
          child: SystemUiOverlayStyleConfigurator(
            child: SplashScreen(),
          ),
        ),
      ),
      GoRoute(
        path: RoutesNames.login,
        pageBuilder: (context, state) => const NoTransitionPage(
          child: SystemUiOverlayStyleConfigurator(
            child: LoginScreen(),
          ),
        ),
      ),
      ...
    ],
  );
}

user_data_provider.dart

class UserDataProvider with ChangeNotifier {
  String? _token = "a";
  LoadStatus _userDataLoadStatus = LoadStatus.loading;
  bool _firstLoad = true;

  String? get token {
    return _token;
  }

  bool get firstLoad {
    return _firstLoad;
  }

  LoadStatus get loadStatus {
    return _userDataLoadStatus;
  }

  void setToken(String token) {
    _token = token;
    notifyListeners();
  }

  void setFirstLoad(bool l) {
    _firstLoad = l;
    notifyListeners();
  }

  void setLoadStatus(LoadStatus status) {
    _userDataLoadStatus = status;
  }

  void loadUserData() async {
    await Future.delayed(Duration(milliseconds: 250));
    _userDataLoadStatus = LoadStatus.loaded;
    notifyListeners();
  }
}

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of flutter doctor -v and a minimal reproduction of the issue.