notif: Create summary notification

Fixes: zulip#569
Fixes: zulip#571

Author: rajveermalviya

android/app/src/main/kotlin/com/zulip/flutter/Notifications.g.kt

@@ -81,11 +81,35 @@ data class PendingIntent (
     )
   }
 }
+
+/** Generated class from Pigeon that represents data sent in messages. */
+data class InboxStyle (
+  val summaryText: String
+
+) {
+  companion object {
+    @Suppress("UNCHECKED_CAST")
+    fun fromList(list: List<Any?>): InboxStyle {
+      val summaryText = list[0] as String
+      return InboxStyle(summaryText)
+    }
+  }
+  fun toList(): List<Any?> {
+    return listOf<Any?>(
+      summaryText,
+    )
+  }
+}
 @Suppress("UNCHECKED_CAST")
 private object AndroidNotificationHostApiCodec : StandardMessageCodec() {
   override fun readValueOfType(type: Byte, buffer: ByteBuffer): Any? {
     return when (type) {
       128.toByte() -> {
+        return (readValue(buffer) as? List<Any?>)?.let {
+          InboxStyle.fromList(it)
+        }
+      }
+      129.toByte() -> {
         return (readValue(buffer) as? List<Any?>)?.let {
           PendingIntent.fromList(it)
         }
@@ -95,10 +119,14 @@ private object AndroidNotificationHostApiCodec : StandardMessageCodec() {
   }
   override fun writeValue(stream: ByteArrayOutputStream, value: Any?)   {
     when (value) {
-      is PendingIntent -> {
+      is InboxStyle -> {
         stream.write(128)
         writeValue(stream, value.toList())
       }
+      is PendingIntent -> {
+        stream.write(129)
+        writeValue(stream, value.toList())
+      }
       else -> super.writeValue(stream, value)
     }
   }
@@ -125,7 +153,7 @@ interface AndroidNotificationHostApi {
    *   https://developer.android.com/reference/kotlin/android/app/NotificationManager.html#notify
    *   https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder
    */
-  fun notify(tag: String?, id: Long, channelId: String, color: Long?, contentIntent: PendingIntent?, contentText: String?, contentTitle: String?, extras: Map<String?, String?>?, smallIconResourceName: String?)
+  fun notify(tag: String?, id: Long, channelId: String, color: Long?, contentIntent: PendingIntent?, contentText: String?, contentTitle: String?, extras: Map<String?, String?>?, smallIconResourceName: String?, groupKey: String?, isGroupSummary: Boolean?, inboxStyle: InboxStyle?, autoCancel: Boolean?)
 
   companion object {
     /** The codec used by AndroidNotificationHostApi. */
@@ -150,9 +178,13 @@ interface AndroidNotificationHostApi {
             val contentTitleArg = args[6] as String?
             val extrasArg = args[7] as Map<String?, String?>?
             val smallIconResourceNameArg = args[8] as String?
+            val groupKeyArg = args[9] as String?
+            val isGroupSummaryArg = args[10] as Boolean?
+            val inboxStyleArg = args[11] as InboxStyle?
+            val autoCancelArg = args[12] as Boolean?
             var wrapped: List<Any?>
             try {
-              api.notify(tagArg, idArg, channelIdArg, colorArg, contentIntentArg, contentTextArg, contentTitleArg, extrasArg, smallIconResourceNameArg)
+              api.notify(tagArg, idArg, channelIdArg, colorArg, contentIntentArg, contentTextArg, contentTitleArg, extrasArg, smallIconResourceNameArg, groupKeyArg, isGroupSummaryArg, inboxStyleArg, autoCancelArg)
               wrapped = listOf<Any?>(null)
             } catch (exception: Throwable) {
               wrapped = wrapError(exception)

android/app/src/main/kotlin/com/zulip/flutter/ZulipPlugin.kt

@@ -29,7 +29,11 @@ private class AndroidNotificationHost(val context: Context)
         contentText: String?,
         contentTitle: String?,
         extras: Map<String?, String?>?,
-        smallIconResourceName: String?
+        smallIconResourceName: String?,
+        groupKey: String?,
+        isGroupSummary: Boolean?,
+        inboxStyle: InboxStyle?,
+        autoCancel: Boolean?
     ) {
         val notification = NotificationCompat.Builder(context, channelId).apply {
             color?.let { setColor(it.toInt()) }
@@ -51,6 +55,13 @@ private class AndroidNotificationHost(val context: Context)
                 Bundle().apply { it.forEach { (k, v) -> putString(k, v) } } ) }
             smallIconResourceName?.let { setSmallIcon(context.resources.getIdentifier(
                 it, "drawable", context.packageName)) }
+            groupKey?.let { setGroup(it) }
+            isGroupSummary?.let { setGroupSummary(it) }
+            inboxStyle?.let { setStyle(
+                NotificationCompat.InboxStyle()
+                    .setSummaryText(it.summaryText)
+            ) }
+            autoCancel?.let { setAutoCancel(it) }
         }.build()
         NotificationManagerCompat.from(context).notify(tag, id.toInt(), notification)
     }

lib/host/android_notifications.g.dart

@@ -53,13 +53,37 @@ class PendingIntent {
   }
 }
 
+class InboxStyle {
+  InboxStyle({
+    required this.summaryText,
+  });
+
+  String summaryText;
+
+  Object encode() {
+    return <Object?>[
+      summaryText,
+    ];
+  }
+
+  static InboxStyle decode(Object result) {
+    result as List<Object?>;
+    return InboxStyle(
+      summaryText: result[0]! as String,
+    );
+  }
+}
+
 class _AndroidNotificationHostApiCodec extends StandardMessageCodec {
   const _AndroidNotificationHostApiCodec();
   @override
   void writeValue(WriteBuffer buffer, Object? value) {
-    if (value is PendingIntent) {
+    if (value is InboxStyle) {
       buffer.putUint8(128);
       writeValue(buffer, value.encode());
+    } else if (value is PendingIntent) {
+      buffer.putUint8(129);
+      writeValue(buffer, value.encode());
     } else {
       super.writeValue(buffer, value);
     }
@@ -69,6 +93,8 @@ class _AndroidNotificationHostApiCodec extends StandardMessageCodec {
   Object? readValueOfType(int type, ReadBuffer buffer) {
     switch (type) {
       case 128: 
+        return InboxStyle.decode(readValue(buffer)!);
+      case 129: 
         return PendingIntent.decode(readValue(buffer)!);
       default:
         return super.readValueOfType(type, buffer);
@@ -106,15 +132,15 @@ class AndroidNotificationHostApi {
   /// See:
   ///   https://developer.android.com/reference/kotlin/android/app/NotificationManager.html#notify
   ///   https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder
-  Future<void> notify({String? tag, required int id, required String channelId, int? color, PendingIntent? contentIntent, String? contentText, String? contentTitle, Map<String?, String?>? extras, String? smallIconResourceName,}) async {
+  Future<void> notify({String? tag, required int id, required String channelId, int? color, PendingIntent? contentIntent, String? contentText, String? contentTitle, Map<String?, String?>? extras, String? smallIconResourceName, String? groupKey, bool? isGroupSummary, InboxStyle? inboxStyle, bool? autoCancel,}) async {
     final String __pigeon_channelName = 'dev.flutter.pigeon.zulip.AndroidNotificationHostApi.notify$__pigeon_messageChannelSuffix';
     final BasicMessageChannel<Object?> __pigeon_channel = BasicMessageChannel<Object?>(
       __pigeon_channelName,
       pigeonChannelCodec,
       binaryMessenger: __pigeon_binaryMessenger,
     );
     final List<Object?>? __pigeon_replyList =
-        await __pigeon_channel.send(<Object?>[tag, id, channelId, color, contentIntent, contentText, contentTitle, extras, smallIconResourceName]) as List<Object?>?;
+        await __pigeon_channel.send(<Object?>[tag, id, channelId, color, contentIntent, contentText, contentTitle, extras, smallIconResourceName, groupKey, isGroupSummary, inboxStyle, autoCancel]) as List<Object?>?;
     if (__pigeon_replyList == null) {
       throw _createConnectionError(__pigeon_channelName);
     } else if (__pigeon_replyList.length > 1) {

lib/notifications/display.dart

@@ -89,7 +89,7 @@ class NotificationDisplayManager {
     }
   }
 
-  static void _onMessageFcmMessage(MessageFcmMessage data, Map<String, dynamic> dataJson) {
+  static Future<void> _onMessageFcmMessage(MessageFcmMessage data, Map<String, dynamic> dataJson) async {
     assert(debugLog('notif message content: ${data.content}'));
     final zulipLocalizations = GlobalLocalizations.zulipLocalizations;
     final title = switch (data.recipient) {
@@ -103,13 +103,16 @@ class NotificationDisplayManager {
       FcmMessageDmRecipient() =>
         data.senderFullName,
     };
-    final conversationKey = _conversationKey(data);
-    ZulipBinding.instance.androidNotificationHost.notify(
+    final groupKey = _groupKey(data);
+    final conversationKey = _conversationKey(data, groupKey);
+
+    await ZulipBinding.instance.androidNotificationHost.notify(
       // TODO the notification ID can be constant, instead of matching requestCode
       //   (This is a legacy of `flutter_local_notifications`.)
       id: notificationIdAsHashOf(conversationKey),
       tag: conversationKey,
       channelId: NotificationChannelManager.kChannelId,
+      groupKey: groupKey,
 
       contentTitle: title,
       contentText: data.content,
@@ -139,6 +142,22 @@ class NotificationDisplayManager {
         // TODO this doesn't set the Intent flags we set in zulip-mobile; is that OK?
         //   (This is a legacy of `flutter_local_notifications`.)
         ),
+      autoCancel: true,
+    );
+
+    await ZulipBinding.instance.androidNotificationHost.notify(
+      id: notificationIdAsHashOf(groupKey),
+      channelId: NotificationChannelManager.kChannelId,
+      tag: groupKey,
+      groupKey: groupKey,
+      isGroupSummary: true,
+      color: kZulipBrandColor.value,
+      // TODO vary notification icon for debug
+      smallIconResourceName: 'zulip_notification', // This name must appear in keep.xml too: https://github.com/zulip/zulip-flutter/issues/528
+      inboxStyle: InboxStyle(
+        // TODO(#570) Show organization name, not URL
+        summaryText: data.realmUri.toString()),
+      autoCancel: true,
     );
   }
 
@@ -157,8 +176,7 @@ class NotificationDisplayManager {
       | ((bytes[3] & 0x7f) << 24);
   }
 
-  static String _conversationKey(MessageFcmMessage data) {
-    final groupKey = _groupKey(data);
+  static String _conversationKey(MessageFcmMessage data, String groupKey) {
     final conversation = switch (data.recipient) {
       FcmMessageStreamRecipient(:var streamId, :var topic) => 'stream:$streamId:$topic',
       FcmMessageDmRecipient(:var allRecipientIds) => 'dm:${allRecipientIds.join(',')}',

pigeon/notifications.dart

@@ -27,6 +27,12 @@ class PendingIntent {
   final int flags;
 }
 
+class InboxStyle {
+  InboxStyle({required this.summaryText});
+
+  final String summaryText;
+}
+
 @HostApi()
 abstract class AndroidNotificationHostApi {
   /// Corresponds to `android.app.NotificationManager.notify`,
@@ -59,6 +65,10 @@ abstract class AndroidNotificationHostApi {
     String? contentTitle,
     Map<String?, String?>? extras,
     String? smallIconResourceName,
+    String? groupKey,
+    bool? isGroupSummary,
+    InboxStyle? inboxStyle,
+    bool? autoCancel,
     // NotificationCompat.Builder has lots more methods; add as needed.
   });
 }

test/model/binding.dart

@@ -503,6 +503,10 @@ class FakeAndroidNotificationHostApi implements AndroidNotificationHostApi {
     String? contentTitle,
     Map<String?, String?>? extras,
     String? smallIconResourceName,
+    String? groupKey,
+    bool? isGroupSummary,
+    InboxStyle? inboxStyle,
+    bool? autoCancel,
   }) async {
     _notifyCalls.add((
       tag: tag,
@@ -514,6 +518,10 @@ class FakeAndroidNotificationHostApi implements AndroidNotificationHostApi {
       contentTitle: contentTitle,
       extras: extras,
       smallIconResourceName: smallIconResourceName,
+      groupKey: groupKey,
+      isGroupSummary: isGroupSummary,
+      inboxStyle: inboxStyle,
+      autoCancel: autoCancel,
     ));
   }
 }
@@ -528,4 +536,8 @@ typedef AndroidNotificationHostApiNotifyCall = ({
   String? contentTitle,
   Map<String?, String?>? extras,
   String? smallIconResourceName,
+  String? groupKey,
+  bool? isGroupSummary,
+  InboxStyle? inboxStyle,
+  bool? autoCancel,
 });

test/notifications/display_test.dart

@@ -110,12 +110,14 @@ void main() {
       required String expectedTitle,
       required String expectedTagComponent,
     }) {
-      final expectedTag = '${data.realmUri}|${data.userId}|$expectedTagComponent';
+      final expectedGroupKey = '${data.realmUri}|${data.userId}';
+      final expectedTag = '$expectedGroupKey|$expectedTagComponent';
       final expectedId =
         NotificationDisplayManager.notificationIdAsHashOf(expectedTag);
       const expectedIntentFlags =
         PendingIntentFlag.immutable | PendingIntentFlag.updateCurrent;
-      check(testBinding.androidNotificationHost.takeNotifyCalls()).single
+      final calls = testBinding.androidNotificationHost.takeNotifyCalls();
+      check(calls[0])
         ..id.equals(expectedId)
         ..tag.equals(expectedTag)
         ..channelId.equals(NotificationChannelManager.kChannelId)
@@ -124,11 +126,31 @@ void main() {
         ..color.equals(kZulipBrandColor.value)
         ..smallIconResourceName.equals('zulip_notification')
         ..extras.isNull()
+        ..groupKey.equals(expectedGroupKey)
+        ..isGroupSummary.isNull()
+        ..inboxStyle.isNull()
+        ..autoCancel.equals(true)
         ..contentIntent.which((it) => it.isNotNull()
           ..requestCode.equals(expectedId)
           ..flags.equals(expectedIntentFlags)
           ..intentPayload.equals(jsonEncode(data.toJson()))
         );
+      check(calls[1])
+        ..id.equals(NotificationDisplayManager.notificationIdAsHashOf(expectedGroupKey))
+        ..tag.equals(expectedGroupKey)
+        ..channelId.equals(NotificationChannelManager.kChannelId)
+        ..contentTitle.isNull()
+        ..contentText.isNull()
+        ..color.equals(kZulipBrandColor.value)
+        ..smallIconResourceName.equals('zulip_notification')
+        ..extras.isNull()
+        ..groupKey.equals(expectedGroupKey)
+        ..isGroupSummary.equals(true)
+        ..inboxStyle.which((it) => it.isNotNull()
+          ..summaryText.equals(data.realmUri.toString())
+        )
+        ..autoCancel.equals(true)
+        ..contentIntent.isNull();
     }
 
     Future<void> checkNotifications(FakeAsync async, MessageFcmMessage data, {
@@ -157,7 +179,7 @@ void main() {
       final stream = eg.stream();
       final message = eg.streamMessage(stream: stream);
       await checkNotifications(async, messageFcmMessage(message, streamName: stream.name),
-        expectedTitle: '${stream.name} > ${message.subject}',
+        expectedTitle: '#${stream.name} > ${message.subject}',
         expectedTagComponent: 'stream:${message.streamId}:${message.subject}');
     }));
 
@@ -166,7 +188,7 @@ void main() {
       final stream = eg.stream();
       final message = eg.streamMessage(stream: stream);
       await checkNotifications(async, messageFcmMessage(message, streamName: null),
-        expectedTitle: '(unknown stream) > ${message.subject}',
+        expectedTitle: '#(unknown stream) > ${message.subject}',
         expectedTagComponent: 'stream:${message.streamId}:${message.subject}');
     }));
 
@@ -376,10 +398,18 @@ extension on Subject<AndroidNotificationHostApiNotifyCall> {
   Subject<String?> get contentTitle => has((x) => x.contentTitle, 'contentTitle');
   Subject<Map<String?, String?>?> get extras => has((x) => x.extras, 'extras');
   Subject<String?> get smallIconResourceName => has((x) => x.smallIconResourceName, 'smallIconResourceName');
+  Subject<String?> get groupKey => has((x) => x.groupKey, 'groupKey');
+  Subject<bool?> get isGroupSummary => has((x) => x.isGroupSummary, 'isGroupSummary');
+  Subject<InboxStyle?> get inboxStyle => has((x) => x.inboxStyle, 'inboxStyle');
+  Subject<bool?> get autoCancel => has((x) => x.autoCancel, 'autoCancel');
 }
 
 extension on Subject<PendingIntent> {
   Subject<int> get requestCode => has((x) => x.requestCode, 'requestCode');
   Subject<String> get intentPayload => has((x) => x.intentPayload, 'intentPayload');
   Subject<int> get flags => has((x) => x.flags, 'flags');
 }
+
+extension on Subject<InboxStyle> {
+  Subject<String> get summaryText => has((x) => x.summaryText, 'summaryText');
+}