test(storage, apple): fix consistently failing storage e2e cancel() test (#17596)

russellwheatley · web-flow · commit b88693d5150a · 2025-08-05T16:20:08.000+01:00
diff --git a/.github/workflows/all_plugins.yaml b/.github/workflows/all_plugins.yaml
@@ -124,7 +124,7 @@ jobs:
             "flutter build web"
   swift-integration:
     runs-on: macos-15
-    timeout-minutes: 30
+    timeout-minutes: 45
     env:
       FLUTTER_DEPENDENCIES: "cloud_firestore firebase_remote_config cloud_functions firebase_database firebase_auth firebase_storage firebase_analytics firebase_messaging firebase_app_check firebase_in_app_messaging firebase_performance firebase_crashlytics firebase_ml_model_downloader firebase_app_installations"
       PR_HEAD_REPO: ${{ github.event.pull_request.head.repo.full_name }}
diff --git a/packages/firebase_storage/firebase_storage/example/ios/Runner.xcodeproj/project.pbxproj b/packages/firebase_storage/firebase_storage/example/ios/Runner.xcodeproj/project.pbxproj
@@ -157,6 +157,7 @@
 				97C146EC1CF9000F007C117D /* Resources */,
 				9705A1C41CF9048500538489 /* Embed Frameworks */,
 				3B06AD1E1E4923F5004D2608 /* Thin Binary */,
+				545E69528F1478FA4BB537F8 /* [CP] Embed Pods Frameworks */,
 			);
 			buildRules = (
 			);
@@ -240,6 +241,40 @@
 			shellPath = /bin/sh;
 			shellScript = "/bin/sh \"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh\" embed_and_thin";
 		};
