Fix the race condition in cache_test.dart (#99423)

gspencergoog · web-flow · commit fa68ecf7c645 · 2022-03-03T12:55:47.000-08:00
This fixes a race condition in test/integration.shard/cache_test.dart which allowed the test to fail if the machine took a very long time to acquire a lock or launch a process.
diff --git a/packages/flutter_tools/test/integration.shard/cache_test.dart b/packages/flutter_tools/test/integration.shard/cache_test.dart
@@ -39,6 +39,7 @@ void main() {
         outputPreferences: OutputPreferences(),
       );
       logger.fatalWarnings = true;
+      Process process;
       try {
         Cache.flutterRoot = tempDir.absolute.path;
         final Cache cache = Cache.test(
@@ -56,20 +57,48 @@ import 'dart:async';
 import 'dart:io';
 
 Future<void> main(List<String> args) async {
-File file = File(args[0]);
-RandomAccessFile lock = file.openSync(mode: FileMode.write);
-lock.lockSync();
-await Future<void>.delayed(const Duration(milliseconds: 1000));
-exit(0);
+  File file = File(args[0]);
+  final RandomAccessFile lock = file.openSync(mode: FileMode.write);
+  while (true) {
+    try {
+      lock.lockSync();
+      break;
+    } on FileSystemException {}
+  }
+  await Future<void>.delayed(const Duration(seconds: 1));
+  exit(0);
 }
 ''');
-        final Process process = await const LocalProcessManager().start(
+        // Locks are per-process, so we have to launch a separate process to
+        // test out cache locking.
+        process = await const LocalProcessManager().start(
           <String>[dart, script.absolute.path, cacheFile.absolute.path],
         );
-        await Future<void>.delayed(const Duration(milliseconds: 500));
+        // Wait for the script to lock the test cache file before checking to
+        // see that the cache is unable to.
+        bool locked = false;
+        while (!locked) {
+          // Give the script a chance to try for the lock much more often.
+          await Future<void>.delayed(const Duration(milliseconds: 100));
+          final RandomAccessFile lock = cacheFile.openSync(mode: FileMode.write);
+          try {
+            // If we can lock it, unlock immediately to give the script a
+            // chance.
+            lock.lockSync();
+            lock.unlockSync();
+          } on FileSystemException {
+            // If we can't lock it, then the child script succeeded in locking
+            // it, and we can now test.
+            locked = true;
+            break;
+          }
+        }
+        // Finally, test that the cache cannot lock a locked file. This should
+        // print a message if it can't lock the file.
         await cache.lock();
-        process.kill(io.ProcessSignal.sigkill);
       } finally {
+        // Just to keep from leaving the process hanging around.
+        process?.kill(io.ProcessSignal.sighup);
         tryToDelete(tempDir);
         Cache.flutterRoot = oldRoot;
       }
@@ -78,8 +107,8 @@ exit(0);
       expect(logger.warningText,
           equals('Waiting for another flutter command to release the startup lock...\n'));
       expect(logger.hadErrorOutput, isFalse);
-      // Should still be false, since the particular "Waiting..." message above aims to
-      // avoid triggering failure as a fatal warning.
+      // Should still be false, since the particular "Waiting..." message above
+      // aims to avoid triggering failure as a fatal warning.
       expect(logger.hadWarningOutput, isFalse);
     });
     testWithoutContext(
