draft; Support outbox managed by MessageStore, w/ a flag

Author: PIG208

lib/model/message.dart

@@ -215,11 +215,27 @@ class MessageStoreImpl with MessageStore {
       destination, selfUserId: selfUserId, content: content);
     final localMessageId = outboxMessage.localMessageId;
     assert(!outboxMessages.containsKey(localMessageId));
-    // TODO debounce new outbox messages
     outboxMessages[localMessageId] = outboxMessage;
-    for (final view in _messageListViews) {
-      view.handleOutboxMessage(outboxMessage);
-    }
+
+    // The outbox message only become visible to views after
+    // [kLocalEchoDebounceDuration].
+    Future<void>.delayed(kLocalEchoDebounceDuration, () {
+      if (!outboxMessages.containsKey(outboxMessage.localMessageId)) {
+        // The outbox message was deleted, one such reason can be that the
+        // corresponding "message" event arrived quickly.
+        return;
+      }
+      if (!outboxMessage.hidden) {
+        // The outbox message was unhidden due to an error from the
+        // send-message request.
+        assert(outboxMessage.state == OutboxMessageLifecycle.failed);
+        return;
+      }
+      outboxMessage.unhide();
+      for (final view in _messageListViews) {
+        view.handleOutboxMessage(outboxMessage);
+      }
+    });
 
     try {
       await _apiSendMessage(connection,
@@ -231,6 +247,10 @@ class MessageStoreImpl with MessageStore {
       _updateOutboxMessage(
         localMessageId: localMessageId, newState: OutboxMessageLifecycle.sent);
     } on ApiRequestException {
+      outboxMessage.unhide();
+      for (final view in _messageListViews) {
+        view.handleOutboxMessage(outboxMessage);
+      }
       _updateOutboxMessage(
         localMessageId: localMessageId, newState: OutboxMessageLifecycle.failed);
       rethrow;

test/model/message_checks.dart

@@ -3,4 +3,5 @@ import 'package:zulip/model/message.dart';
 
 extension OutboxMessageChecks on Subject<OutboxMessage> {
   Subject<OutboxMessageLifecycle> get state => has((x) => x.state, 'state');
+  Subject<bool> get hidden => has((x) => x.hidden, 'hidden');
 }

test/model/message_test.dart

@@ -93,14 +93,18 @@ void main() {
         delay: Duration.zero);
       final future = store.sendMessage(destination: destination, content: 'content');
       final outboxMessage = store.outboxMessages.values.single;
-      check(outboxMessage).state.equals(OutboxMessageLifecycle.sending);
+      check(outboxMessage)
+        ..state.equals(OutboxMessageLifecycle.sending)
+        ..hidden.isTrue();
       checkNotNotified();
       check(connection.lastRequest).isA<http.Request>()
         ..bodyFields['queue_id'].equals(store.queueId)
         ..bodyFields['local_id'].equals('${outboxMessage.localMessageId}');
 
       await future;
-      check(outboxMessage).state.equals(OutboxMessageLifecycle.sent);
+      check(outboxMessage)
+        ..state.equals(OutboxMessageLifecycle.sent)
+        ..hidden.isTrue();
       checkNotifiedOnce();
 
       await store.handleEvent(eg.messageEvent(
@@ -116,11 +120,15 @@ void main() {
       connection.prepare(json: SendMessageResult(id: 1).toJson());
       await store.sendMessage(destination: destination, content: 'content');
       final outboxMessage = store.outboxMessages.values.single;
-      check(outboxMessage).state.equals(OutboxMessageLifecycle.sent);
+      check(outboxMessage)
+        ..state.equals(OutboxMessageLifecycle.sent)
+        ..hidden.isTrue();
       checkNotifiedOnce();
 
       async.elapse(kLocalEchoDebounceDuration);
-      check(outboxMessage).state.equals(OutboxMessageLifecycle.sent);
+      check(outboxMessage)
+        ..state.equals(OutboxMessageLifecycle.sent)
+        ..hidden.isFalse();
 
       await store.handleEvent(eg.messageEvent(
         eg.streamMessage(), localMessageId: outboxMessage.localMessageId));
@@ -136,11 +144,15 @@ void main() {
         delay: Duration.zero);
       final future = store.sendMessage(destination: destination, content: 'content');
       final outboxMessage = store.outboxMessages.values.single;
-      check(outboxMessage).state.equals(OutboxMessageLifecycle.sending);
+      check(outboxMessage)
+        ..state.equals(OutboxMessageLifecycle.sending)
+        ..hidden.isTrue();
       checkNotNotified();
 
       await check(future).throws();
-      check(outboxMessage).state.equals(OutboxMessageLifecycle.failed);
+      check(outboxMessage)
+        ..state.equals(OutboxMessageLifecycle.failed)
+        ..hidden.isFalse();
       checkNotifiedOnce();
     });
   });