Revert "refactor: Only initialize FlutterLocalNotificationsPlugin once"

This reverts commit d3a13705bd.

lib/utils/background_push.dart

@@ -71,7 +71,7 @@ class BackgroundPush {
 
   BackgroundPush._(this.client) {
     firebase?.setListeners(
-      onMessage: (message) => PushHelper.processNotification(
+      onMessage: (message) => pushHelper(
         PushNotification.fromJson(
           Map<String, dynamic>.from(message['data'] ?? message),
         ),
@@ -393,7 +393,7 @@ class BackgroundPush {
     );
     // UP may strip the devices list
     data['devices'] ??= [];
-    await PushHelper.processNotification(
+    await pushHelper(
       PushNotification.fromJson(data),
       client: client,
       l10n: l10n,

lib/utils/push_helper.dart

@@ -18,20 +18,27 @@ import 'package:fluffychat/utils/matrix_sdk_extensions/matrix_locals.dart';
 import 'package:fluffychat/utils/platform_infos.dart';
 import 'package:fluffychat/utils/voip/callkeep_manager.dart';
 
-abstract class PushHelper {
+Future<void> pushHelper(
-  static FlutterLocalNotificationsPlugin? _flutterLocalNotificationsPlugin;
+  PushNotification notification, {
-
+  Client? client,
-  static Future<FlutterLocalNotificationsPlugin> _getLocalNotificationsPlugin({
+  L10n? l10n,
-    void Function(NotificationResponse?)? onSelectNotification,
+  String? activeRoomId,
-  }) async {
+  void Function(NotificationResponse?)? onSelectNotification,
-    var flutterlocalNotifcationsPlugin = _flutterLocalNotificationsPlugin;
+}) async {
-    if (flutterlocalNotifcationsPlugin != null) {
+  try {
-      return flutterlocalNotifcationsPlugin;
+    await _tryPushHelper(
-    }
+      notification,
+      client: client,
+      l10n: l10n,
+      activeRoomId: activeRoomId,
+      onSelectNotification: onSelectNotification,
+    );
+  } catch (e, s) {
+    Logs().v('Push Helper has crashed!', e, s);
 
-    flutterlocalNotifcationsPlugin =
+    // Initialise the plugin. app_icon needs to be a added as a drawable resource to the Android head project
-        _flutterLocalNotificationsPlugin = FlutterLocalNotificationsPlugin();
+    final flutterLocalNotificationsPlugin = FlutterLocalNotificationsPlugin();
-    await flutterlocalNotifcationsPlugin.initialize(
+    await flutterLocalNotificationsPlugin.initialize(
       const InitializationSettings(
         android: AndroidInitializationSettings('notifications_icon'),
         iOS: DarwinInitializationSettings(),
@@ -39,319 +46,299 @@ abstract class PushHelper {
       onDidReceiveNotificationResponse: onSelectNotification,
       onDidReceiveBackgroundNotificationResponse: onSelectNotification,
     );
-    return flutterlocalNotifcationsPlugin;
-  }
 
-  static Future<void> processNotification(
+    l10n ??= lookupL10n(const Locale('en'));
-    PushNotification notification, {
+    flutterLocalNotificationsPlugin.show(
-    Client? client,
+      notification.roomId?.hashCode ?? 0,
-    L10n? l10n,
+      l10n.newMessageInFluffyChat,
-    String? activeRoomId,
+      l10n.openAppToReadMessages,
-    void Function(NotificationResponse?)? onSelectNotification,
+      NotificationDetails(
-  }) async {
+        iOS: const DarwinNotificationDetails(),
-    try {
+        android: AndroidNotificationDetails(
-      await _tryPushHelper(
+          AppConfig.pushNotificationsChannelId,
-        notification,
+          l10n.incomingMessages,
-        client: client,
+          number: notification.counts?.unread,
-        l10n: l10n,
+          ticker: l10n.unreadChatsInApp(
-        activeRoomId: activeRoomId,
+            AppConfig.applicationName,
-        onSelectNotification: onSelectNotification,
+            (notification.counts?.unread ?? 0).toString(),
-      );
-    } catch (e, s) {
-      Logs().v('Push Helper has crashed!', e, s);
-
-      final flutterLocalNotificationsPlugin =
-          await _getLocalNotificationsPlugin(
-        onSelectNotification: onSelectNotification,
-      );
-
-      l10n ??= lookupL10n(const Locale('en'));
-      flutterLocalNotificationsPlugin.show(
-        notification.roomId?.hashCode ?? 0,
-        l10n.newMessageInFluffyChat,
-        l10n.openAppToReadMessages,
-        NotificationDetails(
-          iOS: const DarwinNotificationDetails(),
-          android: AndroidNotificationDetails(
-            AppConfig.pushNotificationsChannelId,
-            l10n.incomingMessages,
-            number: notification.counts?.unread,
-            ticker: l10n.unreadChatsInApp(
-              AppConfig.applicationName,
-              (notification.counts?.unread ?? 0).toString(),
-            ),
-            importance: Importance.high,
-            priority: Priority.max,
-            shortcutId: notification.roomId,
           ),
+          importance: Importance.high,
+          priority: Priority.max,
+          shortcutId: notification.roomId,
         ),
-      );
+      ),
-      rethrow;
-    }
-  }
-
-  static Future<void> _tryPushHelper(
-    PushNotification notification, {
-    Client? client,
-    L10n? l10n,
-    String? activeRoomId,
-    void Function(NotificationResponse?)? onSelectNotification,
-  }) async {
-    final isBackgroundMessage = client == null;
-    Logs().v(
-      'Push helper has been started (background=$isBackgroundMessage).',
-      notification.toJson(),
-    );
-
-    if (notification.roomId != null &&
-        activeRoomId == notification.roomId &&
-        WidgetsBinding.instance.lifecycleState == AppLifecycleState.resumed) {
-      Logs().v('Room is in foreground. Stop push helper here.');
-      return;
-    }
-
-    final flutterLocalNotificationsPlugin = await _getLocalNotificationsPlugin(
-      onSelectNotification: onSelectNotification,
     );
+    rethrow;
+  }
+}
 
-    client ??= (await ClientManager.getClients(
+Future<void> _tryPushHelper(
-      initialize: false,
+  PushNotification notification, {
-      store: await SharedPreferences.getInstance(),
+  Client? client,
-    ))
+  L10n? l10n,
-        .first;
+  String? activeRoomId,
-    final event = await client.getEventByPushNotification(
+  void Function(NotificationResponse?)? onSelectNotification,
-      notification,
+}) async {
-      storeInDatabase: isBackgroundMessage,
+  final isBackgroundMessage = client == null;
-    );
+  Logs().v(
+    'Push helper has been started (background=$isBackgroundMessage).',
+    notification.toJson(),
+  );
+
+  if (notification.roomId != null &&
+      activeRoomId == notification.roomId &&
+      WidgetsBinding.instance.lifecycleState == AppLifecycleState.resumed) {
+    Logs().v('Room is in foreground. Stop push helper here.');
+    return;
+  }
 
-    if (event == null) {
+  // Initialise the plugin. app_icon needs to be a added as a drawable resource to the Android head project
-      Logs().v('Notification is a clearing indicator.');
+  final flutterLocalNotificationsPlugin = FlutterLocalNotificationsPlugin();
-      if (notification.counts?.unread == null ||
+  await flutterLocalNotificationsPlugin.initialize(
-          notification.counts?.unread == 0) {
+    const InitializationSettings(
-        await flutterLocalNotificationsPlugin.cancelAll();
+      android: AndroidInitializationSettings('notifications_icon'),
-      } else {
+      iOS: DarwinInitializationSettings(),
-        // Make sure client is fully loaded and synced before dismiss notifications:
+    ),
-        await client.roomsLoading;
+    onDidReceiveNotificationResponse: onSelectNotification,
-        await client.oneShotSync();
+    //onDidReceiveBackgroundNotificationResponse: onSelectNotification,
-        final activeNotifications =
+  );
-            await flutterLocalNotificationsPlugin.getActiveNotifications();
+
-        for (final activeNotification in activeNotifications) {
+  client ??= (await ClientManager.getClients(
-          final room = client.rooms.singleWhereOrNull(
+    initialize: false,
-            (room) => room.id.hashCode == activeNotification.id,
+    store: await SharedPreferences.getInstance(),
-          );
+  ))
-          if (room == null || !room.isUnreadOrInvited) {
+      .first;
-            flutterLocalNotificationsPlugin.cancel(activeNotification.id!);
+  final event = await client.getEventByPushNotification(
-          }
+    notification,
+    storeInDatabase: isBackgroundMessage,
+  );
+
+  if (event == null) {
+    Logs().v('Notification is a clearing indicator.');
+    if (notification.counts?.unread == null ||
+        notification.counts?.unread == 0) {
+      await flutterLocalNotificationsPlugin.cancelAll();
+    } else {
+      // Make sure client is fully loaded and synced before dismiss notifications:
+      await client.roomsLoading;
+      await client.oneShotSync();
+      final activeNotifications =
+          await flutterLocalNotificationsPlugin.getActiveNotifications();
+      for (final activeNotification in activeNotifications) {
+        final room = client.rooms.singleWhereOrNull(
+          (room) => room.id.hashCode == activeNotification.id,
+        );
+        if (room == null || !room.isUnreadOrInvited) {
+          flutterLocalNotificationsPlugin.cancel(activeNotification.id!);
         }
       }
-      return;
-    }
-    Logs().v('Push helper got notification event of type ${event.type}.');
-
-    if (event.type.startsWith('m.call')) {
-      // make sure bg sync is on (needed to update hold, unhold events)
-      // prevent over write from app life cycle change
-      client.backgroundSync = true;
-    }
-
-    if (event.type == EventTypes.CallInvite) {
-      CallKeepManager().initialize();
-    } else if (event.type == EventTypes.CallHangup) {
-      client.backgroundSync = false;
-    }
-
-    if (event.type.startsWith('m.call') &&
-        event.type != EventTypes.CallInvite) {
-      Logs().v('Push message is a m.call but not invite. Do not display.');
-      return;
     }
+    return;
+  }
+  Logs().v('Push helper got notification event of type ${event.type}.');
 
-    if ((event.type.startsWith('m.call') &&
+  if (event.type.startsWith('m.call')) {
-            event.type != EventTypes.CallInvite) ||
+    // make sure bg sync is on (needed to update hold, unhold events)
-        event.type == 'org.matrix.call.sdp_stream_metadata_changed') {
+    // prevent over write from app life cycle change
-      Logs().v('Push message was for a call, but not call invite.');
+    client.backgroundSync = true;
-      return;
+  }
-    }
 
-    l10n ??= await L10n.delegate.load(PlatformDispatcher.instance.locale);
+  if (event.type == EventTypes.CallInvite) {
-    final matrixLocals = MatrixLocals(l10n);
+    CallKeepManager().initialize();
-
+  } else if (event.type == EventTypes.CallHangup) {
-    // Calculate the body
+    client.backgroundSync = false;
-    final body = event.type == EventTypes.Encrypted
+  }
-        ? l10n.newMessageInFluffyChat
-        : await event.calcLocalizedBody(
-            matrixLocals,
-            plaintextBody: true,
-            withSenderNamePrefix: false,
-            hideReply: true,
-            hideEdit: true,
-            removeMarkdown: true,
-          );
-
-    // The person object for the android message style notification
-    final avatar = event.room.avatar
-        ?.getThumbnail(
-          client,
-          width: 256,
-          height: 256,
-        )
-        .toString();
-    final senderAvatar = event.room.isDirectChat
-        ? avatar
-        : event.senderFromMemoryOrFallback.avatarUrl
-            ?.getThumbnail(
-              client,
-              width: 256,
-              height: 256,
-            )
-            .toString();
-
-    File? roomAvatarFile, senderAvatarFile;
-    try {
-      roomAvatarFile = avatar == null
-          ? null
-          : await DefaultCacheManager().getSingleFile(avatar);
-    } catch (e, s) {
-      Logs().e('Unable to get avatar picture', e, s);
-    }
-    try {
-      senderAvatarFile = event.room.isDirectChat
-          ? roomAvatarFile
-          : senderAvatar == null
-              ? null
-              : await DefaultCacheManager().getSingleFile(senderAvatar);
-    } catch (e, s) {
-      Logs().e('Unable to get avatar picture', e, s);
-    }
 
-    final id = notification.roomId.hashCode;
+  if (event.type.startsWith('m.call') && event.type != EventTypes.CallInvite) {
+    Logs().v('Push message is a m.call but not invite. Do not display.');
+    return;
+  }
 
-    // Show notification
+  if ((event.type.startsWith('m.call') &&
+          event.type != EventTypes.CallInvite) ||
+      event.type == 'org.matrix.call.sdp_stream_metadata_changed') {
+    Logs().v('Push message was for a call, but not call invite.');
+    return;
+  }
 
-    final newMessage = Message(
+  l10n ??= await L10n.delegate.load(PlatformDispatcher.instance.locale);
-      body,
+  final matrixLocals = MatrixLocals(l10n);
-      event.originServerTs,
+
-      Person(
+  // Calculate the body
-        bot: event.messageType == MessageTypes.Notice,
+  final body = event.type == EventTypes.Encrypted
-        key: event.senderId,
+      ? l10n.newMessageInFluffyChat
-        name: event.senderFromMemoryOrFallback.calcDisplayname(),
+      : await event.calcLocalizedBody(
-        icon: senderAvatarFile == null
+          matrixLocals,
+          plaintextBody: true,
+          withSenderNamePrefix: false,
+          hideReply: true,
+          hideEdit: true,
+          removeMarkdown: true,
+        );
+
+  // The person object for the android message style notification
+  final avatar = event.room.avatar
+      ?.getThumbnail(
+        client,
+        width: 256,
+        height: 256,
+      )
+      .toString();
+  final senderAvatar = event.room.isDirectChat
+      ? avatar
+      : event.senderFromMemoryOrFallback.avatarUrl
+          ?.getThumbnail(
+            client,
+            width: 256,
+            height: 256,
+          )
+          .toString();
+
+  File? roomAvatarFile, senderAvatarFile;
+  try {
+    roomAvatarFile = avatar == null
+        ? null
+        : await DefaultCacheManager().getSingleFile(avatar);
+  } catch (e, s) {
+    Logs().e('Unable to get avatar picture', e, s);
+  }
+  try {
+    senderAvatarFile = event.room.isDirectChat
+        ? roomAvatarFile
+        : senderAvatar == null
             ? null
-            : BitmapFilePathAndroidIcon(senderAvatarFile.path),
+            : await DefaultCacheManager().getSingleFile(senderAvatar);
-      ),
+  } catch (e, s) {
-    );
+    Logs().e('Unable to get avatar picture', e, s);
-
+  }
-    final messagingStyleInformation = PlatformInfos.isAndroid
-        ? await AndroidFlutterLocalNotificationsPlugin()
-            .getActiveNotificationMessagingStyle(id)
-        : null;
-    messagingStyleInformation?.messages?.add(newMessage);
-
-    final roomName = event.room.getLocalizedDisplayname(MatrixLocals(l10n));
 
-    final notificationGroupId =
+  final id = notification.roomId.hashCode;
-        event.room.isDirectChat ? 'directChats' : 'groupChats';
-    final groupName = event.room.isDirectChat ? l10n.directChats : l10n.groups;
 
-    final messageRooms = AndroidNotificationChannelGroup(
+  // Show notification
-      notificationGroupId,
-      groupName,
-    );
-    final roomsChannel = AndroidNotificationChannel(
-      event.room.id,
-      roomName,
-      groupId: notificationGroupId,
-    );
 
-    await flutterLocalNotificationsPlugin
+  final newMessage = Message(
-        .resolvePlatformSpecificImplementation<
+    body,
-            AndroidFlutterLocalNotificationsPlugin>()
+    event.originServerTs,
-        ?.createNotificationChannelGroup(messageRooms);
+    Person(
-    await flutterLocalNotificationsPlugin
+      bot: event.messageType == MessageTypes.Notice,
-        .resolvePlatformSpecificImplementation<
+      key: event.senderId,
-            AndroidFlutterLocalNotificationsPlugin>()
+      name: event.senderFromMemoryOrFallback.calcDisplayname(),
-        ?.createNotificationChannel(roomsChannel);
+      icon: senderAvatarFile == null
-
+          ? null
-    final androidPlatformChannelSpecifics = AndroidNotificationDetails(
+          : BitmapFilePathAndroidIcon(senderAvatarFile.path),
-      AppConfig.pushNotificationsChannelId,
+    ),
-      l10n.incomingMessages,
+  );
-      number: notification.counts?.unread,
+
-      category: AndroidNotificationCategory.message,
+  final messagingStyleInformation = PlatformInfos.isAndroid
-      shortcutId: event.room.id,
+      ? await AndroidFlutterLocalNotificationsPlugin()
-      styleInformation: messagingStyleInformation ??
+          .getActiveNotificationMessagingStyle(id)
-          MessagingStyleInformation(
+      : null;
-            Person(
+  messagingStyleInformation?.messages?.add(newMessage);
-              name: event.senderFromMemoryOrFallback.calcDisplayname(),
+
-              icon: roomAvatarFile == null
+  final roomName = event.room.getLocalizedDisplayname(MatrixLocals(l10n));
-                  ? null
+
-                  : BitmapFilePathAndroidIcon(roomAvatarFile.path),
+  final notificationGroupId =
-              key: event.roomId,
+      event.room.isDirectChat ? 'directChats' : 'groupChats';
-              important: event.room.isFavourite,
+  final groupName = event.room.isDirectChat ? l10n.directChats : l10n.groups;
-            ),
+
-            conversationTitle: roomName,
+  final messageRooms = AndroidNotificationChannelGroup(
-            groupConversation: !event.room.isDirectChat,
+    notificationGroupId,
-            messages: [newMessage],
+    groupName,
+  );
+  final roomsChannel = AndroidNotificationChannel(
+    event.room.id,
+    roomName,
+    groupId: notificationGroupId,
+  );
+
+  await flutterLocalNotificationsPlugin
+      .resolvePlatformSpecificImplementation<
+          AndroidFlutterLocalNotificationsPlugin>()
+      ?.createNotificationChannelGroup(messageRooms);
+  await flutterLocalNotificationsPlugin
+      .resolvePlatformSpecificImplementation<
+          AndroidFlutterLocalNotificationsPlugin>()
+      ?.createNotificationChannel(roomsChannel);
+
+  final androidPlatformChannelSpecifics = AndroidNotificationDetails(
+    AppConfig.pushNotificationsChannelId,
+    l10n.incomingMessages,
+    number: notification.counts?.unread,
+    category: AndroidNotificationCategory.message,
+    shortcutId: event.room.id,
+    styleInformation: messagingStyleInformation ??
+        MessagingStyleInformation(
+          Person(
+            name: event.senderFromMemoryOrFallback.calcDisplayname(),
+            icon: roomAvatarFile == null
+                ? null
+                : BitmapFilePathAndroidIcon(roomAvatarFile.path),
+            key: event.roomId,
+            important: event.room.isFavourite,
           ),
-      ticker: event.calcLocalizedBodyFallback(
+          conversationTitle: roomName,
-        matrixLocals,
+          groupConversation: !event.room.isDirectChat,
-        plaintextBody: true,
+          messages: [newMessage],
-        withSenderNamePrefix: true,
+        ),
-        hideReply: true,
+    ticker: event.calcLocalizedBodyFallback(
-        hideEdit: true,
+      matrixLocals,
-        removeMarkdown: true,
+      plaintextBody: true,
-      ),
+      withSenderNamePrefix: true,
-      importance: Importance.high,
+      hideReply: true,
-      priority: Priority.max,
+      hideEdit: true,
-      groupKey: notificationGroupId,
+      removeMarkdown: true,
-    );
+    ),
-    const iOSPlatformChannelSpecifics = DarwinNotificationDetails();
+    importance: Importance.high,
-    final platformChannelSpecifics = NotificationDetails(
+    priority: Priority.max,
-      android: androidPlatformChannelSpecifics,
+    groupKey: notificationGroupId,
-      iOS: iOSPlatformChannelSpecifics,
+  );
-    );
+  const iOSPlatformChannelSpecifics = DarwinNotificationDetails();
-
+  final platformChannelSpecifics = NotificationDetails(
-    final title = event.room.getLocalizedDisplayname(MatrixLocals(l10n));
+    android: androidPlatformChannelSpecifics,
-
+    iOS: iOSPlatformChannelSpecifics,
-    if (PlatformInfos.isAndroid && messagingStyleInformation == null) {
+  );
-      await _setShortcut(event, l10n, title, roomAvatarFile);
+
-    }
+  final title = event.room.getLocalizedDisplayname(MatrixLocals(l10n));
-
+
-    await flutterLocalNotificationsPlugin.show(
+  if (PlatformInfos.isAndroid && messagingStyleInformation == null) {
-      id,
+    await _setShortcut(event, l10n, title, roomAvatarFile);
-      title,
-      body,
-      platformChannelSpecifics,
-      payload: event.roomId,
-    );
-    Logs().v('Push helper has been completed!');
   }
 
-  /// Creates a shortcut for Android platform but does not block displaying the
+  await flutterLocalNotificationsPlugin.show(
-  /// notification. This is optional but provides a nicer view of the
+    id,
-  /// notification popup.
+    title,
-  static Future<void> _setShortcut(
+    body,
-    Event event,
+    platformChannelSpecifics,
-    L10n l10n,
+    payload: event.roomId,
-    String title,
+  );
-    File? avatarFile,
+  Logs().v('Push helper has been completed!');
-  ) async {
+}
-    final flutterShortcuts = FlutterShortcuts();
+
-    await flutterShortcuts.initialize(debug: !kReleaseMode);
+/// Creates a shortcut for Android platform but does not block displaying the
-    await flutterShortcuts.pushShortcutItem(
+/// notification. This is optional but provides a nicer view of the
-      shortcut: ShortcutItem(
+/// notification popup.
-        id: event.room.id,
+Future<void> _setShortcut(
-        action: AppConfig.inviteLinkPrefix + event.room.id,
+  Event event,
-        shortLabel: title,
+  L10n l10n,
-        conversationShortcut: true,
+  String title,
-        icon: avatarFile == null
+  File? avatarFile,
-            ? null
+) async {
-            : ShortcutMemoryIcon(jpegImage: await avatarFile.readAsBytes())
+  final flutterShortcuts = FlutterShortcuts();
-                .toString(),
+  await flutterShortcuts.initialize(debug: !kReleaseMode);
-        shortcutIconAsset: avatarFile == null
+  await flutterShortcuts.pushShortcutItem(
-            ? ShortcutIconAsset.androidAsset
+    shortcut: ShortcutItem(
-            : ShortcutIconAsset.memoryAsset,
+      id: event.room.id,
-        isImportant: event.room.isFavourite,
+      action: AppConfig.inviteLinkPrefix + event.room.id,
-      ),
+      shortLabel: title,
-    );
+      conversationShortcut: true,
-  }
+      icon: avatarFile == null
+          ? null
+          : ShortcutMemoryIcon(jpegImage: await avatarFile.readAsBytes())
+              .toString(),
+      shortcutIconAsset: avatarFile == null
+          ? ShortcutIconAsset.androidAsset
+          : ShortcutIconAsset.memoryAsset,
+      isImportant: event.room.isFavourite,
+    ),
+  );
 }