compose: Add timeout to send message requests

Signed-off-by: Zixuan James Li <[email protected]>

Author: PIG208

assets/l10n/app_en.arb

@@ -169,6 +169,10 @@
   "@errorQuotationFailed": {
     "description": "Error message when quoting a message failed."
   },
+  "errorSendMessageTimeout": "Message isn’t sent. Check your connection.",
+  "@errorSendMessageTimeout": {
+    "description": "Error message when failed to send a message due to timeout."
+  },
   "errorServerMessage": "The server said:\n\n{message}",
   "@errorServerMessage": {
     "description": "Error message that quotes an error from the server.",

lib/generated/l10n/zulip_localizations.dart

@@ -325,6 +325,12 @@ abstract class ZulipLocalizations {
   /// **'Quotation failed'**
   String get errorQuotationFailed;
 
+  /// Error message when failed to send a message due to timeout.
+  ///
+  /// In en, this message translates to:
+  /// **'Message isn’t sent. Check your connection.'**
+  String get errorSendMessageTimeout;
+
   /// Error message that quotes an error from the server.
   ///
   /// In en, this message translates to:

lib/generated/l10n/zulip_localizations_ar.dart

@@ -144,6 +144,9 @@ class ZulipLocalizationsAr extends ZulipLocalizations {
   @override
   String get errorQuotationFailed => 'Quotation failed';
 
+  @override
+  String get errorSendMessageTimeout => 'Message isn’t sent. Check your connection.';
+
   @override
   String errorServerMessage(String message) {
     return 'The server said:\n\n$message';

lib/generated/l10n/zulip_localizations_en.dart

@@ -144,6 +144,9 @@ class ZulipLocalizationsEn extends ZulipLocalizations {
   @override
   String get errorQuotationFailed => 'Quotation failed';
 
+  @override
+  String get errorSendMessageTimeout => 'Message isn’t sent. Check your connection.';
+
   @override
   String errorServerMessage(String message) {
     return 'The server said:\n\n$message';

lib/generated/l10n/zulip_localizations_ja.dart

@@ -144,6 +144,9 @@ class ZulipLocalizationsJa extends ZulipLocalizations {
   @override
   String get errorQuotationFailed => 'Quotation failed';
 
+  @override
+  String get errorSendMessageTimeout => 'Message isn’t sent. Check your connection.';
+
   @override
   String errorServerMessage(String message) {
     return 'The server said:\n\n$message';

lib/widgets/compose_box.dart

@@ -1,3 +1,4 @@
+import 'dart:async';
 import 'dart:math';
 
 import 'package:app_settings/app_settings.dart';
@@ -22,6 +23,8 @@ import 'store.dart';
 import 'text.dart';
 import 'theme.dart';
 
+const Duration kSendMessageTimeout = Duration(seconds: 5);
+
 const double _composeButtonSize = 44;
 
 /// A [TextEditingController] for use in the compose box.
@@ -1046,15 +1049,21 @@ class _SendButtonState extends State<_SendButton> {
     widget.enabled.value = false;
 
     try {
-      await store.sendMessage(destination: widget.getDestination(), content: content);
+      await store
+        .sendMessage(destination: widget.getDestination(), content: content)
+        .timeout(kSendMessageTimeout);
       widget.contentController.clear();
-    } on ApiRequestException catch (e) {
+    } catch (e) {
       if (!mounted) return;
+
       final zulipLocalizations = ZulipLocalizations.of(context);
-      final message = switch (e) {
-        ZulipApiException() => zulipLocalizations.errorServerMessage(e.message),
-        _ => e.message,
-      };
+      String message;
+      switch (e) {
+        case ZulipApiException():   message = zulipLocalizations.errorServerMessage(e.message);
+        case ApiRequestException(): message = e.message;
+        case TimeoutException():    message = zulipLocalizations.errorSendMessageTimeout;
+        default: rethrow;
+      }
       showErrorDialog(context: context,
         title: zulipLocalizations.errorMessageNotSent,
         message: message);

test/widgets/compose_box_test.dart

@@ -476,6 +476,25 @@ void main() {
       check(composeBoxController.contentController.text).equals(oldText);
     });
 
+    testWidgets('fail after timeout', (tester) async {
+      const longDelay = Duration(hours: 1);
+      assert(longDelay > kSendMessageTimeout);
+      await setupAndTapSend(tester, prepareResponse: (_) {
+        connection.prepare(
+          httpStatus: 400,
+          json: {'result': 'error', 'code': 'BAD_REQUEST'},
+          delay: longDelay);
+      });
+
+      await tester.pump(kSendMessageTimeout);
+      final zulipLocalizations = GlobalLocalizations.zulipLocalizations;
+      await tester.tap(find.byWidget(checkErrorDialog(tester,
+        expectedTitle: zulipLocalizations.errorMessageNotSent,
+        expectedMessage: zulipLocalizations.errorSendMessageTimeout)));
+
+      await tester.pump(longDelay);
+    });
+
     testWidgets('ZulipApiException', (tester) async {
       await setupAndTapSend(tester, prepareResponse: (message) {
         connection.prepare(