notif ios: Navigate when app running but in background

Author: rajveermalviya

ios/Runner/AppDelegate.swift

@@ -3,6 +3,8 @@ import Flutter
 
 @main
 @objc class AppDelegate: FlutterAppDelegate {
+  private var notificationTapEventListener: NotificationTapEventListener?
+
   override func application(
     _ application: UIApplication,
     didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
@@ -16,8 +18,25 @@ import Flutter
     let api = NotificationHostApiImpl(notificationPayload.map { NotificationDataFromLaunch(payload: $0) })
     NotificationHostApiSetup.setUp(binaryMessenger: controller.binaryMessenger, api: api)
 
+    notificationTapEventListener = NotificationTapEventListener()
+    NotificationTapEventsStreamHandler.register(with: controller.binaryMessenger, streamHandler: notificationTapEventListener!)
+
+    UNUserNotificationCenter.current().delegate = self
+
     return super.application(application, didFinishLaunchingWithOptions: launchOptions)
   }
+
+  override func userNotificationCenter(
+    _ center: UNUserNotificationCenter,
+    didReceive response: UNNotificationResponse,
+    withCompletionHandler completionHandler: @escaping () -> Void
+  ) {
+    if response.actionIdentifier == UNNotificationDefaultActionIdentifier {
+      let userInfo = response.notification.request.content.userInfo
+      notificationTapEventListener!.onNotificationTapEvent(payload: userInfo)
+    }
+    completionHandler()
+  }
 }
 
 private class NotificationHostApiImpl: NotificationHostApi {
@@ -31,3 +50,17 @@ private class NotificationHostApiImpl: NotificationHostApi {
     maybeDataFromLaunch
   }
 }
+
+// Adapted from Pigeon's Swift example for @EventChannelApi:
+//   https://github.com/flutter/packages/blob/2dff6213a/packages/pigeon/example/app/ios/Runner/AppDelegate.swift#L49-L74
+class NotificationTapEventListener: NotificationTapEventsStreamHandler {
+  var eventSink: PigeonEventSink<NotificationTapEvent>?
+
+  override func onListen(withArguments arguments: Any?, sink: PigeonEventSink<NotificationTapEvent>) {
+    eventSink = sink
+  }
+
+  func onNotificationTapEvent(payload: [AnyHashable : Any]) {
+    eventSink?.success(NotificationTapEvent(payload: payload))
+  }
+}

ios/Runner/Notifications.g.swift

@@ -157,11 +157,42 @@ struct NotificationDataFromLaunch: Hashable {
   }
 }
 
