msglist: Support retrieving failed outbox message content

PIG208 · PIG208 · commit 1fa9f24c8706 · 2025-05-26T21:30:05.000-04:00
Different from the Figma design, the bottom padding below the progress bar is changed from 0.5px to 2px, as discussed here: #1453 (comment) Fixes: #1441
diff --git a/assets/l10n/app_en.arb b/assets/l10n/app_en.arb
@@ -377,6 +377,10 @@
   "@discardDraftForEditConfirmationDialogMessage": {
     "description": "Message for a confirmation dialog for discarding message text that was typed into the compose box, when editing a message."
   },
+  "discardDraftForMessageNotSentConfirmationDialogMessage": "When you restore a message not sent, the content that was previously in the compose box is discarded.",
+  "@discardDraftForMessageNotSentConfirmationDialogMessage": {
+    "description": "Message for a confirmation dialog when restoring a message not sent, for discarding message text that was typed into the compose box."
+  },
   "discardDraftConfirmationDialogConfirmButton": "Discard",
   "@discardDraftConfirmationDialogConfirmButton": {
     "description": "Label for the 'Discard' button on a confirmation dialog for discarding message text that was typed into the compose box."
@@ -864,6 +868,10 @@
   "@messageIsMovedLabel": {
     "description": "Label for a moved message. (Use ALL CAPS for cased alphabets: Latin, Greek, Cyrillic, etc.)"
   },
+  "messageNotSentLabel": "MESSAGE NOT SENT",
+  "@messageNotSentLabel": {
+    "description": "Text on a message in the message list saying that a send message request failed. (Use ALL CAPS for cased alphabets: Latin, Greek, Cyrillic, etc.)"
+  },
   "pollVoterNames": "({voterNames})",
   "@pollVoterNames": {
     "description": "The list of people who voted for a poll option, wrapped in parentheses.",
diff --git a/lib/generated/l10n/zulip_localizations.dart b/lib/generated/l10n/zulip_localizations.dart
@@ -631,6 +631,12 @@ abstract class ZulipLocalizations {
   /// **'When you edit a message, the content that was previously in the compose box is discarded.'**
   String get discardDraftForEditConfirmationDialogMessage;
 
+  /// Message for a confirmation dialog when restoring a message not sent, for discarding message text that was typed into the compose box.
+  ///
+  /// In en, this message translates to:
+  /// **'When you restore a message not sent, the content that was previously in the compose box is discarded.'**
+  String get discardDraftForMessageNotSentConfirmationDialogMessage;
+
   /// Label for the 'Discard' button on a confirmation dialog for discarding message text that was typed into the compose box.
   ///
   /// In en, this message translates to:
@@ -1277,6 +1283,12 @@ abstract class ZulipLocalizations {
   /// **'MOVED'**
   String get messageIsMovedLabel;
 
+  /// Text on a message in the message list saying that a send message request failed. (Use ALL CAPS for cased alphabets: Latin, Greek, Cyrillic, etc.)
+  ///
+  /// In en, this message translates to:
+  /// **'MESSAGE NOT SENT'**
+  String get messageNotSentLabel;
+
   /// The list of people who voted for a poll option, wrapped in parentheses.
   ///
   /// In en, this message translates to:
diff --git a/lib/generated/l10n/zulip_localizations_ar.dart b/lib/generated/l10n/zulip_localizations_ar.dart
@@ -318,6 +318,10 @@ class ZulipLocalizationsAr extends ZulipLocalizations {
   String get discardDraftForEditConfirmationDialogMessage =>
       'When you edit a message, the content that was previously in the compose box is discarded.';
 
+  @override
+  String get discardDraftForMessageNotSentConfirmationDialogMessage =>
+      'When you restore a message not sent, the content that was previously in the compose box is discarded.';
+
   @override
   String get discardDraftConfirmationDialogConfirmButton => 'Discard';
 
@@ -704,6 +708,9 @@ class ZulipLocalizationsAr extends ZulipLocalizations {
   @override
   String get messageIsMovedLabel => 'MOVED';
 
+  @override
+  String get messageNotSentLabel => 'MESSAGE NOT SENT';
+
   @override
   String pollVoterNames(String voterNames) {
     return '($voterNames)';
diff --git a/lib/generated/l10n/zulip_localizations_de.dart b/lib/generated/l10n/zulip_localizations_de.dart
@@ -318,6 +318,10 @@ class ZulipLocalizationsDe extends ZulipLocalizations {
   String get discardDraftForEditConfirmationDialogMessage =>
       'When you edit a message, the content that was previously in the compose box is discarded.';
 
+  @override
+  String get discardDraftForMessageNotSentConfirmationDialogMessage =>
+      'When you restore a message not sent, the content that was previously in the compose box is discarded.';
+
   @override
   String get discardDraftConfirmationDialogConfirmButton => 'Discard';
 
@@ -704,6 +708,9 @@ class ZulipLocalizationsDe extends ZulipLocalizations {
   @override
   String get messageIsMovedLabel => 'MOVED';
 
+  @override
+  String get messageNotSentLabel => 'MESSAGE NOT SENT';
+
   @override
   String pollVoterNames(String voterNames) {
     return '($voterNames)';
diff --git a/lib/generated/l10n/zulip_localizations_en.dart b/lib/generated/l10n/zulip_localizations_en.dart
@@ -318,6 +318,10 @@ class ZulipLocalizationsEn extends ZulipLocalizations {
   String get discardDraftForEditConfirmationDialogMessage =>
       'When you edit a message, the content that was previously in the compose box is discarded.';
 
+  @override
+  String get discardDraftForMessageNotSentConfirmationDialogMessage =>
+      'When you restore a message not sent, the content that was previously in the compose box is discarded.';
+
   @override
   String get discardDraftConfirmationDialogConfirmButton => 'Discard';
 
@@ -704,6 +708,9 @@ class ZulipLocalizationsEn extends ZulipLocalizations {
   @override
   String get messageIsMovedLabel => 'MOVED';
 
+  @override
+  String get messageNotSentLabel => 'MESSAGE NOT SENT';
+
   @override
   String pollVoterNames(String voterNames) {
     return '($voterNames)';
diff --git a/lib/generated/l10n/zulip_localizations_ja.dart b/lib/generated/l10n/zulip_localizations_ja.dart
@@ -318,6 +318,10 @@ class ZulipLocalizationsJa extends ZulipLocalizations {
   String get discardDraftForEditConfirmationDialogMessage =>
       'When you edit a message, the content that was previously in the compose box is discarded.';
 
+  @override
+  String get discardDraftForMessageNotSentConfirmationDialogMessage =>
+      'When you restore a message not sent, the content that was previously in the compose box is discarded.';
+
   @override
   String get discardDraftConfirmationDialogConfirmButton => 'Discard';
 
@@ -704,6 +708,9 @@ class ZulipLocalizationsJa extends ZulipLocalizations {
   @override
   String get messageIsMovedLabel => 'MOVED';
 
+  @override
+  String get messageNotSentLabel => 'MESSAGE NOT SENT';
+
   @override
   String pollVoterNames(String voterNames) {
     return '($voterNames)';
diff --git a/lib/generated/l10n/zulip_localizations_nb.dart b/lib/generated/l10n/zulip_localizations_nb.dart
@@ -318,6 +318,10 @@ class ZulipLocalizationsNb extends ZulipLocalizations {
   String get discardDraftForEditConfirmationDialogMessage =>
       'When you edit a message, the content that was previously in the compose box is discarded.';
 
+  @override
+  String get discardDraftForMessageNotSentConfirmationDialogMessage =>
+      'When you restore a message not sent, the content that was previously in the compose box is discarded.';
+
   @override
   String get discardDraftConfirmationDialogConfirmButton => 'Discard';
 
@@ -704,6 +708,9 @@ class ZulipLocalizationsNb extends ZulipLocalizations {
   @override
   String get messageIsMovedLabel => 'MOVED';
 
+  @override
+  String get messageNotSentLabel => 'MESSAGE NOT SENT';
+
   @override
   String pollVoterNames(String voterNames) {
     return '($voterNames)';
diff --git a/lib/generated/l10n/zulip_localizations_pl.dart b/lib/generated/l10n/zulip_localizations_pl.dart
@@ -325,6 +325,10 @@ class ZulipLocalizationsPl extends ZulipLocalizations {
   String get discardDraftForEditConfirmationDialogMessage =>
       'Miej na uwadze, że przechodząc do zmiany wiadomości wyczyścisz okno nowej wiadomości.';
 
+  @override
+  String get discardDraftForMessageNotSentConfirmationDialogMessage =>
+      'When you restore a message not sent, the content that was previously in the compose box is discarded.';
+
   @override
   String get discardDraftConfirmationDialogConfirmButton => 'Odrzuć';
 
@@ -713,6 +717,9 @@ class ZulipLocalizationsPl extends ZulipLocalizations {
   @override
   String get messageIsMovedLabel => 'PRZENIESIONO';
 
+  @override
+  String get messageNotSentLabel => 'MESSAGE NOT SENT';
+
   @override
   String pollVoterNames(String voterNames) {
     return '($voterNames)';
diff --git a/lib/generated/l10n/zulip_localizations_ru.dart b/lib/generated/l10n/zulip_localizations_ru.dart
@@ -326,6 +326,10 @@ class ZulipLocalizationsRu extends ZulipLocalizations {
   String get discardDraftForEditConfirmationDialogMessage =>
       'When you edit a message, the content that was previously in the compose box is discarded.';
 
+  @override
+  String get discardDraftForMessageNotSentConfirmationDialogMessage =>
+      'When you restore a message not sent, the content that was previously in the compose box is discarded.';
+
   @override
   String get discardDraftConfirmationDialogConfirmButton => 'Discard';
 
@@ -717,6 +721,9 @@ class ZulipLocalizationsRu extends ZulipLocalizations {
   @override
   String get messageIsMovedLabel => 'ПЕРЕМЕЩЕНО';
 
+  @override
+  String get messageNotSentLabel => 'MESSAGE NOT SENT';
+
   @override
   String pollVoterNames(String voterNames) {
     return '($voterNames)';
diff --git a/lib/generated/l10n/zulip_localizations_sk.dart b/lib/generated/l10n/zulip_localizations_sk.dart
@@ -318,6 +318,10 @@ class ZulipLocalizationsSk extends ZulipLocalizations {
   String get discardDraftForEditConfirmationDialogMessage =>
       'When you edit a message, the content that was previously in the compose box is discarded.';
 
+  @override
+  String get discardDraftForMessageNotSentConfirmationDialogMessage =>
+      'When you restore a message not sent, the content that was previously in the compose box is discarded.';
+
   @override
   String get discardDraftConfirmationDialogConfirmButton => 'Discard';
 
@@ -706,6 +710,9 @@ class ZulipLocalizationsSk extends ZulipLocalizations {
   @override
   String get messageIsMovedLabel => 'PRESUNUTÉ';
 
+  @override
+  String get messageNotSentLabel => 'MESSAGE NOT SENT';
+
   @override
   String pollVoterNames(String voterNames) {
     return '($voterNames)';
diff --git a/lib/generated/l10n/zulip_localizations_uk.dart b/lib/generated/l10n/zulip_localizations_uk.dart
@@ -327,6 +327,10 @@ class ZulipLocalizationsUk extends ZulipLocalizations {
   String get discardDraftForEditConfirmationDialogMessage =>
       'When you edit a message, the content that was previously in the compose box is discarded.';
 
+  @override
+  String get discardDraftForMessageNotSentConfirmationDialogMessage =>
+      'When you restore a message not sent, the content that was previously in the compose box is discarded.';
+
   @override
   String get discardDraftConfirmationDialogConfirmButton => 'Discard';
 
@@ -716,6 +720,9 @@ class ZulipLocalizationsUk extends ZulipLocalizations {
   @override
   String get messageIsMovedLabel => 'ПЕРЕМІЩЕНО';
 
+  @override
+  String get messageNotSentLabel => 'MESSAGE NOT SENT';
+
   @override
   String pollVoterNames(String voterNames) {
     return '($voterNames)';
diff --git a/lib/model/message.dart b/lib/model/message.dart
@@ -881,9 +881,8 @@ mixin _OutboxMessageStore on PerAccountStoreBase {
   void _handleMessageEventOutbox(MessageEvent event) {
     if (event.localMessageId != null) {
       final localMessageId = int.parse(event.localMessageId!, radix: 10);
-      // The outbox message can be missing if the user removes it (to be
-      // implemented in #1441) before the event arrives.
-      // Nothing to do in that case.
+      // The outbox message can be missing if the user removes it before the
+      // event arrives.  Nothing to do in that case.
       _outboxMessages.remove(localMessageId);
       _outboxMessageDebounceTimers.remove(localMessageId)?.cancel();
       _outboxMessageWaitPeriodTimers.remove(localMessageId)?.cancel();
diff --git a/lib/widgets/compose_box.dart b/lib/widgets/compose_box.dart
@@ -13,6 +13,7 @@ import '../api/route/messages.dart';
 import '../generated/l10n/zulip_localizations.dart';
 import '../model/binding.dart';
 import '../model/compose.dart';
+import '../model/message.dart';
 import '../model/narrow.dart';
 import '../model/store.dart';
 import 'actions.dart';
@@ -1288,15 +1289,8 @@ class _SendButtonState extends State<_SendButton> {
     final content = controller.content.textNormalized;
 
     controller.content.clear();
-    // The following `stoppedComposing` call is currently redundant,
-    // because clearing input sends a "typing stopped" notice.
-    // It will be necessary once we resolve #720.
-    store.typingNotifier.stoppedComposing();
 
     try {
-      // TODO(#720) clear content input only on success response;
-      //   while waiting, put input(s) and send button into a disabled
-      //   "working on it" state (letting input text be selected for copying).
       await store.sendMessage(destination: widget.getDestination(), content: content);
     } on ApiRequestException catch (e) {
       if (!mounted) return;
@@ -1388,7 +1382,6 @@ class _ComposeBoxContainer extends StatelessWidget {
         border: Border(top: BorderSide(color: designVariables.borderBar)),
         boxShadow: ComposeBoxTheme.of(context).boxShadow,
       ),
-      // TODO(#720) try a Stack for the overlaid linear progress indicator
       child: Material(
         color: designVariables.composeBoxBg,
         child: Column(
@@ -1724,10 +1717,6 @@ class _ErrorBanner extends _Banner {
 
   @override
   Widget? buildTrailing(context) {
-    // TODO(#720) "x" button goes here.
-    //   24px square with 8px touchable padding in all directions?
-    //   and `bool get padEnd => false`; see Figma:
-    //     https://www.figma.com/design/1JTNtYo9memgW7vV6d0ygq/Zulip-Mobile?node-id=4031-17029&m=dev
     return null;
   }
 }
@@ -1826,6 +1815,15 @@ class ComposeBox extends StatefulWidget {
 abstract class ComposeBoxState extends State<ComposeBox> {
   ComposeBoxController get controller;
 
+  /// Restore a [OutboxMessage] for a failed [sendMessage] request.
+  ///
+  /// [localMessageId], as in [OutboxMessage.localMessageId], must be present
+  /// in the message store.
+  ///
+  /// If there is already text in the compose box, gives a confirmation dialog
+  /// to confirm that it is OK to discard that text.
+  void restoreMessageNotSent(int localMessageId);
+
   /// Switch the compose box to editing mode.
   ///
   /// If there is already text in the compose box, gives a confirmation dialog
@@ -1848,9 +1846,33 @@ class _ComposeBoxState extends State<ComposeBox> with PerAccountStoreAwareStateM
   ComposeBoxController? _controller;
 
   @override
-  void startEditInteraction(int messageId) async {
+  void restoreMessageNotSent(int localMessageId) async {
+    if (controller is EditMessageComposeBoxController) return;
     final zulipLocalizations = ZulipLocalizations.of(context);
+    if (await _abortBecauseContentInputNotEmpty(
+          message: zulipLocalizations.discardDraftForMessageNotSentConfirmationDialogMessage)) {
+      return;
+    }
+    if (!mounted) return;
 
+    final store = PerAccountStoreWidget.of(context);
+    final outboxMessage = store.takeOutboxMessage(localMessageId);
+    setState(() {
+      _setNewController(store);
+      final controller = this.controller;
+      controller
+        ..content.value = TextEditingValue(text: outboxMessage.contentMarkdown)
+        ..contentFocusNode.requestFocus();
+      if (controller is StreamComposeBoxController) {
+        controller.topic.setTopic((
+          outboxMessage.conversation as StreamConversation).topic);
+      }
+    });
+  }
+
+  @override
+  void startEditInteraction(int messageId) async {
+    final zulipLocalizations = ZulipLocalizations.of(context);
     if (await _abortBecauseContentInputNotEmpty(
           message: zulipLocalizations.discardDraftForEditConfirmationDialogMessage)) {
       return;
@@ -2067,11 +2089,6 @@ class _ComposeBoxState extends State<ComposeBox> with PerAccountStoreAwareStateM
       }
     }
 
-    // TODO(#720) dismissable message-send error, maybe something like:
-    //     if (controller.sendMessageError.value != null) {
-    //       errorBanner = _ErrorBanner(label:
-    //         ZulipLocalizations.of(context).errorSendMessageTimeout);
-    //     }
     return ComposeBoxInheritedWidget.fromComposeBoxState(this,
       child: _ComposeBoxContainer(body: body, banner: banner));
   }
diff --git a/lib/widgets/message_list.dart b/lib/widgets/message_list.dart
diff --git a/test/widgets/compose_box_checks.dart b/test/widgets/compose_box_checks.dart
diff --git a/test/widgets/compose_box_test.dart b/test/widgets/compose_box_test.dart
diff --git a/test/widgets/message_list_test.dart b/test/widgets/message_list_test.dart
