Stop failing on double finalization

.github/workflows/ci.yaml

@@ -31,18 +31,44 @@ jobs:
       - name: analyze
         run: sh ./tool/analyze.sh
 
-      - name: dart test
+      # unit tests:
+
+      - name: test leak_tracker
         run: dart test
         working-directory: pkgs/leak_tracker
 
-      - name: dart test
+      - name: test leak_tracker_testing
         run: dart test
         working-directory: pkgs/leak_tracker_testing
 
-      - name: flutter test
+      - name: test leak_tracker_flutter_testing
         run: flutter test --enable-vmservice
         working-directory: pkgs/leak_tracker_flutter_testing
 
-      - name: integration test
+      - name: test memory_usage
+        run: dart test
+        working-directory: pkgs/memory_usage
+
+      # integration tests:
+
+      - name: integration test examples/autosnapshotting
         run: flutter test integration_test/app_test.dart -d flutter-tester
         working-directory: examples/autosnapshotting
+
+      # cycles:
+
+      - name: cycles in leak_tracker
+        run: dart run layerlens --fail-on-cycles
+        working-directory: pkgs/leak_tracker
+
+      - name: cycles in leak_tracker_testing
+        run: dart run layerlens --fail-on-cycles
+        working-directory: pkgs/leak_tracker_testing
+
+      - name: cycles in leak_tracker_flutter_testing
+        run: dart run layerlens --fail-on-cycles
+        working-directory: pkgs/leak_tracker_flutter_testing
+
+      - name: cycles in memory_usage
+        run: dart run layerlens --fail-on-cycles
+        working-directory: pkgs/memory_usage

doc/leak_tracking/OVERVIEW.md