+/// Generated class from Pigeon that represents data sent in messages.
+struct NotificationTapEvent: Hashable {
+  /// The raw payload that is attached to the notification,
+  /// holding the information required to carry out the navigation.
+  ///
+  /// See [notificationTapEvents].
+  var payload: [AnyHashable?: Any?]
+
+
+  // swift-format-ignore: AlwaysUseLowerCamelCase
+  static func fromList(_ pigeonVar_list: [Any?]) -> NotificationTapEvent? {
+    let payload = pigeonVar_list[0] as! [AnyHashable?: Any?]
+
+    return NotificationTapEvent(
+      payload: payload
+    )
+  }
+  func toList() -> [Any?] {
+    return [
+      payload
+    ]
+  }
+  static func == (lhs: NotificationTapEvent, rhs: NotificationTapEvent) -> Bool {
+    return deepEqualsNotifications(lhs.toList(), rhs.toList())  }
+  func hash(into hasher: inout Hasher) {
+    deepHashNotifications(value: toList(), hasher: &hasher)
+  }
+}
+
 private class NotificationsPigeonCodecReader: FlutterStandardReader {
   override func readValue(ofType type: UInt8) -> Any? {
     switch type {
     case 129:
       return NotificationDataFromLaunch.fromList(self.readValue() as! [Any?])
+    case 130:
+      return NotificationTapEvent.fromList(self.readValue() as! [Any?])
     default:
       return super.readValue(ofType: type)
     }
@@ -173,6 +204,9 @@ private class NotificationsPigeonCodecWriter: FlutterStandardWriter {
     if let value = value as? NotificationDataFromLaunch {
       super.writeByte(129)
       super.writeValue(value.toList())
+    } else if let value = value as? NotificationTapEvent {
+      super.writeByte(130)
+      super.writeValue(value.toList())
     } else {
       super.writeValue(value)
     }
@@ -193,6 +227,8 @@ class NotificationsPigeonCodec: FlutterStandardMessageCodec, @unchecked Sendable
   static let shared = NotificationsPigeonCodec(readerWriter: NotificationsPigeonCodecReaderWriter())
 }
 
+var notificationsPigeonMethodCodec = FlutterStandardMethodCodec(readerWriter: NotificationsPigeonCodecReaderWriter());
+
 /// Generated protocol from Pigeon that represents a handler of messages from Flutter.
 protocol NotificationHostApi {
   /// Retrieves notification data if the app was launched by tapping on a notification.
@@ -233,3 +269,67 @@ class NotificationHostApiSetup {
     }
   }
 }
+
+private class PigeonStreamHandler<ReturnType>: NSObject, FlutterStreamHandler {
+  private let wrapper: PigeonEventChannelWrapper<ReturnType>
+  private var pigeonSink: PigeonEventSink<ReturnType>? = nil
+
+  init(wrapper: PigeonEventChannelWrapper<ReturnType>) {
+    self.wrapper = wrapper
+  }
+
+  func onListen(withArguments arguments: Any?, eventSink events: @escaping FlutterEventSink)
+    -> FlutterError?
+  {
+    pigeonSink = PigeonEventSink<ReturnType>(events)
+    wrapper.onListen(withArguments: arguments, sink: pigeonSink!)
+    return nil
+  }
+
+  func onCancel(withArguments arguments: Any?) -> FlutterError? {
+    pigeonSink = nil
+    wrapper.onCancel(withArguments: arguments)
+    return nil
+  }
+}
+
+class PigeonEventChannelWrapper<ReturnType> {
+  func onListen(withArguments arguments: Any?, sink: PigeonEventSink<ReturnType>) {}
+  func onCancel(withArguments arguments: Any?) {}
+}
+
+class PigeonEventSink<ReturnType> {
+  private let sink: FlutterEventSink
+
+  init(_ sink: @escaping FlutterEventSink) {
+    self.sink = sink
+  }
+
+  func success(_ value: ReturnType) {
+    sink(value)
+  }
+
+  func error(code: String, message: String?, details: Any?) {
+    sink(FlutterError(code: code, message: message, details: details))
+  }
+
+  func endOfStream() {
+    sink(FlutterEndOfEventStream)
+  }
+
+}
+
+class NotificationTapEventsStreamHandler: PigeonEventChannelWrapper<NotificationTapEvent> {
+  static func register(with messenger: FlutterBinaryMessenger,
+                      instanceName: String = "",
+                      streamHandler: NotificationTapEventsStreamHandler) {
+    var channelName = "dev.flutter.pigeon.zulip.NotificationEventChannelApi.notificationTapEvents"
+    if !instanceName.isEmpty {
+      channelName += ".\(instanceName)"
+    }
+    let internalStreamHandler = PigeonStreamHandler<NotificationTapEvent>(wrapper: streamHandler)
+    let channel = FlutterEventChannel(name: channelName, binaryMessenger: messenger, codec: notificationsPigeonMethodCodec)
+    channel.setStreamHandler(internalStreamHandler)
+  }
+}
+      

lib/host/notifications.g.dart

@@ -74,6 +74,51 @@ class NotificationDataFromLaunch {
 ;
 }
 
+class NotificationTapEvent {
+  NotificationTapEvent({
+    required this.payload,
+  });
+
+  /// The raw payload that is attached to the notification,
+  /// holding the information required to carry out the navigation.
+  ///
+  /// See [notificationTapEvents].
+  Map<Object?, Object?> payload;
+
+  List<Object?> _toList() {
+    return <Object?>[
+      payload,
+    ];
+  }
+
+  Object encode() {
+    return _toList();  }
+
+  static NotificationTapEvent decode(Object result) {
+    result as List<Object?>;
+    return NotificationTapEvent(
+      payload: (result[0] as Map<Object?, Object?>?)!.cast<Object?, Object?>(),
+    );
+  }
+
+  @override
+  // ignore: avoid_equals_and_hash_code_on_mutable_classes
+  bool operator ==(Object other) {
+    if (other is! NotificationTapEvent || other.runtimeType != runtimeType) {
+      return false;
+    }
+    if (identical(this, other)) {
+      return true;
+    }
+    return _deepEquals(encode(), other.encode());
+  }
+
+  @override
+  // ignore: avoid_equals_and_hash_code_on_mutable_classes
+  int get hashCode => Object.hashAll(_toList())
+;
+}
+
 
 class _PigeonCodec extends StandardMessageCodec {
   const _PigeonCodec();
@@ -85,6 +130,9 @@ class _PigeonCodec extends StandardMessageCodec {
     }    else if (value is NotificationDataFromLaunch) {
       buffer.putUint8(129);
       writeValue(buffer, value.encode());
+    }    else if (value is NotificationTapEvent) {
+      buffer.putUint8(130);
+      writeValue(buffer, value.encode());
     } else {
       super.writeValue(buffer, value);
     }
@@ -95,12 +143,16 @@ class _PigeonCodec extends StandardMessageCodec {
     switch (type) {
       case 129: 
         return NotificationDataFromLaunch.decode(readValue(buffer)!);
+      case 130: 
+        return NotificationTapEvent.decode(readValue(buffer)!);
       default:
         return super.readValueOfType(type, buffer);
     }
   }
 }
 
+const StandardMethodCodec pigeonMethodCodec = StandardMethodCodec(_PigeonCodec());
+
 class NotificationHostApi {
   /// Constructor for [NotificationHostApi].  The [binaryMessenger] named argument is
   /// available for dependency injection.  If it is left null, the default
@@ -144,3 +196,15 @@ class NotificationHostApi {
     }
   }
 }
