notif [nfc]: Refactor NotificationOpenService.routeForNotification

Update it to receive `NotificationOpenPayload` as an argument
instead of the Android Notification URL.

Also rename `navigateForNotification` to
`navigateForAndroidNotificationUrl`, making it more explicit.

Author: rajveermalviya

lib/notifications/open.dart

@@ -17,31 +17,23 @@ import '../widgets/store.dart';
 /// Responds to the user opening a notification.
 class NotificationOpenService {
 
-  /// Provides the route and the account ID by parsing the notification URL.
-  ///
-  /// The URL must have been generated using
-  /// [NotificationOpenPayload.buildAndroidNotificationUrl] while creating the
-  /// notification.
+  /// Provides the route to open by parsing the notification payload.
   ///
   /// Returns null and shows an error dialog if the associated account is not
   /// found in the global store.
   ///
   /// The context argument should be a descendant of the app's main [Navigator].
   static AccountRoute<void>? routeForNotification({
     required BuildContext context,
-    required Uri url,
+    required NotificationOpenPayload data,
   }) {
     assert(defaultTargetPlatform == TargetPlatform.android);
 
     final globalStore = GlobalStoreWidget.of(context);
 
-    assert(debugLog('got notif: url: $url'));
-    assert(url.scheme == 'zulip' && url.host == 'notification');
-    final payload = NotificationOpenPayload.parseAndroidNotificationUrl(url);
-
     final account = globalStore.accounts.firstWhereOrNull(
-      (account) => account.realmUrl.origin == payload.realmUrl.origin
-                && account.userId == payload.userId);
+      (account) => account.realmUrl.origin == data.realmUrl.origin
+                && account.userId == data.userId);
     if (account == null) { // TODO(log)
       final zulipLocalizations = ZulipLocalizations.of(context);
       showErrorDialog(context: context,
@@ -53,14 +45,14 @@ class NotificationOpenService {
     return MessageListPage.buildRoute(
       accountId: account.id,
       // TODO(#82): Open at specific message, not just conversation
-      narrow: payload.narrow);
+      narrow: data.narrow);
   }
 
   /// Navigates to the [MessageListPage] of the specific conversation
   /// given the `zulip://notification/…` Android intent data URL,
   /// generated with [NotificationOpenPayload.buildAndroidNotificationUrl]
   /// while creating the notification.
-  static Future<void> navigateForNotification(Uri url) async {
+  static Future<void> navigateForAndroidNotificationUrl(Uri url) async {
     assert(defaultTargetPlatform == TargetPlatform.android);
     assert(debugLog('opened notif: url: $url'));
 
@@ -69,7 +61,9 @@ class NotificationOpenService {
     assert(context.mounted);
     if (!context.mounted) return; // TODO(linter): this is impossible as there's no actual async gap, but the use_build_context_synchronously lint doesn't see that
 
-    final route = routeForNotification(context: context, url: url);
+    assert(url.scheme == 'zulip' && url.host == 'notification');
+    final data = NotificationOpenPayload.parseAndroidNotificationUrl(url);
+    final route = routeForNotification(context: context, data: data);
     if (route == null) return; // TODO(log)
 
     // TODO(nav): Better interact with existing nav stack on notif open

lib/widgets/app.dart

@@ -168,27 +168,35 @@ class _ZulipAppState extends State<ZulipApp> with WidgetsBindingObserver {
     super.dispose();
   }
 
+  AccountRoute<void>? _initialRouteAndroid(
+    BuildContext context,
+    String initialRoute,
+  ) {
+    final initialRouteUrl = Uri.tryParse(initialRoute);
+    if (initialRouteUrl case Uri(scheme: 'zulip', host: 'notification')) {
+      assert(debugLog('got notif: url: $initialRouteUrl'));
+      final data =
+        NotificationOpenPayload.parseAndroidNotificationUrl(initialRouteUrl);
+      return NotificationOpenService.routeForNotification(
+        context: context,
+        data: data);
+    }
+
+    return null;
+  }
+
   List<Route<dynamic>> _handleGenerateInitialRoutes(String initialRoute) {
     // The `_ZulipAppState.context` lacks the required ancestors. Instead
     // we use the Navigator which should be available when this callback is
     // called and it's context should have the required ancestors.
     final context = ZulipApp.navigatorKey.currentContext!;
 
-    final initialRouteUrl = Uri.tryParse(initialRoute);
-    if (initialRouteUrl case Uri(scheme: 'zulip', host: 'notification')) {
-      final route = NotificationOpenService.routeForNotification(
-        context: context,
-        url: initialRouteUrl);
-
-      if (route != null) {
-        return [
-          HomePage.buildRoute(accountId: route.accountId),
-          route,
-        ];
-      } else {
-        // The account didn't match any existing accounts,
-        // fall through to show the default route below.
-      }
+    final route = _initialRouteAndroid(context, initialRoute);
+    if (route != null) {
+      return [
+        HomePage.buildRoute(accountId: route.accountId),
+        route,
+      ];
     }
 
     final globalStore = GlobalStoreWidget.of(context);
@@ -209,7 +217,7 @@ class _ZulipAppState extends State<ZulipApp> with WidgetsBindingObserver {
         await LoginPage.handleWebAuthUrl(url);
         return true;
       case Uri(scheme: 'zulip', host: 'notification') && var url:
-        await NotificationOpenService.navigateForNotification(url);
+        await NotificationOpenService.navigateForAndroidNotificationUrl(url);
         return true;
     }
     return super.didPushRouteInformation(routeInformation);