+		545E69528F1478FA4BB537F8 /* [CP] Embed Pods Frameworks */ = {
+			isa = PBXShellScriptBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+			);
+			inputPaths = (
+				"${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-frameworks.sh",
+				"${BUILT_PRODUCTS_DIR}/FirebaseAppCheckInterop/FirebaseAppCheckInterop.framework",
+				"${BUILT_PRODUCTS_DIR}/FirebaseAuthInterop/FirebaseAuthInterop.framework",
+				"${BUILT_PRODUCTS_DIR}/FirebaseCore/FirebaseCore.framework",
+				"${BUILT_PRODUCTS_DIR}/FirebaseCoreExtension/FirebaseCoreExtension.framework",
+				"${BUILT_PRODUCTS_DIR}/FirebaseCoreInternal/FirebaseCoreInternal.framework",
+				"${BUILT_PRODUCTS_DIR}/FirebaseStorage/FirebaseStorage.framework",
+				"${BUILT_PRODUCTS_DIR}/GTMSessionFetcher/GTMSessionFetcher.framework",
+				"${BUILT_PRODUCTS_DIR}/GoogleUtilities/GoogleUtilities.framework",
+				"${BUILT_PRODUCTS_DIR}/image_picker_ios/image_picker_ios.framework",
+			);
+			name = "[CP] Embed Pods Frameworks";
+			outputPaths = (
+				"${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/FirebaseAppCheckInterop.framework",
+				"${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/FirebaseAuthInterop.framework",
+				"${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/FirebaseCore.framework",
+				"${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/FirebaseCoreExtension.framework",
+				"${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/FirebaseCoreInternal.framework",
+				"${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/FirebaseStorage.framework",
+				"${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/GTMSessionFetcher.framework",
+				"${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/GoogleUtilities.framework",
+				"${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/image_picker_ios.framework",
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+			shellPath = /bin/sh;
+			shellScript = "\"${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-frameworks.sh\"\n";
+			showEnvVarsInLog = 0;
+		};
 		9740EEB61CF901F6004384FC /* Run Script */ = {
 			isa = PBXShellScriptBuildPhase;
 			alwaysOutOfDate = 1;
diff --git a/packages/firebase_storage/firebase_storage/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/packages/firebase_storage/firebase_storage/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme
@@ -44,6 +44,7 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      customLLDBInitFile = "$(SRCROOT)/Flutter/ephemeral/flutter_lldbinit"
       shouldUseLaunchSchemeArgsEnv = "YES">
       <Testables>
       </Testables>
@@ -63,11 +64,13 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      customLLDBInitFile = "$(SRCROOT)/Flutter/ephemeral/flutter_lldbinit"
       launchStyle = "0"
       useCustomWorkingDirectory = "NO"
       ignoresPersistentStateOnLaunch = "NO"
       debugDocumentVersioning = "YES"
       debugServiceExtension = "internal"
+      enableGPUValidationMode = "1"
       allowLocationSimulation = "YES">
       <BuildableProductRunnable
          runnableDebuggingMode = "0">
diff --git a/tests/integration_test/firebase_storage/reference_e2e.dart b/tests/integration_test/firebase_storage/reference_e2e.dart
@@ -344,7 +344,10 @@ void setupReferenceTests() {
         test(
           'uploads a file',
           () async {
-            final File file = await createFile('flt-ok.txt');
+            final File file = await createFile(
+              'flt-ok.txt',
+              string: kTestString,
+            );
 
             final Reference ref =
                 storage.ref('flutter-tests').child('flt-ok.txt');
@@ -381,7 +384,7 @@ void setupReferenceTests() {
               'put file some text to compare with uploaded and downloaded';
           final File file = await createFile(
             'read-and-write.txt',
-            largeString: text,
+            string: text,
           );
 
           final Reference ref =
diff --git a/tests/integration_test/firebase_storage/task_e2e.dart b/tests/integration_test/firebase_storage/task_e2e.dart
@@ -235,53 +235,85 @@ void setupTaskTests() {
       () {
         late Task task;
 
-        Future<void> _testCancelTask() async {
+        Future<void> _testCancelTaskSnapshotEvents(Task task) async {
           List<TaskSnapshot> snapshots = [];
           expect(task.snapshot.state, TaskState.running);
           final Completer<FirebaseException> errorReceived =
               Completer<FirebaseException>();
+          final Completer<bool> started = Completer<bool>();
 
           task.snapshotEvents.listen(
             (TaskSnapshot snapshot) {
+              if (!started.isCompleted) {
+                started.complete(true);
+              }
               snapshots.add(snapshot);
             },
             onError: (error) {
               errorReceived.complete(error);
             },
           );
 
+          await started.future;
+
           bool canceled = await task.cancel();
           expect(canceled, isTrue);
           expect(task.snapshot.state, TaskState.canceled);
 
+          final streamError = await errorReceived.future;
+
+          expect(streamError, isNotNull);
+          expect(streamError.code, 'canceled');
+          // Expecting there to only be running states, canceled should not get sent as an event.
+          expect(
+            snapshots.every((snapshot) => snapshot.state == TaskState.running),
+            isTrue,
+          );
+
           await expectLater(
             task,
             throwsA(
               isA<FirebaseException>()
                   .having((e) => e.code, 'code', 'canceled'),
             ),
           );
+        }
 
+        Future<void> _testCancelTaskLastEvent(Task task) async {
+          expect(task.snapshot.state, TaskState.running);
+
+          bool canceled = await task.cancel();
+          expect(canceled, isTrue);
           expect(task.snapshot.state, TaskState.canceled);
+        }
 
-          // Need to wait for error to be received before checking
-          final streamError = await errorReceived.future;
+        test(
+          'successfully cancels download task using snapshotEvents',
+          () async {
+            file = await createFile('ok.txt');
+            // Need to put a large file in emulator first to test cancel.
+            final initialPut = downloadRef.putFile(file);
 
-          expect(streamError, isNotNull);
-          expect(streamError.code, 'canceled');
-          // Expecting there to only be running states, canceled should not get sent as an event.
-          expect(
-            snapshots.every((snapshot) => snapshot.state == TaskState.running),
-            isTrue,
-          );
-        }
+            await initialPut;
+            task = downloadRef.writeToFile(file);
+
+            await _testCancelTaskSnapshotEvents(task);
+          },
+          // There's no DownloadTask on web.
+          // Windows `task.cancel()` is returning "false", same code on example app works as intended
+          skip: kIsWeb || defaultTargetPlatform == TargetPlatform.windows,
+          retry: 2,
+        );
 
         test(
-          'successfully cancels download task',
+          'successfully cancels download task and provides the last `canceled` event',
           () async {
-            file = await createFile('ok.jpeg', largeString: 'A' * 20000000);
+            file = await createFile('ok.txt');
+            final initialPut = downloadRef.putFile(file);
+
+            await initialPut;
             task = downloadRef.writeToFile(file);
-            await _testCancelTask();
+            await _testCancelTaskLastEvent(task);
           },
           // There's no DownloadTask on web.
           // Windows `task.cancel()` is returning "false", same code on example app works as intended
@@ -290,10 +322,21 @@ void setupTaskTests() {
         );
 
         test(
-          'successfully cancels upload task',
+          'successfully cancels upload task using snapshotEvents',
+          () async {
+            task = uploadRef.putString('A' * 20000000);
+            await _testCancelTaskSnapshotEvents(task);
+          },
+          retry: 2,
+          // Windows `task.cancel()` is returning "false", same code on example app works as intended
+          skip: defaultTargetPlatform == TargetPlatform.windows,
+        );
+
+        test(
+          'successfully cancels upload task and provides the last `canceled` event',
           () async {
             task = uploadRef.putString('A' * 20000000);
-            await _testCancelTask();
+            await _testCancelTaskLastEvent(task);
           },
           retry: 2,
           // Windows `task.cancel()` is returning "false", same code on example app works as intended
diff --git a/tests/integration_test/firebase_storage/test_utils.dart b/tests/integration_test/firebase_storage/test_utils.dart
@@ -33,10 +33,47 @@ const int testEmulatorPort = 9199;
 
 // Creates a test file with a specified name to
 // a locally directory
-Future<File> createFile(String name, {String? largeString}) async {
+Future<File> createFile(
+  String name, {
+  String? string,
+  int sizeInBytes = 209715200,
+}) async {
   final Directory systemTempDir = Directory.systemTemp;
   final File file = await File('${systemTempDir.path}/$name').create();
-  await file.writeAsString(largeString ?? kTestString);
+
+  if (string != null) {
+    await file.writeAsString(string);
+    return file;
+  }
+
+  // Create a 200MB file by writing data in chunks to avoid memory issues
+  const chunkSize = 1024 * 1024; // 1MB chunks
+  final chunk = Uint8List(chunkSize);
+
+  // Fill chunk with random-ish data to prevent compression
+  for (int i = 0; i < chunkSize; i++) {
+    chunk[i] = i % 256; // Creates a pattern from 0-255
+  }
+
+  final sink = file.openWrite();
+  final totalChunks = (sizeInBytes / chunkSize).ceil();
+
+  for (int i = 0; i < totalChunks; i++) {
+    if (i == totalChunks - 1) {
+      // Last chunk might be smaller
+      final remainingBytes = sizeInBytes % chunkSize;
+      if (remainingBytes > 0) {
+        sink.add(chunk.sublist(0, remainingBytes));
+      } else {
+        sink.add(chunk);
+      }
+    } else {
+      sink.add(chunk);
+    }
+  }
+
+  await sink.close();
+
   return file;
 }
 
diff --git a/tests/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/tests/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme
@@ -26,6 +26,7 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      customLLDBInitFile = "$(SRCROOT)/Flutter/ephemeral/flutter_lldbinit"
       shouldUseLaunchSchemeArgsEnv = "YES">
       <MacroExpansion>
          <BuildableReference
@@ -43,11 +44,13 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      customLLDBInitFile = "$(SRCROOT)/Flutter/ephemeral/flutter_lldbinit"
       launchStyle = "0"
       useCustomWorkingDirectory = "NO"
       ignoresPersistentStateOnLaunch = "NO"
       debugDocumentVersioning = "YES"
       debugServiceExtension = "internal"
+      enableGPUValidationMode = "1"
       allowLocationSimulation = "YES">
       <BuildableProductRunnable
          runnableDebuggingMode = "0">