+
+Stream<NotificationTapEvent> notificationTapEvents( {String instanceName = ''}) {
+  if (instanceName.isNotEmpty) {
+    instanceName = '.$instanceName';
+  }
+  final EventChannel notificationTapEventsChannel =
+      EventChannel('dev.flutter.pigeon.zulip.NotificationEventChannelApi.notificationTapEvents$instanceName', pigeonMethodCodec);
+  return notificationTapEventsChannel.receiveBroadcastStream().map((dynamic event) {
+    return event as NotificationTapEvent;
+  });
+}
+    

lib/model/binding.dart

@@ -328,11 +328,17 @@ class PackageInfo {
   });
 }
 
+// Pigeon generates methods under `@EventChannelApi` annotated classes
+// in global scope of the generated file. This is a helper class to
+// namespace the notification related Pigeon API under a single class.
 class NotificationPigeonApi {
   final _hostApi = notif_pigeon.NotificationHostApi();
 
   Future<notif_pigeon.NotificationDataFromLaunch?> getNotificationDataFromLaunch() =>
     _hostApi.getNotificationDataFromLaunch();
+
+  Stream<notif_pigeon.NotificationTapEvent> notificationTapEventsStream() =>
+    notif_pigeon.notificationTapEvents();
 }
 
 /// A concrete binding for use in the live application.

lib/notifications/navigate.dart

@@ -11,6 +11,7 @@ import '../host/notifications.dart';
 import '../log.dart';
 import '../model/binding.dart';
 import '../model/narrow.dart';
