message test: Add some is-message-list-notified checks

With comments on additional notifyListeners calls we expect when we
start having the message list actually show the local echo in its
various states.

Author: chrisbobbe

test/model/message_test.dart

@@ -169,32 +169,40 @@ void main() {
       await prepareOutboxMessage(destination: DmDestination(
         userIds: [eg.selfUser.userId, eg.otherUser.userId]));
       checkState().equals(OutboxMessageState.hidden);
+      checkNotNotified();
 
       async.elapse(kLocalEchoDebounceDuration);
       checkState().equals(OutboxMessageState.waiting);
+      checkNotNotified(); // TODO once (it appears)
 
       await receiveMessage(eg.dmMessage(from: eg.selfUser, to: [eg.otherUser]));
       check(store.outboxMessages).isEmpty();
+      checkNotifiedOnce();
     }));
 
     test('smoke stream message: hidden -> waiting -> (delete)', () => awaitFakeAsync((async) async {
       await prepareOutboxMessage(destination: StreamDestination(
         stream.streamId, eg.t('foo')));
       checkState().equals(OutboxMessageState.hidden);
+      checkNotNotified();
 
       async.elapse(kLocalEchoDebounceDuration);
       checkState().equals(OutboxMessageState.waiting);
+      checkNotNotified(); // TODO once (it appears)
 
       await receiveMessage(eg.streamMessage(stream: stream, topic: 'foo'));
       check(store.outboxMessages).isEmpty();
+      checkNotifiedOnce();
     }));
 
     test('hidden -> waiting and never transition to waitPeriodExpired', () => awaitFakeAsync((async) async {
       await prepareOutboxMessage();
       checkState().equals(OutboxMessageState.hidden);
+      checkNotNotified();
 
       async.elapse(kLocalEchoDebounceDuration);
       checkState().equals(OutboxMessageState.waiting);
+      checkNotNotified(); // TODO once (it appears)
 
       // Wait till we reach at least [kSendMessageOfferRestoreWaitPeriod] after
       // the send request was initiated.
@@ -204,16 +212,19 @@ void main() {
       // The outbox message should stay in the waiting state;
       // it should not transition to waitPeriodExpired.
       checkState().equals(OutboxMessageState.waiting);
+      checkNotNotified();
     }));
 
     test('waiting -> waitPeriodExpired', () => awaitFakeAsync((async) async {
       await prepareOutboxMessageToFailAfterDelay(
         kSendMessageOfferRestoreWaitPeriod + Duration(seconds: 1));
       async.elapse(kLocalEchoDebounceDuration);
       checkState().equals(OutboxMessageState.waiting);
+      checkNotNotified(); // TODO once (it appears)
 
       async.elapse(kSendMessageOfferRestoreWaitPeriod - kLocalEchoDebounceDuration);
       checkState().equals(OutboxMessageState.waitPeriodExpired);
+      checkNotNotified(); // TODO once (it offers restore)
 
       await check(outboxMessageFailFuture).throws();
     }));
@@ -231,10 +242,12 @@ void main() {
         destination: streamDestination, content: 'content');
       async.elapse(kSendMessageOfferRestoreWaitPeriod);
       checkState().equals(OutboxMessageState.waitPeriodExpired);
+      checkNotNotified(); // TODO twice (it appears; it offers restore)
 
       // Wait till the [sendMessage] request succeeds.
       await future;
       checkState().equals(OutboxMessageState.waiting);
+      checkNotNotified(); // TODO once (it un-offers restore)
 
       // Wait till we reach at least [kSendMessageOfferRestoreWaitPeriod] after
       // returning to the waiting state.
@@ -243,15 +256,18 @@ void main() {
       // The outbox message should stay in the waiting state;
       // it should not transition to waitPeriodExpired.
       checkState().equals(OutboxMessageState.waiting);
+      checkNotNotified();
     }));
 
     group('… -> failed', () {
       test('hidden -> failed', () => awaitFakeAsync((async) async {
         await prepareOutboxMessageToFailAfterDelay(Duration.zero);
         checkState().equals(OutboxMessageState.hidden);
+        checkNotNotified();
 
         await check(outboxMessageFailFuture).throws();
         checkState().equals(OutboxMessageState.failed);
+        checkNotNotified(); // TODO once (it appears, offering restore)
 
         // Wait till we reach at least [kSendMessageOfferRestoreWaitPeriod] after
         // the send request was initiated.
@@ -260,62 +276,74 @@ void main() {
         // The outbox message should stay in the failed state;
         // it should not transition to waitPeriodExpired.
         checkState().equals(OutboxMessageState.failed);
+        checkNotNotified();
       }));
 
       test('waiting -> failed', () => awaitFakeAsync((async) async {
         await prepareOutboxMessageToFailAfterDelay(
           kLocalEchoDebounceDuration + Duration(seconds: 1));
         async.elapse(kLocalEchoDebounceDuration);
         checkState().equals(OutboxMessageState.waiting);
+        checkNotNotified(); // TODO once (it appears)
 
         await check(outboxMessageFailFuture).throws();
         checkState().equals(OutboxMessageState.failed);
+        checkNotNotified(); // TODO once (it offers restore)
       }));
 
       test('waitPeriodExpired -> failed', () => awaitFakeAsync((async) async {
         await prepareOutboxMessageToFailAfterDelay(
           kSendMessageOfferRestoreWaitPeriod + Duration(seconds: 1));
         async.elapse(kSendMessageOfferRestoreWaitPeriod);
         checkState().equals(OutboxMessageState.waitPeriodExpired);
+        checkNotNotified(); // TODO twice (it appears; it offers restore)
 
         await check(outboxMessageFailFuture).throws();
         checkState().equals(OutboxMessageState.failed);
+        checkNotNotified(); // TODO once (it shows failure text)
       }));
     });
 
     group('… -> (delete)', () {
       test('hidden -> (delete) because event received', () => awaitFakeAsync((async) async {
         await prepareOutboxMessage();
         checkState().equals(OutboxMessageState.hidden);
+        checkNotNotified();
 
         await receiveMessage();
         check(store.outboxMessages).isEmpty();
+        checkNotifiedOnce();
       }));
 
       test('hidden -> (delete) when event arrives before send request fails', () => awaitFakeAsync((async) async {
         // Set up an error to fail `sendMessage` with a delay, leaving time for
         // the message event to arrive.
         await prepareOutboxMessageToFailAfterDelay(const Duration(seconds: 1));
         checkState().equals(OutboxMessageState.hidden);
+        checkNotNotified();
 
         // Received the message event while the message is being sent.
         await receiveMessage();
         check(store.outboxMessages).isEmpty();
+        checkNotifiedOnce();
 
         // Complete the send request.  There should be no error despite
         // the send request failure, because the outbox message is not
         // in the store any more.
         await check(outboxMessageFailFuture).completes();
         async.elapse(const Duration(seconds: 1));
+        checkNotNotified();
       }));
 
       test('waiting -> (delete) because event received', () => awaitFakeAsync((async) async {
         await prepareOutboxMessage();
         async.elapse(kLocalEchoDebounceDuration);
         checkState().equals(OutboxMessageState.waiting);
+        checkNotNotified(); // TODO once (it appears)
 
         await receiveMessage();
         check(store.outboxMessages).isEmpty();
+        checkNotifiedOnce();
       }));
 
       test('waiting -> (delete) when event arrives before send request fails', () => awaitFakeAsync((async) async {
@@ -325,15 +353,18 @@ void main() {
           kLocalEchoDebounceDuration + Duration(seconds: 1));
         async.elapse(kLocalEchoDebounceDuration);
         checkState().equals(OutboxMessageState.waiting);
+        checkNotNotified(); // TODO once (it appears)
 
         // Received the message event while the message is being sent.
         await receiveMessage();
         check(store.outboxMessages).isEmpty();
+        checkNotifiedOnce();
 
         // Complete the send request.  There should be no error despite
         // the send request failure, because the outbox message is not
         // in the store any more.
         await check(outboxMessageFailFuture).completes();
+        checkNotNotified();
       }));
 
       test('waitPeriodExpired -> (delete) when event arrives before send request fails', () => awaitFakeAsync((async) async {
@@ -343,15 +374,18 @@ void main() {
           kSendMessageOfferRestoreWaitPeriod + Duration(seconds: 1));
         async.elapse(kSendMessageOfferRestoreWaitPeriod);
         checkState().equals(OutboxMessageState.waitPeriodExpired);
+        checkNotNotified(); // TODO twice (it appears; it offers restore)
 
         // Received the message event while the message is being sent.
         await receiveMessage();
         check(store.outboxMessages).isEmpty();
+        checkNotifiedOnce();
 
         // Complete the send request.  There should be no error despite
         // the send request failure, because the outbox message is not
         // in the store any more.
         await check(outboxMessageFailFuture).completes();
+        checkNotNotified();
       }));
 
       test('waitPeriodExpired -> (delete) because outbox message was taken', () => awaitFakeAsync((async) async {
@@ -361,27 +395,33 @@ void main() {
           kSendMessageOfferRestoreWaitPeriod + Duration(seconds: 1));
         async.elapse(kSendMessageOfferRestoreWaitPeriod);
         checkState().equals(OutboxMessageState.waitPeriodExpired);
+        checkNotNotified(); // TODO twice (it appears; it offers restore)
 
         store.takeOutboxMessage(store.outboxMessages.keys.single);
         check(store.outboxMessages).isEmpty();
+        checkNotNotified(); // TODO once (it disappears)
       }));
 
       test('failed -> (delete) because event received', () => awaitFakeAsync((async) async {
         await prepareOutboxMessageToFailAfterDelay(Duration.zero);
         await check(outboxMessageFailFuture).throws();
         checkState().equals(OutboxMessageState.failed);
+        checkNotNotified(); // TODO once (it appears, offering restore)
 
         await receiveMessage();
         check(store.outboxMessages).isEmpty();
+        checkNotifiedOnce();
       }));
 
       test('failed -> (delete) because outbox message was taken', () => awaitFakeAsync((async) async {
         await prepareOutboxMessageToFailAfterDelay(Duration.zero);
         await check(outboxMessageFailFuture).throws();
         checkState().equals(OutboxMessageState.failed);
+        checkNotNotified(); // TODO once (it appears, offering restore)
 
         store.takeOutboxMessage(store.outboxMessages.keys.single);
         check(store.outboxMessages).isEmpty();
+        checkNotNotified(); // TODO once (it disappears)
       }));
     });
 
@@ -423,11 +463,13 @@ void main() {
       await check(store.sendMessage(
         destination: StreamDestination(stream.streamId, eg.t('topic')),
         content: 'content')).throws();
+      checkNotNotified(); // TODO once (it appears, offering restore)
     }
 
     final localMessageIds = store.outboxMessages.keys.toList();
     store.takeOutboxMessage(localMessageIds.removeAt(5));
     check(store.outboxMessages).keys.deepEquals(localMessageIds);
+    checkNotNotified(); // TODO once (it disappears)
   });
 
   group('reconcileMessages', () {