subscription_list: Show a dot for unreads if channel is muted

Fixes: zulip#712

Author: Khader-1

lib/model/unreads.dart

@@ -206,6 +206,19 @@ class Unreads extends ChangeNotifier {
     }
   }
 
+  /// Checks if stream contains strictly muted unreads,
+  /// using [StreamStore.isTopicVisible].
+  bool hasMutedInStream(int streamId) {
+    final topics = streams[streamId];
+    if (topics == null) return false;
+    for (final entry in topics.entries) {
+      if (!streamStore.isTopicVisible(streamId, entry.key)) {
+        if (entry.value.isNotEmpty) return true;
+      }
+    }
+    return false;
+  }
+
   void handleMessageEvent(MessageEvent event) {
     final message = event.message;
     if (message.flags.contains(MessageFlag.read)) {

lib/widgets/subscription_list.dart

@@ -188,8 +188,13 @@ class _SubscriptionList extends StatelessWidget {
       itemBuilder: (BuildContext context, int index) {
         final subscription = subscriptions[index];
         final unreadCount = unreadsModel!.countInStream(subscription.streamId);
-        // TODO(#712): if stream muted, show a dot for unreads
-        return SubscriptionItem(subscription: subscription, unreadCount: unreadCount);
+        final hasUnmutedUnreads = unreadCount > 0;
+        // There is no need to check for muted unreads if there unmuted ones
+        final hasMutedUnreads = !hasUnmutedUnreads && unreadsModel!.hasMutedInStream(subscription.streamId);
+        return SubscriptionItem(subscription: subscription,
+          unreadCount: unreadCount,
+          hasMutedUnreads: hasMutedUnreads,
+          hasUnmutedUnreads: hasUnmutedUnreads);
     });
   }
 }
@@ -200,15 +205,18 @@ class SubscriptionItem extends StatelessWidget {
     super.key,
     required this.subscription,
     required this.unreadCount,
+    required this.hasMutedUnreads,
+    required this.hasUnmutedUnreads,
   });
 
   final Subscription subscription;
   final int unreadCount;
+  final bool hasMutedUnreads;
+  final bool hasUnmutedUnreads;
 
   @override
   Widget build(BuildContext context) {
     final swatch = colorSwatchFor(context, subscription);
-    final hasUnreads = (unreadCount > 0);
     final opacity = subscription.isMuted ? 0.55 : 1.0;
     return Material(
       // TODO(#95) need dark-theme color
@@ -243,11 +251,11 @@ class SubscriptionItem extends StatelessWidget {
                     // TODO(#95) need dark-theme color
                     color: Color(0xFF262626),
                   ).merge(weightVariableTextStyle(context,
-                      wght: hasUnreads ? 600 : null)),
+                      wght: hasUnmutedUnreads ? 600 : null)),
                   maxLines: 1,
                   overflow: TextOverflow.ellipsis,
                   subscription.name)))),
-          if (unreadCount > 0) ...[
+          if (hasUnmutedUnreads) ...[
             const SizedBox(width: 12),
             // TODO(#747) show @-mention indicator when it applies
             Opacity(
@@ -256,6 +264,9 @@ class SubscriptionItem extends StatelessWidget {
                 count: unreadCount,
                 backgroundColor: swatch,
                 bold: true)),
+          ] else if (hasMutedUnreads) ...[
+            const SizedBox(width: 12),
+            const MutedUnreadBadge(),
           ],
           const SizedBox(width: 16),
         ])));

lib/widgets/unread_count_badge.dart

@@ -1,5 +1,6 @@
 
 import 'package:flutter/material.dart';
+import 'package:flutter_color_models/flutter_color_models.dart';
 
 import 'stream_colors.dart';
 import 'text.dart';
@@ -65,3 +66,22 @@ class UnreadCountBadge extends StatelessWidget {
           count.toString())));
   }
 }