+import '../widgets/app.dart';
 import '../widgets/dialog.dart';
 import '../widgets/message_list.dart';
 import '../widgets/page.dart';
@@ -48,6 +49,8 @@ class NotificationNavigationService {
       switch (defaultTargetPlatform) {
         case TargetPlatform.iOS:
           _notifDataFromLaunch = await _notifPigeonApi.getNotificationDataFromLaunch();
+          _notifPigeonApi.notificationTapEventsStream()
+            .listen(_navigateForNotification);
 
         case TargetPlatform.android:
           // Do nothing; we do notification routing differently on Android.
@@ -113,7 +116,27 @@ class NotificationNavigationService {
       narrow: data.narrow);
   }
 
-  static NotificationNavigationData? _tryParsePayload(
+  /// Navigates to the [MessageListPage] of the specific conversation
+  /// for the provided payload that was attached while creating the
+  /// notification.
+  Future<void> _navigateForNotification(NotificationTapEvent event) async {
+    assert(debugLog('opened notif: ${jsonEncode(event.payload)}'));
+
+    NavigatorState navigator = await ZulipApp.navigator;
+    final context = navigator.context;
+    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 notifNavData = _tryParsePayload(context, event.payload);
+    if (notifNavData == null) return; // TODO(log)
+    final route = routeForNotification(context, notifNavData);
+    if (route == null) return; // TODO(log)
+
+    // TODO(nav): Better interact with existing nav stack on notif open
+    unawaited(navigator.push(route));
+  }
+
+  NotificationNavigationData? _tryParsePayload(
     BuildContext context,
     Map<Object?, Object?> payload,
   ) {

pigeon/notifications.dart

@@ -17,6 +17,16 @@ class NotificationDataFromLaunch {
   final Map<Object?, Object?> payload;
 }
 
+class NotificationTapEvent {
+  const NotificationTapEvent({required this.payload});
+
+  /// The raw payload that is attached to the notification,
+  /// holding the information required to carry out the navigation.
+  ///
+  /// See [notificationTapEvents].
+  final Map<Object?, Object?> payload;
+}
+
 @HostApi()
 abstract class NotificationHostApi {
   /// Retrieves notification data if the app was launched by tapping on a notification.
@@ -28,3 +38,16 @@ abstract class NotificationHostApi {
   ///   https://developer.apple.com/documentation/uikit/uiapplication/launchoptionskey/remotenotification
   NotificationDataFromLaunch? getNotificationDataFromLaunch();
 }
+
+@EventChannelApi()
+abstract class NotificationEventChannelApi {
+  /// An event stream that emits a notification payload when the app
+  /// encounters a notification tap, while the app is running.
+  ///
+  /// Emits an event when
+  /// `userNotificationCenter(_:didReceive:withCompletionHandler:)` gets
+  /// called, indicating that the user has tapped on a notification. The
+  /// emitted payload will be the raw APNs data dictionary from the
+  /// `UNNotificationResponse` passed to that method.
+  NotificationTapEvent notificationTapEvents();
+}

test/model/binding.dart

@@ -773,6 +773,18 @@ class FakeNotificationPigeonApi implements NotificationPigeonApi {
   @override
   Future<NotificationDataFromLaunch?> getNotificationDataFromLaunch() async =>
     _notificationDataFromLaunch;
+
+  StreamController<NotificationTapEvent>? _notificationTapEventsStreamController;
+
+  void addNotificationTapEvent(NotificationTapEvent event) {
+    _notificationTapEventsStreamController!.add(event);
+  }
+
+  @override
+  Stream<NotificationTapEvent> notificationTapEventsStream() {
+    _notificationTapEventsStreamController ??= StreamController();
+    return _notificationTapEventsStreamController!.stream;
+  }
 }
 
 typedef AndroidNotificationHostApiNotifyCall = ({