store test: Expose TestGlobalStore.useCachedApiConnections; default false

Author: chrisbobbe

test/model/store_test.dart

@@ -247,6 +247,8 @@ void main() {
     test('smoke', () => awaitFakeAsync((async) async {
       await prepareStore();
       final users = [eg.selfUser, eg.otherUser];
+
+      globalStore.useCachedApiConnections = true;
       connection.prepare(json: eg.initialSnapshot(realmUsers: users).toJson());
       final updateMachine = await UpdateMachine.load(
         globalStore, eg.selfAccount.id);
@@ -274,6 +276,7 @@ void main() {
         ..zulipMergeBase.equals('6.0')
         ..zulipFeatureLevel.equals(123);
 
+      globalStore.useCachedApiConnections = true;
       connection.prepare(json: eg.initialSnapshot(
         zulipVersion: '8.0+g9876',
         zulipMergeBase: '8.0',
@@ -292,6 +295,7 @@ void main() {
       await prepareStore();
 
       // Try to load, inducing an error in the request.
+      globalStore.useCachedApiConnections = true;
       connection.prepare(exception: Exception('failed'));
       final future = UpdateMachine.load(globalStore, eg.selfAccount.id);
       bool complete = false;

test/model/test_store.dart

@@ -29,27 +29,40 @@ class TestGlobalStore extends GlobalStore {
     FakeApiConnection
   > _apiConnections = {};
 
-  /// Get or construct a [FakeApiConnection] with the given arguments.
-  ///
-  /// This breaches the base method's contract slightly, in that on repeated
-  /// calls with the same arguments it returns the same connection, rather than
-  /// a fresh one each time.  That breach is very convenient for tests,
-  /// enabling a test to get access to the same [FakeApiConnection] that the
-  /// code under test will get, so as to use [FakeApiConnection.prepare]
-  /// and [FakeApiConnection.lastRequest].
+  /// Whether [apiConnection] should return a cached connection.
   ///
-  /// However, if the connection returned by a previous call has been closed
-  /// with [ApiConnection.close], then that connection will be ignored in favor
+  /// If true, [apiConnection] will return a cached [FakeApiConnection]
+  /// from a previous call, if it is still open ([FakeApiConnection.isOpen]).
+  /// If there is a cached connection but it has been closed
+  /// with [ApiConnection.close], that connection will be ignored in favor
   /// of returning (and saving for next time) a fresh connection after all.
+  ///
+  /// If false (the default), returns a fresh connection each time.
+  ///
+  /// Setting this to true is useful if a test needs to access the same
+  /// [FakeApiConnection] that the code under test will get, so as to use
+  /// [FakeApiConnection.prepare] or [FakeApiConnection.lastRequest].
+  /// The behavior with `true` breaches the base method's contract slightly --
+  /// the base method would return a fresh connection each time --
+  /// but that breach is sometimes convenient for tests.
+  bool useCachedApiConnections = false;
+
+  /// Get or construct a [FakeApiConnection] with the given arguments.
+  ///
+  /// To access the same [FakeApiConnection] that the code under test will get,
+  /// so as to use [FakeApiConnection.prepare] or [FakeApiConnection.lastRequest],
+  /// see [useCachedApiConnections].
   @override
   FakeApiConnection apiConnection({
       required Uri realmUrl, required int? zulipFeatureLevel,
       String? email, String? apiKey}) {
     final key = (realmUrl: realmUrl, zulipFeatureLevel: zulipFeatureLevel,
       email: email, apiKey: apiKey);
-    final connection = _apiConnections[key];
-    if (connection != null && connection.isOpen) {
-      return connection;
+    if (useCachedApiConnections) {
+      final connection = _apiConnections[key];
+      if (connection != null && connection.isOpen) {
+        return connection;
+      }
     }
     return (_apiConnections[key] = FakeApiConnection(
       realmUrl: realmUrl, zulipFeatureLevel: zulipFeatureLevel,

test/widgets/login_test.dart

@@ -124,6 +124,7 @@ void main() {
 
         await tester.enterText(findUsernameInput, eg.selfAccount.email);
         await tester.enterText(findPasswordInput, 'p455w0rd');
+        testBinding.globalStore.useCachedApiConnections = true;
         connection.prepare(json: FetchApiKeyResult(
           apiKey: eg.selfAccount.apiKey,
           email: eg.selfAccount.email,
@@ -144,6 +145,7 @@ void main() {
 
         await tester.enterText(findUsernameInput, '  ${eg.selfAccount.email}  ');
         await tester.enterText(findPasswordInput, 'p455w0rd');
+        testBinding.globalStore.useCachedApiConnections = true;
         connection.prepare(json: FetchApiKeyResult(
           apiKey: eg.selfAccount.apiKey,
           email: eg.selfAccount.email,
@@ -165,6 +167,7 @@ void main() {
 
         await tester.enterText(findUsernameInput, eg.selfAccount.email);
         await tester.enterText(findPasswordInput, 'p455w0rd');
+        testBinding.globalStore.useCachedApiConnections = true;
         connection.prepare(json: FetchApiKeyResult(
           apiKey: eg.selfAccount.apiKey,
           email: eg.selfAccount.email,