action_sheet: Add "Mark as unread from here" button

Fixes: #131

Author: Khader-1

assets/l10n/app_en.arb

@@ -51,6 +51,10 @@
   "@actionSheetOptionCopyMessageLink": {
     "description": "Label for copy message link button on action sheet."
   },
+  "actionSheetMarkAsUnread": "Mark as unread from here",
+  "@actionSheetMarkAsUnread":  {
+    "description": "Label for mark as unread button on action sheet."
+  },
   "actionSheetOptionShare": "Share",
   "@actionSheetOptionShare":  {
     "description": "Label for share button on action sheet."
@@ -432,6 +436,10 @@
   "@errorMarkAsReadFailedTitle": {
     "description": "Error title when mark as read action failed."
   },
+  "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

@@ -36,6 +36,8 @@ void showMessageActionSheet({required BuildContext context, required Message mes
       && reactionWithVotes.userIds.contains(store.selfUserId))
     ?? false;
 
+  final isMessageRead = message.flags.contains(MessageFlag.read);
+
   showDraggableScrollableModalBottomSheet<void>(
     context: context,
     builder: (BuildContext _) {
@@ -49,6 +51,7 @@ void showMessageActionSheet({required BuildContext context, required Message mes
         CopyMessageTextButton(message: message, messageListContext: context),
         CopyMessageLinkButton(message: message, messageListContext: context),
         ShareButton(message: message, messageListContext: context),
+        if (isMessageRead) MarkAsUnreadButton(message: message, messageListContext: context),
       ]);
     });
 }
@@ -402,3 +405,70 @@ class ShareButton extends MessageActionSheetMenuItemButton {
     }
   }
 }
+
+class MarkAsUnreadButton extends MessageActionSheetMenuItemButton {
+  MarkAsUnreadButton({
+    super.key,
+    required super.message,
+    required super.messageListContext,
+  }) : narrow = MessageListPage.ancestorOf(messageListContext).narrow;
+
+  final Narrow narrow;
+
+  @override IconData get icon => Icons.mark_chat_unread_outlined;
+
+  @override
+  String label(ZulipLocalizations zulipLocalizations) {
+    return zulipLocalizations.actionSheetMarkAsUnread;
+  }
+
+  @override void onPressed(BuildContext context) async {
+    Navigator.of(context).pop();
+    final zulipLocalizations = ZulipLocalizations.of(messageListContext);
+
+    try {
+      final store = PerAccountStoreWidget.of(messageListContext);
+      final connection = store.connection;
+      Anchor anchor = NumericAnchor(message.id);
+      final apiNarrow = narrow.apiEncode();
+
+      while (true) {
+        final result = await updateMessageFlagsForNarrow(connection,
+          anchor: anchor,
+          includeAnchor: true,
+          numBefore: 0,
+          numAfter: 1000,
+          narrow: apiNarrow,
+          op: UpdateMessageFlagsOp.remove,
+          flag: MessageFlag.read);
+
+        if (!context.mounted) return;
+
+        if (result.foundNewest) return;
+
+        if (result.lastProcessedId == null) {
+          // No messages were in the range of the request.
+          // This should be impossible given that `foundNewest` was false
+          // (and that our `numAfter` was positive.)
+          await showErrorDialog(context: messageListContext,
+            title: zulipLocalizations.errorMarkAsUnreadFailedTitle,
+            message: zulipLocalizations.errorInvalidResponse);
+          return;
+        }
+        anchor = NumericAnchor(result.lastProcessedId!);
+      }
+    } catch (e) {
+      if (!messageListContext.mounted) return;
+
+      var errorMessage = zulipLocalizations.errorInvalidResponse;
+      switch (e) {
+        case ZulipApiException():
+          errorMessage = e.message;
+        default:
+      }
+
+      await showErrorDialog(context: messageListContext,
+        title: zulipLocalizations.errorMarkAsUnreadFailedTitle, message: errorMessage);
+    }
+  }
+}

test/widgets/action_sheet_test.dart

@@ -545,4 +545,78 @@ void main() {
       check(mockSharePlus.sharedString).isNull();
     });
   });
+
+  group('MarkAsUnread', () {
+    Future<void> tapButton(WidgetTester tester) async {
+      await tester.ensureVisible(find.byIcon(Icons.mark_chat_unread_outlined, skipOffstage: false));
+      await tester.tap(find.byIcon(Icons.mark_chat_unread_outlined));
+      await tester.pump(); // [MenuItemButton.onPressed] called in a post-frame callback: flutter/flutter@e4a39fa2e
+    }
+
+    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().length).equals(0);
+    });
+
+    testWidgets('visible if message is read', (WidgetTester tester) async {
+      final message = eg.streamMessage(flags: [MessageFlag.read]);
+      await setupToMessageActionSheet(tester, message: message, narrow: TopicNarrow.ofMessage(message));
+
+      check(find.byIcon(Icons.mark_chat_unread_outlined).evaluate().length).equals(1);
+    });
+
+    testWidgets('success', (WidgetTester tester) async {
+      final message = eg.streamMessage(flags: [MessageFlag.read]);
+      await setupToMessageActionSheet(tester, message: message, narrow: TopicNarrow.ofMessage(message));
+      final store = await testBinding.globalStore.perAccount(eg.selfAccount.id);
+
+      final connection = store.connection as FakeApiConnection;
+      connection.prepare(json: UpdateMessageFlagsForNarrowResult(
+        processedCount: 11,
+        updatedCount: 3,
+        firstProcessedId: null,
+        lastProcessedId: null,
+        foundOldest: false,
+        foundNewest: true).toJson());
+
+      await tapButton(tester);
+      await tester.pump(Duration.zero);
+
+      check(connection.lastRequest).isA<http.Request>()
+        ..method.equals('POST')
+        ..url.path.equals('/api/v1/messages/flags/narrow')
+        ..bodyFields.deepEquals({
+          'num_before': '0',
+          'num_after': '1000',
+          'op': 'remove',
+          'flag': 'read',
+          'include_anchor': 'true',
+          'anchor': '${message.id}',
+          'narrow': '[{"operator":"stream","operand":${message.streamId}},{"operator":"topic","operand":"${message.topic}"}]',
+        });
+    });
+
+    testWidgets('request has an error', (WidgetTester tester) async {
+      final message = eg.streamMessage(flags: [MessageFlag.read]);
+      await setupToMessageActionSheet(tester, message: message, narrow: TopicNarrow.ofMessage(message));
+      final store = await testBinding.globalStore.perAccount(eg.selfAccount.id);
+      final zulipLocalizations = GlobalLocalizations.zulipLocalizations;
+
+      final connection = store.connection as FakeApiConnection;
+
+      connection.prepare(httpStatus: 400, json: {
+        'code': 'BAD_REQUEST',
+        'msg': 'Invalid message(s)',
+        'result': 'error',
+      });
+      await tapButton(tester);
+      await tester.pump(Duration.zero); // error arrives; error dialog shows
+
+      await tester.tap(find.byWidget(checkErrorDialog(tester,
+        expectedTitle: zulipLocalizations.errorMarkAsUnreadFailedTitle,
+        expectedMessage: 'Invalid message(s)')));
+    });
+  });
 }