feat: new centralized chat banner controller

lib/pages/chat/chat.dart

@@ -33,10 +33,9 @@ import 'package:fluffychat/pangea/analytics_data/analytics_update_dispatcher.dar
 import 'package:fluffychat/pangea/analytics_data/analytics_updater_mixin.dart';
 import 'package:fluffychat/pangea/analytics_misc/construct_type_enum.dart';
 import 'package:fluffychat/pangea/analytics_misc/constructs_model.dart';
-import 'package:fluffychat/pangea/analytics_misc/level_up/level_up_banner.dart';
 import 'package:fluffychat/pangea/analytics_misc/message_analytics_feedback.dart';
 import 'package:fluffychat/pangea/bot/utils/bot_name.dart';
-import 'package:fluffychat/pangea/chat/utils/unlocked_morphs_snackbar.dart';
+import 'package:fluffychat/pangea/chat/chat_banner_controller.dart';
 import 'package:fluffychat/pangea/chat/widgets/event_too_large_dialog.dart';
 import 'package:fluffychat/pangea/choreographer/assistance_state_enum.dart';
 import 'package:fluffychat/pangea/choreographer/choreo_constants.dart';
@@ -201,6 +200,7 @@ class ChatController extends State<ChatPageWithRoom>
   StreamSubscription? _botAudioSubscription;
   final timelineUpdateNotifier = _TimelineUpdateNotifier();
   late final ActivityChatController activityController;
+  late final ChatBannerController _bannerController;
   final ValueNotifier<bool> scrollableNotifier = ValueNotifier(false);
   // Pangea#
   Room get room => sendingClient.getRoomById(roomId) ?? widget.room;
@@ -512,18 +512,41 @@ class ChatController extends State<ChatPageWithRoom>
 
   // #Pangea
   void _onLevelUp(LevelUpdate update) {
-    if (MatrixState.pangeaController.subscriptionController.isSubscribed !=
-        false) {
-      LevelUpUtil.showLevelUpDialog(update.newLevel, update.prevLevel, context);
-    }
+    final isSubscribed = pangeaController.subscriptionController.isSubscribed;
+    if (isSubscribed == false) return;
+
+    final overlayKey = "level_up_notification";
+    _bannerController.addBanner(
+      (Completer<void> completer) => OverlayUtil.showLevelUpBanner(
+        context,
+        update.newLevel,
+        update.prevLevel,
+        completer,
+        overlayKey,
+      ),
+      overlayKey: overlayKey,
+    );
   }
 
   void _onUnlockConstructs(Set<ConstructIdentifier> constructs) {
     if (constructs.isEmpty) return;
-    ConstructNotificationUtil.addUnlockedConstruct(
-      List.from(constructs),
-      context,
-    );
+    for (final construct in constructs) {
+      if (_bannerController.queueLength >= 3) {
+        // If there are already 3 or more banners in the queue, don't add more to prevent overwhelming the user
+        return;
+      }
+
+      final overlayKey = "${construct.string}_snackbar";
+      _bannerController.addBanner(
+        (Completer<void> completer) => OverlayUtil.showUnlockedConstructBanner(
+          context,
+          construct,
+          completer,
+          overlayKey,
+        ),
+        overlayKey: overlayKey,
+      );
+    }
   }
 
   void _onTokenUpdate(Set<ConstructIdentifier> constructs) {
@@ -574,8 +597,8 @@ class ChatController extends State<ChatPageWithRoom>
     choreographer = Choreographer(inputFocus);
     final updater = Matrix.of(context).analyticsDataService.updateDispatcher;
 
+    _bannerController = ChatBannerController();
     _levelSubscription = updater.levelUpdateStream.stream.listen(_onLevelUp);
-
     _constructsSubscription = updater.unlockedConstructsStream.stream.listen(
       _onUnlockConstructs,
     );
@@ -856,9 +879,10 @@ class ChatController extends State<ChatPageWithRoom>
     MatrixState.pAnyState.closeAllOverlays(force: true);
     stopMediaStream.close();
     _levelSubscription?.cancel();
-    _botAudioSubscription?.cancel();
     _constructsSubscription?.cancel();
+    _botAudioSubscription?.cancel();
     _tokensSubscription?.cancel();
+    _bannerController.dispose();
     _router.routeInformationProvider.removeListener(_onRouteChanged);
     scrollController.dispose();
     inputFocus.dispose();

lib/pangea/chat/chat_banner_controller.dart

@@ -0,0 +1,96 @@
+import 'dart:async';
+import 'dart:collection';
+
+import 'package:flutter/material.dart';
+
+import 'package:fluffychat/pangea/common/utils/error_handler.dart';
+import 'package:fluffychat/widgets/matrix.dart';
+
+typedef BannerExecutor = void Function(Completer<void> completer);
+
+class BannerQueueEntry {
+  final BannerExecutor show;
+  final String overlayKey;
+  final Duration timeout;
+
+  BannerQueueEntry({
+    required this.show,
+    required this.overlayKey,
+    this.timeout = const Duration(seconds: 10),
+  });
+}
+
+class ChatBannerController {
+  ChatBannerController();
+
+  Completer<void>? _currentBannerCompleter;
+  final Queue<BannerQueueEntry> _bannerQueue = Queue();
+
+  int get queueLength => _bannerQueue.length;
+
+  void dispose() {
+    // Complete the current banner completer to allow any showing banner to close
+    if (_currentBannerCompleter != null &&
+        !_currentBannerCompleter!.isCompleted) {
+      _currentBannerCompleter!.complete();
+    }
+
+    _currentBannerCompleter = null;
+    _bannerQueue.clear(); // Clear any pending banners in the queue
+  }
+
+  // The banner widget created by showBanner should call complete on the provided
+  // Completer when it is dismissed or if it fails to show to allow the next banner to show
+  void addBanner(
+    BannerExecutor showBanner, {
+    required String overlayKey,
+    Duration timeout = const Duration(seconds: 30),
+  }) {
+    if (_bannerQueue.any((b) => b.overlayKey == overlayKey)) return;
+
+    _bannerQueue.add(
+      BannerQueueEntry(
+        show: showBanner,
+        overlayKey: overlayKey,
+        timeout: timeout,
+      ),
+    );
+
+    if (_currentBannerCompleter == null) {
+      showNextBanner();
+    }
+  }
+
+  Future<void> showNextBanner() async {
+    if (_currentBannerCompleter != null || _bannerQueue.isEmpty) {
+      return; // A banner is currently showing or no banners to show
+    }
+
+    final completer = Completer<void>();
+    _currentBannerCompleter = completer;
+    final bannerQueueEntry = _bannerQueue.removeFirst();
+    final show = bannerQueueEntry.show;
+    final timeout = bannerQueueEntry.timeout;
+    final overlayKey = bannerQueueEntry.overlayKey;
+
+    try {
+      show(completer);
+
+      await completer.future.timeout(
+        timeout,
+        onTimeout: () {
+          debugPrint(
+            "Banner '$overlayKey' timed out after ${timeout.inSeconds}s",
+          );
+          MatrixState.pAnyState.closeOverlay(overlayKey);
+          if (!completer.isCompleted) completer.complete();
+        },
+      );
+    } catch (e, s) {
+      ErrorHandler.logError(e: e, s: s, data: {"overlayKey": overlayKey});
+    } finally {
+      _currentBannerCompleter = null;
+      showNextBanner(); // Show the next banner in the queue
+    }
+  }
+}