From bfa80760411d1b458ee25dbba732f6501bda75c4 Mon Sep 17 00:00:00 2001
From: Maneesh Tewani <mtewani@google.com>
Date: Tue, 19 Nov 2024 09:53:41 -0800
Subject: [PATCH] Added a new listen test for cancelling subscriptions

---
 .../example/integration_test/listen_e2e.dart  | 78 +++++++++++++++++++
 1 file changed, 78 insertions(+)

diff --git a/packages/firebase_data_connect/firebase_data_connect/example/integration_test/listen_e2e.dart b/packages/firebase_data_connect/firebase_data_connect/example/integration_test/listen_e2e.dart
index c8cfffaa9431..d0cbff385e94 100644
--- a/packages/firebase_data_connect/firebase_data_connect/example/integration_test/listen_e2e.dart
+++ b/packages/firebase_data_connect/firebase_data_connect/example/integration_test/listen_e2e.dart
@@ -75,6 +75,84 @@ void runListenTests() {
         expect(hasListenerReceived, isTrue,
             reason: 'The stream should have emitted new data');
       });
+      testWidgets('should be able to gracefully cancel',
+          (WidgetTester tester) async {
+        final initialValue =
+            await MoviesConnector.instance.listMovies().ref().execute();
+        expect(initialValue.data.movies.length, 0,
+            reason: 'Initial movie list should be empty');
+
+        final Completer<void> isReady = Completer<void>();
+        final Completer<bool> hasBeenListened = Completer<bool>();
+        int count = 0;
+
+        final listener1 = MoviesConnector.instance
+            .listMovies()
+            .ref()
+            .subscribe()
+            .listen((value) {
+          final movies = value.data.movies;
+
+          if (count == 0) {
+            expect(movies.length, 0,
+                reason: 'First emission should contain an empty list');
+            isReady.complete();
+          } else {
+            expect(movies.length, 1,
+                reason: 'Second emission should contain one movie');
+            expect(movies[0].title, 'The Matrix',
+                reason: 'The movie should be The Matrix');
+            hasBeenListened.complete(true);
+          }
+          count++;
+        });
+        int listener2Count = 0;
+        final listener2 = MoviesConnector.instance
+            .listMovies()
+            .ref()
+            .subscribe()
+            .listen((value) {
+          listener2Count++;
+        });
+
+        // Wait for the listener to be ready
+        await isReady.future;
+
+        // Create the movie
+        await MoviesConnector.instance
+            .createMovie(
+              genre: 'Action',
+              title: 'The Matrix',
+              releaseYear: 1999,
+            )
+            .rating(4.5)
+            .ref()
+            .execute();
+
+        await MoviesConnector.instance.listMovies().ref().execute();
+
+        // Wait for the listener to receive the movie update
+        final bool hasListenerReceived = await hasBeenListened.future;
+
+        // Cancel the listener and wait for it to finish
+        await listener1.cancel();
+        expect(hasListenerReceived, isTrue,
+            reason: 'The stream should have emitted new data');
+        // Create the movie
+        await MoviesConnector.instance
+            .createMovie(
+              genre: 'Adventure',
+              title: 'Raiders of the Lost Arc',
+              releaseYear: 1999,
+            )
+            .rating(4.5)
+            .ref()
+            .execute();
+        await Future.delayed(const Duration(seconds: 5));
+        expect(count, equals(2));
+        expect(listener2Count, equals(3));
+        await listener2.cancel();
+      });
     },
   );
 }