@@ -2,7 +2,7 @@
 
 Detecting memory leaks for large applications is hard ([snapshot diffing](https://nodejs.org/en/docs/guides/diagnostics/memory/using-heap-snapshot), [profiling](https://www.atatus.com/blog/how-to-identify-memory-leaks/#:~:text=doomed%20to%20fail.-,Is%20There%20a%20Way%20to%20Tell%20a%20Memory%20Leak%3F,RAM%20and%20crash%20your%20application.)). Normally, the leaks impact users, staying invisible for application teams.
 
-leak_tracker helps to catch memory issues much earlier by detecting not-disposed and not-garbage-collected objects in Flutter regression tests.
+`leak_tracker` helps to catch memory issues much earlier by detecting not-disposed and not-garbage-collected objects in Flutter regression tests.
 
 ## Read more
 

pkgs/leak_tracker/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 10.0.5
+
+* Stop failing if finalization happened twice.
+
 # 10.0.4
 
 * Add exceptions to test helpers.

pkgs/leak_tracker/lib/DEPENDENCIES.md

@@ -1,6 +1,6 @@
 <!---
 Generated by https://github.com/polina-c/layerlens
-Dependencies that create loop are markes with `!`.
+Dependencies that create loops (inversions) are marked with `!`.
 -->
 
 ```mermaid
@@ -9,3 +9,8 @@ devtools_integration.dart-->src;
 leak_tracker.dart-->src;
 ```
 
+### Inversions
+In this folder: 0
+
+Including sub-folders: 0
+

pkgs/leak_tracker/lib/src/DEPENDENCIES.md

@@ -1,13 +1,17 @@
 <!---
 Generated by https://github.com/polina-c/layerlens
-Dependencies that create loop are markes with `!`.
+Dependencies that create loops (inversions) are marked with `!`.
 -->
 
 ```mermaid
 flowchart TD;
 devtools_integration-->shared;
 leak_tracking-->devtools_integration;
 leak_tracking-->shared;
-usage_tracking-->shared;
 ```
 
+### Inversions
+In this folder: 0
+
+Including sub-folders: 0
+

pkgs/leak_tracker/lib/src/devtools_integration/DEPENDENCIES.md

@@ -1,6 +1,6 @@
 <!---
 Generated by https://github.com/polina-c/layerlens
-Dependencies that create loop are markes with `!`.
+Dependencies that create loops (inversions) are marked with `!`.
 -->
 
 ```mermaid
@@ -13,3 +13,8 @@ delivery.dart-->_protocol.dart;
 delivery.dart-->primitives.dart;
 ```
 
+### Inversions
+In this folder: 0
+
+Including sub-folders: 0
+

pkgs/leak_tracker/lib/src/leak_tracking/DEPENDENCIES.md

@@ -1,6 +1,6 @@
 <!---
 Generated by https://github.com/polina-c/layerlens
-Dependencies that create loop are markes with `!`.
+Dependencies that create loops (inversions) are marked with `!`.
 -->
 
 ```mermaid
@@ -22,9 +22,13 @@ _object_tracker.dart-->_object_record.dart;
 _object_tracker.dart-->_object_records.dart;
 _object_tracker.dart-->primitives;
 helpers.dart-->primitives;
-leak_testing.dart-->primitives;
 leak_tracking.dart-->_baseliner.dart;
 leak_tracking.dart-->_leak_tracker.dart;
 leak_tracking.dart-->primitives;
 ```
 
+### Inversions
+In this folder: 0
+
+Including sub-folders: 0
+

pkgs/leak_tracker/lib/src/leak_tracking/_object_record.dart

@@ -63,7 +63,10 @@ class ObjectRecord {
   DateTime? _gcedTime;
   int? _gcedGcCount;
   void setGCed(int gcCount, DateTime time) {
-    if (_gcedGcCount != null) throw Exception('The object $code GCed twice');
+    // Normally it should not happen, but sometimes finalizer is called twice.
+    // To repro, update next line to throw exception and run flutter tests with
+    // the updated leak_tracker.
+    if (_gcedGcCount != null) return;
     _gcedGcCount = gcCount;
     _gcedTime = time;
   }

pkgs/leak_tracker/lib/src/leak_tracking/helpers.dart

@@ -53,6 +53,8 @@ Future<void> forceGC({
 ///
 /// Does not work in web and in release mode.
 ///
+/// To run this inside `flutter test` pass `--enable-vmservice`.
+///
 /// Also does not work for objects that are not returned by getInstances.
 /// https://github.com/dart-lang/sdk/blob/3e80d29fd6fec56187d651ce22ea81f1e8732214/runtime/vm/object_graph.cc#L1803
 Future<String?> formattedRetainingPath(WeakReference ref) async {

pkgs/leak_tracker/lib/src/leak_tracking/leak_tracking.dart

@@ -205,7 +205,7 @@ abstract class LeakTracking {
       return true;
     }());
 
-    await (result ?? Future.value());
+    await (result ?? Future<void>.value());
   }
 
   /// Declares all not disposed objects as leaks.

pkgs/leak_tracker/lib/src/leak_tracking/primitives/_retaining_path/DEPENDENCIES.md

@@ -0,0 +1,15 @@
+<!---
+Generated by https://github.com/polina-c/layerlens
+Dependencies that create loops (inversions) are marked with `!`.
+-->
+
+```mermaid
+flowchart TD;
+_retaining_path.dart-->_retaining_path_web.dart;
+```
+
+### Inversions
+In this folder: 0
+
+Including sub-folders: 0
+

pkgs/leak_tracker/lib/src/shared/DEPENDENCIES.md

@@ -1,6 +1,6 @@
 <!---
 Generated by https://github.com/polina-c/layerlens
-Dependencies that create loop are markes with `!`.
+Dependencies that create loops (inversions) are marked with `!`.
 -->
 
 ```mermaid
@@ -11,3 +11,8 @@ shared_model.dart-->_formatting.dart;
 shared_model.dart-->_primitives.dart;
 ```
 
+### Inversions
+In this folder: 0
+
+Including sub-folders: 0
+

pkgs/leak_tracker/pubspec.yaml

@@ -1,5 +1,5 @@
 name: leak_tracker
-version: 10.0.4
+version: 10.0.5
 description: A framework for memory leak tracking for Dart and Flutter applications.
 repository: https://github.com/dart-lang/leak_tracker/tree/main/pkgs/leak_tracker
 
@@ -18,5 +18,5 @@ dependencies:
 
 dev_dependencies:
   dart_flutter_team_lints: ^2.1.0
-  layerlens: ^1.0.0
+  layerlens: ^1.0.16
   test: ^1.16.0

pkgs/leak_tracker_flutter_testing/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.0.4
+
+* Upgrade leak_tracker to 10.0.5.
+
 ## 3.0.3
 
 * Upgrade leak_tracker to 10.0.4.

pkgs/leak_tracker_flutter_testing/README.md

@@ -5,7 +5,7 @@ Coming soon! See https://github.com/flutter/devtools/issues/3951.
 
 ## What is leak_tracker_flutter_testing?
 
-leak_tracker_flutter_testing is Flutter specific test helpers for [leak_tracker](https://pub.dev/packages/leak_tracker).
+`leak_tracker_flutter_testing` is Flutter specific test helpers for [leak_tracker](https://pub.dev/packages/leak_tracker).
 
 They are separated from [leak_tracker_testing](https://pub.dev/packages/leak_tracker_testing) because the last one is pure Flutter
 package and should not reference Flutter Framework.

pkgs/leak_tracker_flutter_testing/pubspec.yaml

@@ -1,5 +1,5 @@
 name: leak_tracker_flutter_testing
-version: 3.0.3
+version: 3.0.4
 description: An internal package to test leak tracking with Flutter.
 repository: https://github.com/dart-lang/leak_tracker/tree/main/pkgs/leak_tracker_flutter_testing
 
@@ -17,4 +17,5 @@ dependencies:
 
 dev_dependencies:
   dart_flutter_team_lints: ^2.1.0
+  layerlens: ^1.0.16
   test: ^1.25.0

pkgs/leak_tracker_testing/pubspec.yaml

@@ -16,5 +16,5 @@ dependencies:
 
 dev_dependencies:
   dart_flutter_team_lints: ^2.1.0
-  layerlens: ^1.0.0
+  layerlens: ^1.0.16
   test: ^1.16.0

pkgs/memory_usage/pubspec.yaml

@@ -11,5 +11,5 @@ dependencies:
 
 dev_dependencies:
   dart_flutter_team_lints: ^2.1.0
-  layerlens: ^1.0.0
+  layerlens: ^1.0.16
   test: ^1.16.0