msglist: Support retrieving failed outbox message content

PIG208 · PIG208 · commit f07af1f54198 · 2025-05-19T18:02:45.000-04:00
diff --git a/assets/l10n/app_en.arb b/assets/l10n/app_en.arb
@@ -864,6 +864,10 @@
   "@messageIsMovedLabel": {
     "description": "Label for a moved message. (Use ALL CAPS for cased alphabets: Latin, Greek, Cyrillic, etc.)"
   },
+  "messageIsntSentLabel": "MESSAGE ISN'T SENT. CHECK YOUR CONNECTION.",
+  "@messageIsntSentLabel": {
+    "description": "Label for a message that isn't sent. (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
@@ -1274,6 +1274,12 @@ abstract class ZulipLocalizations {
   /// **'MOVED'**
   String get messageIsMovedLabel;
 
+  /// Label for a message that isn't sent. (Use ALL CAPS for cased alphabets: Latin, Greek, Cyrillic, etc.)
+  ///
+  /// In en, this message translates to:
+  /// **'MESSAGE ISN\'T SENT. CHECK YOUR CONNECTION.'**
+  String get messageIsntSentLabel;
+
   /// 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
@@ -704,6 +704,10 @@ class ZulipLocalizationsAr extends ZulipLocalizations {
   @override
   String get messageIsMovedLabel => 'MOVED';
 
+  @override
+  String get messageIsntSentLabel =>
+      'MESSAGE ISN\'T SENT. CHECK YOUR CONNECTION.';
+
   @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
@@ -704,6 +704,10 @@ class ZulipLocalizationsEn extends ZulipLocalizations {
   @override
   String get messageIsMovedLabel => 'MOVED';
 
+  @override
+  String get messageIsntSentLabel =>
+      'MESSAGE ISN\'T SENT. CHECK YOUR CONNECTION.';
+
   @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
@@ -704,6 +704,10 @@ class ZulipLocalizationsJa extends ZulipLocalizations {
   @override
   String get messageIsMovedLabel => 'MOVED';
 
+  @override
+  String get messageIsntSentLabel =>
+      'MESSAGE ISN\'T SENT. CHECK YOUR CONNECTION.';
+
   @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
@@ -704,6 +704,10 @@ class ZulipLocalizationsNb extends ZulipLocalizations {
   @override
   String get messageIsMovedLabel => 'MOVED';
 
+  @override
+  String get messageIsntSentLabel =>
+      'MESSAGE ISN\'T SENT. CHECK YOUR CONNECTION.';
+
   @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
@@ -713,6 +713,10 @@ class ZulipLocalizationsPl extends ZulipLocalizations {
   @override
   String get messageIsMovedLabel => 'PRZENIESIONO';
 
+  @override
+  String get messageIsntSentLabel =>
+      'MESSAGE ISN\'T SENT. CHECK YOUR CONNECTION.';
+
   @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
@@ -717,6 +717,10 @@ class ZulipLocalizationsRu extends ZulipLocalizations {
   @override
   String get messageIsMovedLabel => 'ПЕРЕМЕЩЕНО';
 
+  @override
+  String get messageIsntSentLabel =>
+      'MESSAGE ISN\'T SENT. CHECK YOUR CONNECTION.';
+
   @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
@@ -706,6 +706,10 @@ class ZulipLocalizationsSk extends ZulipLocalizations {
   @override
   String get messageIsMovedLabel => 'PRESUNUTÉ';
 
+  @override
+  String get messageIsntSentLabel =>
+      'MESSAGE ISN\'T SENT. CHECK YOUR CONNECTION.';
+
   @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
@@ -716,6 +716,10 @@ class ZulipLocalizationsUk extends ZulipLocalizations {
   @override
   String get messageIsMovedLabel => 'ПЕРЕМІЩЕНО';
 
+  @override
+  String get messageIsntSentLabel =>
+      'MESSAGE ISN\'T SENT. CHECK YOUR CONNECTION.';
+
   @override
   String pollVoterNames(String voterNames) {
     return '($voterNames)';
diff --git a/lib/model/message.dart b/lib/model/message.dart
@@ -298,9 +298,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/message_list.dart b/lib/widgets/message_list.dart
@@ -5,6 +5,7 @@ import 'package:intl/intl.dart' hide TextDirection;
 
 import '../api/model/model.dart';
 import '../generated/l10n/zulip_localizations.dart';
+import '../model/message.dart';
 import '../model/message_list.dart';
 import '../model/narrow.dart';
 import '../model/store.dart';
@@ -1615,22 +1616,108 @@ class OutboxMessageWithPossibleSender extends StatelessWidget {
 
   final MessageListOutboxMessageItem item;
 
+  // TODO restore the topic too
+  void _handlePress(BuildContext context) {
+    final store = PerAccountStoreWidget.of(context);
+    assert(store.outboxMessages.containsKey(item.message.localMessageId));
+    final message = store.takeOutboxMessage(item.message.localMessageId);
+
+    final content = message.content.endsWith('\n')
+      ? message.content : '${message.content}\n';
+
+    final composeBoxController =
+      MessageListPage.ancestorOf(context).composeBoxState!.controller;
+    composeBoxController.content.insertPadded(content);
+    if (!composeBoxController.contentFocusNode.hasFocus) {
+      composeBoxController.contentFocusNode.requestFocus();
+    }
+  }
+
   @override
   Widget build(BuildContext context) {
-    final message = item.message;
-    return Padding(
-      padding: const EdgeInsets.symmetric(vertical: 4),
-      child: Column(children: [
-        if (item.showSender)
-          _SenderRow(message: message, showTimestamp: false),
-        Padding(
-          padding: const EdgeInsets.symmetric(horizontal: 16),
-          // This is adapated from [MessageContent].
-          // TODO(#576): Offer InheritedMessage ancestor once we are ready
-          //   to support local echoing images and lightbox.
-          child: DefaultTextStyle(
-            style: ContentTheme.of(context).textStylePlainParagraph,
-            child: BlockContentList(nodes: item.content.nodes))),
-      ]));
+    final GestureTapCallback? handleTap;
+    final double opacity;
+    switch (item.message.state) {
+      case OutboxMessageState.hidden:
+        assert(false,
+          'Hidden OutboxMessage messages should not appear in message lists');
+        handleTap = null;
+        opacity = 1.0;
+
+      case OutboxMessageState.waiting:
+        handleTap = null;
+        opacity = 1.0;
+
+      case OutboxMessageState.failed:
+      case OutboxMessageState.waitPeriodExpired:
+        final isComposeBoxOffered =
+          MessageListPage.ancestorOf(context).composeBoxState != null;
+        handleTap = isComposeBoxOffered ? () => _handlePress(context) : null;
+        opacity = 0.6;
+    }
+
+    return GestureDetector(
+      onTap: handleTap,
+      behavior: HitTestBehavior.opaque,
+      child: Padding(
+        padding: const EdgeInsets.only(top: 4),
+        child: Column(children: [
+          if (item.showSender)
+            _SenderRow(message: item.message, showTimestamp: false),
+          Padding(
+            padding: const EdgeInsets.symmetric(horizontal: 16),
+            child: Column(crossAxisAlignment: CrossAxisAlignment.stretch,
+              children: [
+                // This is adapated from [MessageContent].
+                // TODO(#576): Offer InheritedMessage ancestor once we are ready
+                //   to support local echoing images and lightbox.
+                Opacity(opacity: opacity, child: DefaultTextStyle(
+                  style: ContentTheme.of(context).textStylePlainParagraph,
+                  child: BlockContentList(nodes: item.content.nodes))),
+
+                _OutboxMessageStatusRow(outboxMessageState: item.message.state),
+              ])),
+        ])));
+  }
+}
+
+class _OutboxMessageStatusRow extends StatelessWidget {
+  const _OutboxMessageStatusRow({required this.outboxMessageState});
+
+  final OutboxMessageState outboxMessageState;
+
+  @override
+  Widget build(BuildContext context) {
+    switch (outboxMessageState) {
+      case OutboxMessageState.hidden:
+        assert(false,
+          'Hidden OutboxMessage messages should not appear in message lists');
+        return SizedBox.shrink();
+
+      case OutboxMessageState.waiting:
+        final designVariables = DesignVariables.of(context);
+        return Padding(
+          padding: const EdgeInsetsGeometry.only(top: 1.5, bottom: 0.5),
+          child: LinearProgressIndicator(
+            minHeight: 2,
+            color: designVariables.foreground.withFadedAlpha(0.5),
+            backgroundColor: designVariables.foreground.withFadedAlpha(0.2)));
+
+      case OutboxMessageState.failed:
+      case OutboxMessageState.waitPeriodExpired:
+        final designVariables = DesignVariables.of(context);
+        final zulipLocalizations = ZulipLocalizations.of(context);
+        return Padding(
+          padding: const EdgeInsets.only(bottom: 4),
+          child: Text(
+            zulipLocalizations.messageIsntSentLabel,
+            textAlign: TextAlign.end,
+            style: TextStyle(
+              color: designVariables.btnLabelAttLowIntDanger,
+              fontSize: 12,
+              height: 12 / 12,
+              letterSpacing: proportionalLetterSpacing(
+                context, 0.05, baseFontSize: 12))));
+    }
   }
 }
diff --git a/test/widgets/message_list_test.dart b/test/widgets/message_list_test.dart
