store: Show error message when replacing event queue

Fixes: #555 Signed-off-by: Zixuan James Li <[email protected]>
zulip · Sep 12, 2024 · 9cd37ea · 9cd37ea
1 parent db9d9f1
commit 9cd37ea
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/assets/l10n/app_en.arb b/assets/l10n/app_en.arb
@@ -172,6 +172,11 @@
       "error": {"type": "String", "example": "Invalid format"}
     }
   },
+  "errorReconnectingToServer": "Reconnecting to {serverUrl}…",
+  "@errorReconnectingToServer": {
+    "serverUrl": {"type": "String", "example": "http://example.com/"},
+    "description": "Message when reconnecting to the server."
+  },
   "errorSharingFailed": "Sharing failed",
   "@errorSharingFailed": {
     "description": "Error message when sharing a message failed."

diff --git a/lib/model/store.dart b/lib/model/store.dart
@@ -794,6 +794,7 @@ class UpdateMachine {
         switch (e) {
           case ZulipApiException(code: 'BAD_EVENT_QUEUE_ID'):
             assert(debugLog('Lost event queue for $store.  Replacing…'));
+            reportErrorToUserBriefly(localizations.errorReconnectingToServer(serverUrl));
             await store._globalStore._reloadPerAccount(store.accountId);
             dispose();
             debugLog('… Event queue replaced.');

diff --git a/test/model/store_test.dart b/test/model/store_test.dart
@@ -407,6 +407,9 @@ void main() {
     }
 
     test('handles expired queue', () => awaitFakeAsync((async) async {
+      reportErrorToUserBriefly = logAndReportErrorToUserBriefly;
+      addTearDown(() => reportErrorToUserBriefly = defaultReportErrorToUserBriefly);
+
       await prepareStore();
       updateMachine.debugPauseLoop();
       updateMachine.poll();
@@ -420,7 +423,10 @@ void main() {
       });
       updateMachine.debugAdvanceLoop();
       async.flushMicrotasks();
+      check(lastReportedError).isNull();
       await Future<void>.delayed(Duration.zero);
+      check(takeLastReportedError()).isNotNull()
+        .contains('Reconnecting to ${eg.realmUrl.origin}…');
       check(store).isLoading.isTrue();
 
       // The global store has a new store.