notif [nfc]: Replace intentPayload with AndroidIntent.extras

Author: rajveermalviya

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

@@ -87,6 +87,32 @@ data class NotificationChannel (
   }
 }
 
+/**
+ * Corresponds to `android.content.Intent`
+ *
+ * See:
+ *   https://developer.android.com/reference/android/content/Intent
+ *
+ * Generated class from Pigeon that represents data sent in messages.
+ */
+data class AndroidIntent (
+  val extras: Map<String?, String?>
+
+) {
+  companion object {
+    @Suppress("LocalVariableName")
+    fun fromList(__pigeon_list: List<Any?>): AndroidIntent {
+      val extras = __pigeon_list[0] as Map<String?, String?>
+      return AndroidIntent(extras)
+    }
+  }
+  fun toList(): List<Any?> {
+    return listOf(
+      extras,
+    )
+  }
+}
+
 /**
  * Corresponds to `android.app.PendingIntent`.
  *
@@ -96,11 +122,7 @@ data class NotificationChannel (
  */
 data class PendingIntent (
   val requestCode: Long,
-  /**
-   * A value set on an extra on the Intent, and passed to
-   * the on-notification-opened callback.
-   */
-  val intentPayload: String,
+  val intent: AndroidIntent,
   /**
    * A combination of flags from [PendingIntent.flags], and others associated
    * with `Intent`; see Android docs for `PendingIntent.getActivity`.
@@ -112,15 +134,15 @@ data class PendingIntent (
     @Suppress("LocalVariableName")
     fun fromList(__pigeon_list: List<Any?>): PendingIntent {
       val requestCode = __pigeon_list[0].let { num -> if (num is Int) num.toLong() else num as Long }
-      val intentPayload = __pigeon_list[1] as String
+      val intent = __pigeon_list[1] as AndroidIntent
       val flags = __pigeon_list[2].let { num -> if (num is Int) num.toLong() else num as Long }
-      return PendingIntent(requestCode, intentPayload, flags)
+      return PendingIntent(requestCode, intent, flags)
     }
   }
   fun toList(): List<Any?> {
     return listOf(
       requestCode,
-      intentPayload,
+      intent,
       flags,
     )
   }
@@ -266,25 +288,30 @@ private object NotificationsPigeonCodec : StandardMessageCodec() {
       }
       130.toByte() -> {
         return (readValue(buffer) as? List<Any?>)?.let {
-          PendingIntent.fromList(it)
+          AndroidIntent.fromList(it)
         }
       }
       131.toByte() -> {
         return (readValue(buffer) as? List<Any?>)?.let {
-          InboxStyle.fromList(it)
+          PendingIntent.fromList(it)
         }
       }
       132.toByte() -> {
         return (readValue(buffer) as? List<Any?>)?.let {
-          Person.fromList(it)
+          InboxStyle.fromList(it)
         }
       }
       133.toByte() -> {
         return (readValue(buffer) as? List<Any?>)?.let {
-          MessagingStyleMessage.fromList(it)
+          Person.fromList(it)
         }
       }
       134.toByte() -> {
+        return (readValue(buffer) as? List<Any?>)?.let {
+          MessagingStyleMessage.fromList(it)
+        }
+      }
+      135.toByte() -> {
         return (readValue(buffer) as? List<Any?>)?.let {
           MessagingStyle.fromList(it)
         }
@@ -298,26 +325,30 @@ private object NotificationsPigeonCodec : StandardMessageCodec() {
         stream.write(129)
         writeValue(stream, value.toList())
       }
-      is PendingIntent -> {
+      is AndroidIntent -> {
         stream.write(130)
         writeValue(stream, value.toList())
       }
-      is InboxStyle -> {
+      is PendingIntent -> {
         stream.write(131)
         writeValue(stream, value.toList())
       }
-      is Person -> {
+      is InboxStyle -> {
         stream.write(132)
         writeValue(stream, value.toList())
       }
-      is MessagingStyleMessage -> {
+      is Person -> {
         stream.write(133)
         writeValue(stream, value.toList())
       }
-      is MessagingStyle -> {
+      is MessagingStyleMessage -> {
         stream.write(134)
         writeValue(stream, value.toList())
       }
+      is MessagingStyle -> {
+        stream.write(135)
+        writeValue(stream, value.toList())
+      }
       else -> super.writeValue(stream, value)
     }
   }

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

@@ -87,7 +87,7 @@ private class AndroidNotificationHost(val context: Context)
                         // FlutterLocalNotificationsPlugin, which handles receiving the Intent.
                         // TODO take care of receiving the notification-opened Intent ourselves
                         action = "SELECT_NOTIFICATION"
-                        putExtra("payload", it.intentPayload)
+                        it.intent.extras.forEach { (k, v) -> putExtra(k!!, v!!) }
                     },
                     it.flags.toInt())
             ) }

lib/host/android_notifications.g.dart

@@ -63,21 +63,44 @@ class NotificationChannel {
   }
 }
 
+/// Corresponds to `android.content.Intent`
+///
+/// See:
+///   https://developer.android.com/reference/android/content/Intent
+class AndroidIntent {
+  AndroidIntent({
+    required this.extras,
+  });
+
+  Map<String?, String?> extras;
+
+  Object encode() {
+    return <Object?>[
+      extras,
+    ];
+  }
+
+  static AndroidIntent decode(Object result) {
+    result as List<Object?>;
+    return AndroidIntent(
+      extras: (result[0] as Map<Object?, Object?>?)!.cast<String?, String?>(),
+    );
+  }
+}
+
 /// Corresponds to `android.app.PendingIntent`.
 ///
 /// See: https://developer.android.com/reference/android/app/PendingIntent
 class PendingIntent {
   PendingIntent({
     required this.requestCode,
-    required this.intentPayload,
+    required this.intent,
     required this.flags,
   });
 
   int requestCode;
 
-  /// A value set on an extra on the Intent, and passed to
-  /// the on-notification-opened callback.
-  String intentPayload;
+  AndroidIntent intent;
 
   /// A combination of flags from [PendingIntent.flags], and others associated
   /// with `Intent`; see Android docs for `PendingIntent.getActivity`.
@@ -86,7 +109,7 @@ class PendingIntent {
   Object encode() {
     return <Object?>[
       requestCode,
-      intentPayload,
+      intent,
       flags,
     ];
   }
@@ -95,7 +118,7 @@ class PendingIntent {
     result as List<Object?>;
     return PendingIntent(
       requestCode: result[0]! as int,
-      intentPayload: result[1]! as String,
+      intent: result[1]! as AndroidIntent,
       flags: result[2]! as int,
     );
   }
@@ -248,21 +271,24 @@ class _PigeonCodec extends StandardMessageCodec {
     if (value is NotificationChannel) {
       buffer.putUint8(129);
       writeValue(buffer, value.encode());
-    } else     if (value is PendingIntent) {
+    } else     if (value is AndroidIntent) {
       buffer.putUint8(130);
       writeValue(buffer, value.encode());
-    } else     if (value is InboxStyle) {
+    } else     if (value is PendingIntent) {
       buffer.putUint8(131);
       writeValue(buffer, value.encode());
-    } else     if (value is Person) {
+    } else     if (value is InboxStyle) {
       buffer.putUint8(132);
       writeValue(buffer, value.encode());
-    } else     if (value is MessagingStyleMessage) {
+    } else     if (value is Person) {
       buffer.putUint8(133);
       writeValue(buffer, value.encode());
-    } else     if (value is MessagingStyle) {
+    } else     if (value is MessagingStyleMessage) {
       buffer.putUint8(134);
       writeValue(buffer, value.encode());
+    } else     if (value is MessagingStyle) {
+      buffer.putUint8(135);
+      writeValue(buffer, value.encode());
     } else {
       super.writeValue(buffer, value);
     }
@@ -274,14 +300,16 @@ class _PigeonCodec extends StandardMessageCodec {
       case 129: 
         return NotificationChannel.decode(readValue(buffer)!);
       case 130: 
-        return PendingIntent.decode(readValue(buffer)!);
+        return AndroidIntent.decode(readValue(buffer)!);
       case 131: 
-        return InboxStyle.decode(readValue(buffer)!);
+        return PendingIntent.decode(readValue(buffer)!);
       case 132: 
-        return Person.decode(readValue(buffer)!);
+        return InboxStyle.decode(readValue(buffer)!);
       case 133: 
-        return MessagingStyleMessage.decode(readValue(buffer)!);
+        return Person.decode(readValue(buffer)!);
       case 134: 
+        return MessagingStyleMessage.decode(readValue(buffer)!);
+      case 135: 
         return MessagingStyle.decode(readValue(buffer)!);
       default:
         return super.readValueOfType(type, buffer);

lib/notifications/display.dart

@@ -173,7 +173,8 @@ class NotificationDisplayManager {
         // TODO is setting PendingIntentFlag.updateCurrent OK?
         //   (That's a legacy of `flutter_local_notifications`.)
         flags: PendingIntentFlag.immutable | PendingIntentFlag.updateCurrent,
-        intentPayload: jsonEncode(dataJson),
+        intent: AndroidIntent(
+          extras: <String, String>{'payload': jsonEncode(dataJson)}),
         // TODO this doesn't set the Intent flags we set in zulip-mobile; is that OK?
         //   (This is a legacy of `flutter_local_notifications`.)
         ),

pigeon/notifications.dart

@@ -36,19 +36,27 @@ class NotificationChannel {
   final Int64List? vibrationPattern;
 }
 
+/// Corresponds to `android.content.Intent`
+///
+/// See:
+///   https://developer.android.com/reference/android/content/Intent
+class AndroidIntent {
+  AndroidIntent({required this.extras});
+
+  final Map<String?, String?> extras;
+}
+
 /// Corresponds to `android.app.PendingIntent`.
 ///
 /// See: https://developer.android.com/reference/android/app/PendingIntent
 class PendingIntent {
   /// Corresponds to `PendingIntent.getActivity`.
-  PendingIntent({required this.requestCode, required this.intentPayload, required this.flags});
+  ///
+  /// See: https://developer.android.com/reference/android/app/PendingIntent#getActivity(android.content.Context,%20int,%20android.content.Intent,%20int)
+  PendingIntent({required this.requestCode, required this.intent, required this.flags});
 
   final int requestCode;
-
-  /// A value set on an extra on the Intent, and passed to
-  /// the on-notification-opened callback.
-  // TODO replace intentPayload with a more direct wrapping of the underlying API
-  final String intentPayload;
+  final AndroidIntent intent;
 
   /// A combination of flags from [PendingIntent.flags], and others associated
   /// with `Intent`; see Android docs for `PendingIntent.getActivity`.

test/notifications/display_test.dart

@@ -179,7 +179,8 @@ void main() {
             ..contentIntent.which((it) => it.isNotNull()
               ..requestCode.equals(expectedId)
               ..flags.equals(expectedIntentFlags)
-              ..intentPayload.equals(jsonEncode(data.toJson()))),
+              ..intent.which((it) => it
+                ..extras.deepEquals({'payload': jsonEncode(data.toJson())}))),
           (it) => it.isA<AndroidNotificationHostApiNotifyCall>()
             ..id.equals(NotificationDisplayManager.notificationIdAsHashOf(expectedGroupKey))
             ..tag.equals(expectedGroupKey)
@@ -672,9 +673,13 @@ extension on Subject<AndroidNotificationHostApiNotifyCall> {
   Subject<String?> get smallIconResourceName => has((x) => x.smallIconResourceName, 'smallIconResourceName');
 }
 
+extension on Subject<AndroidIntent> {
+  Subject<Map<String?,String?>> get extras => has((x) => x.extras, 'extras');
+}
+
 extension on Subject<PendingIntent> {
   Subject<int> get requestCode => has((x) => x.requestCode, 'requestCode');
-  Subject<String> get intentPayload => has((x) => x.intentPayload, 'intentPayload');
+  Subject<AndroidIntent> get intent => has((x) => x.intent, 'intent');
   Subject<int> get flags => has((x) => x.flags, 'flags');
 }