+
+class MutedUnreadBadge extends StatelessWidget {
+  const MutedUnreadBadge({
+    super.key,
+  });
+
+  @override
+  Widget build(BuildContext context) {
+    return Opacity(
+      opacity: 0.5,
+      child: Container(
+        width: 8,
+        height: 8,
+        margin: const EdgeInsetsDirectional.only(end: 3),
+        decoration: const BoxDecoration(
+          color: HslColor(0, 0, 80),
+          shape: BoxShape.circle)));
+  }
+}

test/model/unreads_test.dart

@@ -217,6 +217,31 @@ void main() {
     });
   });
 
+  group('muted helpers', () {
+    test('hasMutedInStream', () async {
+      final stream = eg.stream();
+      prepare();
+      await streamStore.addStream(stream);
+      await streamStore.addSubscription(eg.subscription(stream));
+      await streamStore.addUserTopic(stream, 'a', UserTopicVisibilityPolicy.unmuted);
+      await streamStore.addUserTopic(stream, 'c', UserTopicVisibilityPolicy.unmuted);
+      fillWithMessages([
+        eg.streamMessage(stream: stream, topic: 'a', flags: []),
+        eg.streamMessage(stream: stream, topic: 'a', flags: []),
+        eg.streamMessage(stream: stream, topic: 'b', flags: []),
+        eg.streamMessage(stream: stream, topic: 'b', flags: []),
+        eg.streamMessage(stream: stream, topic: 'b', flags: []),
+        eg.streamMessage(stream: stream, topic: 'c', flags: []),
+      ]);
+      check(model.hasMutedInStream(stream.streamId)).equals(false);
+
+      await streamStore.handleEvent(SubscriptionUpdateEvent(id: 1,
+        streamId: stream.streamId,
+        property: SubscriptionProperty.isMuted, value: true));
+      check(model.hasMutedInStream(stream.streamId)).equals(true);
+    });
+  });
+
   group('handleMessageEvent', () {
     for (final (isUnread, isStream, isDirectMentioned, isWildcardMentioned) in [
       (true,  true,  true,  true ),

test/widgets/subscription_list_test.dart

@@ -186,6 +186,37 @@ void main() {
     check(find.byType(UnreadCountBadge).evaluate()).length.equals(0);
   });
 
+  testWidgets('muted unread badge shows with muted unreads', (tester) async {
+    final stream = eg.stream();
+    final unreadMsgs = eg.unreadMsgs(streams: [
+      UnreadStreamSnapshot(streamId: stream.streamId, topic: 'a', unreadMessageIds: [1, 2]),
+      UnreadStreamSnapshot(streamId: stream.streamId, topic: 'b', unreadMessageIds: [3]),
+    ]);
+    await setupStreamListPage(tester,
+      subscriptions: [eg.subscription(stream, isMuted: true)],
+      userTopics: [eg.userTopicItem(stream, 'b', UserTopicVisibilityPolicy.muted)],
+      unreadMsgs: unreadMsgs);
+    final finder = find.byWidgetPredicate((widget) => widget is MutedUnreadBadge);
+    check(finder.evaluate().length).equals(1);
+  });
+
+  testWidgets('muted unread badge does not show with any unmuted unreads', (tester) async {
+    final stream = eg.stream();
+    final unreadMsgs = eg.unreadMsgs(streams: [
+      UnreadStreamSnapshot(streamId: stream.streamId, topic: 'a', unreadMessageIds: [1, 2]),
+      UnreadStreamSnapshot(streamId: stream.streamId, topic: 'b', unreadMessageIds: [3]),
+    ]);
+    await setupStreamListPage(tester,
+      subscriptions: [eg.subscription(stream, isMuted: true)],
+      userTopics: [
+        eg.userTopicItem(stream, 'b', UserTopicVisibilityPolicy.muted),
+        eg.userTopicItem(stream, 'a', UserTopicVisibilityPolicy.unmuted),
+      ],
+      unreadMsgs: unreadMsgs);
+    final finder = find.byWidgetPredicate((widget) => widget is MutedUnreadBadge);
+    check(finder.evaluate().length).equals(0);
+  });
+
   testWidgets('color propagates to icon and badge', (tester) async {
     final stream = eg.stream();
     final unreadMsgs = eg.unreadMsgs(streams: [