action_sheet: Add "Mark as unread from here" button

Fixes: zulip#131

Author: Khader-1

assets/l10n/app_en.arb

@@ -51,6 +51,10 @@
   "@actionSheetOptionCopyMessageLink": {
     "description": "Label for copy message link button on action sheet."
   },
+  "actionSheetOptionMarkAsUnread": "Mark as unread from here",
+  "@actionSheetOptionMarkAsUnread":  {
+    "description": "Label for mark as unread button on action sheet."
+  },
   "actionSheetOptionShare": "Share",
   "@actionSheetOptionShare":  {
     "description": "Label for share button on action sheet."
@@ -436,6 +440,21 @@
   "@errorMarkAsReadFailedTitle": {
     "description": "Error title when mark as read action failed."
   },
+  "markAsUnreadComplete": "Marked {num, plural, =1{1 message} other{{num} messages}} as unread.",
+  "@markAsUnreadComplete": {
+    "description": "Message when marking messages as unread has completed.",
+    "placeholders": {
+      "num": {"type": "int", "example": "4"}
+    }
+  },
+  "markAsUnreadInProgress": "Marking messages as unread...",
+  "@markAsUnreadInProgress": {
+    "description": "Progress message when marking messages as unread."
+  },
+  "errorMarkAsUnreadFailedTitle": "Mark as unread failed",
+  "@errorMarkAsUnreadFailedTitle": {
+    "description": "Error title when mark as unread action failed."
+  },
   "today": "Today",
   "@today": {
     "description": "Term to use to reference the current day."

lib/widgets/action_sheet.dart

@@ -8,6 +8,7 @@ import '../api/model/model.dart';
 import '../api/route/messages.dart';
 import '../model/internal_link.dart';
 import '../model/narrow.dart';
+import 'actions.dart';
 import 'clipboard.dart';
 import 'compose_box.dart';
 import 'dialog.dart';
@@ -28,6 +29,10 @@ void showMessageActionSheet({required BuildContext context, required Message mes
   // any message list, so that's fine.
   final messageListPage = MessageListPage.ancestorOf(context);
   final isComposeBoxOffered = messageListPage.composeBoxController != null;
+  final narrow = messageListPage.narrow;
+  final isMessageRead = message.flags.contains(MessageFlag.read);
+  final markAsUnreadSupported = store.connection.zulipFeatureLevel! >= 155; // TODO(server-6)
+  final showMarkAsUnreadButton = markAsUnreadSupported && isMessageRead;
 
   final hasThumbsUpReactionVote = message.reactions
     ?.aggregated.any((reactionWithVotes) =>
@@ -46,6 +51,11 @@ void showMessageActionSheet({required BuildContext context, required Message mes
           message: message,
           messageListContext: context,
         ),
+        if (showMarkAsUnreadButton) MarkAsUnreadButton(
+          message: message,
+          messageListContext: context,
+          narrow: narrow,
+        ),
         CopyMessageTextButton(message: message, messageListContext: context),
         CopyMessageLinkButton(message: message, messageListContext: context),
         ShareButton(message: message, messageListContext: context),
@@ -278,6 +288,29 @@ class QuoteAndReplyButton extends MessageActionSheetMenuItemButton {
   }
 }
 
+class MarkAsUnreadButton extends MessageActionSheetMenuItemButton {
+  MarkAsUnreadButton({
+    super.key,
+    required super.message,
+    required super.messageListContext,
+    required this.narrow,
+  });
+
+  final Narrow narrow;
+
+  @override IconData get icon => Icons.mark_chat_unread_outlined;
+
+  @override
+  String label(ZulipLocalizations zulipLocalizations) {
+    return zulipLocalizations.actionSheetOptionMarkAsUnread;
+  }
+
+  @override void onPressed(BuildContext context) async {
+    Navigator.of(context).pop();
+    markNarrowAsUnreadFromMessage(messageListContext, message, narrow);
+  }
+}
+
 class CopyMessageTextButton extends MessageActionSheetMenuItemButton {
   CopyMessageTextButton({
     super.key,

lib/widgets/actions.dart

@@ -62,6 +62,26 @@ Future<void> markNarrowAsRead(BuildContext context, Narrow narrow) async {
   }
 }
 
+Future<void> markNarrowAsUnreadFromMessage(
+  BuildContext context,
+  Message message,
+  Narrow narrow,
+) async {
+  final connection = PerAccountStoreWidget.of(context).connection;
+  assert(connection.zulipFeatureLevel! >= 155); // TODO(server-6)
+  final zulipLocalizations = ZulipLocalizations.of(context);
+  await updateMessageFlagsStartingFromAnchor(
+    context: context,
+    apiNarrow: narrow.apiEncode(),
+    startingAnchor: NumericAnchor(message.id),
+    includeAnchor: true,
+    op: UpdateMessageFlagsOp.remove,
+    flag: MessageFlag.read,
+    onCompletedMessage: zulipLocalizations.markAsUnreadComplete,
+    progressMessage: zulipLocalizations.markAsUnreadInProgress,
+    onFailedTitle: zulipLocalizations.errorMarkAsUnreadFailedTitle);
+}
+
 /// Updates message flags by applying given operation `op` using given `flag`
 /// the update happens on given `apiNarrow` starting from given `startingAnchor`
 ///

test/widgets/action_sheet_test.dart

@@ -31,6 +31,8 @@ import 'compose_box_checks.dart';
 import 'dialog_checks.dart';
 import 'test_app.dart';
 
+late FakeApiConnection connection;
+
 /// Simulates loading a [MessageListPage] and long-pressing on [message].
 Future<void> setupToMessageActionSheet(WidgetTester tester, {
   required Message message,
@@ -46,7 +48,7 @@ Future<void> setupToMessageActionSheet(WidgetTester tester, {
     await store.addStream(stream);
     await store.addSubscription(eg.subscription(stream));
   }
-  final connection = store.connection as FakeApiConnection;
+  connection = store.connection as FakeApiConnection;
 
   // prepare message list data
   connection.prepare(json: GetMessagesResult(
@@ -385,6 +387,65 @@ void main() {
     });
   });
 
+  group('MarkAsUnread', () {
+    testWidgets('not visible if message is not read', (WidgetTester tester) async {
+      final unreadMessage = eg.streamMessage(flags: []);
+      await setupToMessageActionSheet(tester, message: unreadMessage, narrow: TopicNarrow.ofMessage(unreadMessage));
+
+      check(find.byIcon(Icons.mark_chat_unread_outlined).evaluate()).isEmpty();
+    });
+
+    testWidgets('visible if message is read', (WidgetTester tester) async {
+      final readMessage = eg.streamMessage(flags: [MessageFlag.read]);
+      await setupToMessageActionSheet(tester, message: readMessage, narrow: TopicNarrow.ofMessage(readMessage));
+
+      check(find.byIcon(Icons.mark_chat_unread_outlined).evaluate()).single;
+    });
+
+    group('onPressed', () {
+      testWidgets('smoke test', (WidgetTester tester) async {
+        final message = eg.streamMessage(flags: [MessageFlag.read]);
+        await setupToMessageActionSheet(tester, message: message, narrow: TopicNarrow.ofMessage(message));
+
+        connection.prepare(json: UpdateMessageFlagsForNarrowResult(
+          processedCount: 11, updatedCount: 3,
+          firstProcessedId: 1, lastProcessedId: 1980,
+          foundOldest: true, foundNewest: true).toJson());
+
+        await tester.ensureVisible(find.byIcon(Icons.mark_chat_unread_outlined, skipOffstage: false));
+        await tester.tap(find.byIcon(Icons.mark_chat_unread_outlined, skipOffstage: false));
+        await tester.pumpAndSettle();
+        check(connection.lastRequest).isA<http.Request>()
+          ..method.equals('POST')
+          ..url.path.equals('/api/v1/messages/flags/narrow')
+          ..bodyFields.deepEquals({
+              'anchor': '${message.id}',
+              'include_anchor': 'true',
+              'num_before': '0',
+              'num_after': '1000',
+              'narrow': jsonEncode(TopicNarrow.ofMessage(message).apiEncode()),
+              'op': 'remove',
+              'flag': 'read',
+            });
+      });
+
+      testWidgets('shows error when fails', (WidgetTester tester) async {
+        final message = eg.streamMessage(flags: [MessageFlag.read]);
+        await setupToMessageActionSheet(tester, message: message, narrow: TopicNarrow.ofMessage(message));
+
+        connection.prepare(exception: http.ClientException('Oops'));
+        final zulipLocalizations = GlobalLocalizations.zulipLocalizations;
+
+        await tester.ensureVisible(find.byIcon(Icons.mark_chat_unread_outlined, skipOffstage: false));
+        await tester.tap(find.byIcon(Icons.mark_chat_unread_outlined, skipOffstage: false));
+        await tester.pumpAndSettle();
+        checkErrorDialog(tester,
+          expectedTitle: zulipLocalizations.errorMarkAsUnreadFailedTitle,
+          expectedMessage: 'NetworkException: Oops (ClientException: Oops)');
+      });
+    });
+  });
+
   group('CopyMessageTextButton', () {
     setUp(() async {
       TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.setMockMethodCallHandler(