Avoid duplicate leak tracking and remove dependency on logging. (dart…

…-lang#160)

pkgs/leak_tracker/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 9.0.11
+
+* Remove dependency on logging.
+* Avoid double leak tracking.
+
 # 9.0.10
 
 * Use `IgnoredLeaks`.

pkgs/leak_tracker/lib/src/leak_tracking/_primitives/_retaining_path/_connection.dart

@@ -5,12 +5,9 @@
 import 'dart:async';
 import 'dart:developer';
 
-import 'package:logging/logging.dart';
 import 'package:vm_service/vm_service.dart';
 import 'package:web_socket_channel/web_socket_channel.dart';
 
-final _log = Logger('_connection.dart');
-
 Future<Uri> _serviceUri() async {
   Uri? uri = (await Service.getInfo()).serverWebSocketUri;
 
@@ -31,19 +28,15 @@ Future<Uri> _serviceUri() async {
 ///
 /// If the VM service is not found, tries to start it.
 Future<VmService> connect() async {
-  _log.info('Connecting to VM service protocol...');
-
   final uri = await _serviceUri();
 
   final service = await _connectWithWebSocket(uri, _handleError);
   await service.getVersion(); // Warming up and validating the connection.
 
-  _log.info('Connected to vm service protocol.');
   return service;
 }
 
 void _handleError(Object? error) {
-  _log.info('Error in vm service protocol: $error');
   throw error ?? Exception('Unknown error');
 }
 

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

@@ -5,14 +5,10 @@
 import 'dart:async';
 import 'dart:developer';
 
-import 'package:logging/logging.dart';
-
 import '../shared/_formatting.dart';
 import '_primitives/_retaining_path/_connection.dart';
 import '_primitives/_retaining_path/_retaining_path.dart';
 
-final _log = Logger('orchestration.dart');
-
 /// Forces garbage collection by aggressive memory allocation.
 ///
 /// Verifies that garbage collection happened using [reachabilityBarrier].
@@ -30,7 +26,6 @@ Future<void> forceGC({
   Duration? timeout,
   int fullGcCycles = 1,
 }) async {
-  _log.info('Forcing garbage collection with fullGcCycles = $fullGcCycles...');
   final Stopwatch? stopwatch = timeout == null ? null : (Stopwatch()..start());
   final int barrier = reachabilityBarrier;
 
@@ -50,7 +45,6 @@ Future<void> forceGC({
     await Future<void>.delayed(Duration.zero);
     allocateMemory();
   }
-  _log.info('Done forcing garbage collection.');
 }
 
 /// Returns nicely formatted retaining path for the [ref.target].

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

@@ -2,8 +2,6 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import 'package:logging/logging.dart';
-
 import '../devtools_integration/_registration.dart';
 import '../shared/_primitives.dart';
 import '../shared/shared_model.dart';
@@ -12,8 +10,6 @@ import '_leak_tracker.dart';
 import '_primitives/_dispatcher.dart' as dispatcher;
 import '_primitives/model.dart';
 
-final _log = Logger('leak_tracking.dart');
-
 /// Provides leak tracking functionality.
 abstract class LeakTracking {
   static Baseliner? _baseliner;
@@ -81,7 +77,6 @@ abstract class LeakTracking {
       } else {
         registerLeakTrackingServiceExtension();
       }
-      _log.info('started leak tracking');
       return true;
     }());
   }
@@ -94,7 +89,6 @@ abstract class LeakTracking {
       _leakTracker?.dispose();
       _leakTracker = null;
       Baseliner.finishOldAndStartNew(_baseliner, null);
-      _log.info('stopped leak tracking');
       return true;
     }());
   }

pkgs/leak_tracker/pubspec.yaml

@@ -1,5 +1,5 @@
 name: leak_tracker
-version: 9.0.10
+version: 9.0.11
 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
 
@@ -10,7 +10,6 @@ dependencies:
   clock: ^1.1.1
   collection: ^1.15.0
   intl: ^0.18.0
-  logging: ^1.1.1
   meta: ^1.8.0
   path: ^1.8.3
   vm_service: '>=11.10.0 <13.0.0'

pkgs/leak_tracker/test/tests/leak_tracking/retaining_path/_retaining_path_test.dart

@@ -6,7 +6,6 @@ import 'dart:async';
 
 import 'package:leak_tracker/src/leak_tracking/_primitives/_retaining_path/_connection.dart';
 import 'package:leak_tracker/src/leak_tracking/_primitives/_retaining_path/_retaining_path.dart';
-import 'package:logging/logging.dart';
 import 'package:test/test.dart';
 
 class MyClass {
@@ -17,23 +16,7 @@ class MyArgClass<T> {
   MyArgClass();
 }
 
-final _logs = <String>[];
-late StreamSubscription<LogRecord> subscription;
-
 void main() {
-  setUpAll(() {
-    subscription = Logger.root.onRecord
-        .listen((LogRecord record) => _logs.add(record.message));
-  });
-
-  setUp(() {
-    _logs.clear();
-  });
-
-  tearDownAll(() async {
-    await subscription.cancel();
-  });
-
   test('Path for $MyClass instance is found.', () async {
     final instance = MyClass();
     final connection = await connect();
@@ -67,11 +50,8 @@ void main() {
       retainingPath(connection, instance2),
     ];
 
-    await Future.wait(obtainers);
+    final result = await Future.wait(obtainers);
 
-    expect(
-      _logs.where((item) => item == 'Connecting to VM service protocol...'),
-      hasLength(1),
-    );
+    expect(result.where((p) => p == null), hasLength(0));
   });
 }

pkgs/leak_tracker_flutter_testing/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.9
+
+* Update `testWidgetsWithLeakTracking` to avoid duplicated leak tracking by testWidgets.
+
 # 1.0.8
 
 * Make configuration adjustable.

pkgs/leak_tracker_flutter_testing/lib/src/test_widgets.dart

@@ -68,7 +68,7 @@ Future<void> _tearDownTestingWithLeakTracking(LeaksCallback? onLeaks) async {
   }
 }
 
-// TODO(polina-c): retire this class after migration to `testWidgets`.
+// TODO(polina-c): retire this function after migration to `testWidgets`.
 // https://github.com/flutter/flutter/issues/135856
 /// Wrapper for [testWidgets] with memory leak tracking.
 ///
@@ -111,15 +111,23 @@ void testWidgetsWithLeakTracking(
     LeakTracking.phase = const PhaseSettings.ignored();
   }
 
-  testWidgets(
-    description,
-    wrappedCallBack,
-    skip: skip,
-    timeout: timeout,
-    semanticsEnabled: semanticsEnabled,
-    variant: variant,
-    tags: tags,
-  );
+  // Temporarily turn off leak tracking, so that `testWidgests` does not track leaks in addition.
+  final originalGlobalSettings = LeakTesting.settings;
+  LeakTesting.settings = LeakTesting.settings.withIgnoredAll();
+
+  try {
+    testWidgets(
+      description,
+      wrappedCallBack,
+      skip: skip,
+      timeout: timeout,
+      semanticsEnabled: semanticsEnabled,
+      variant: variant,
+      tags: tags,
+    );
+  } finally {
+    LeakTesting.settings = originalGlobalSettings;
+  }
 }
 
 bool _notSupportedWarningPrinted = false;

pkgs/leak_tracker_flutter_testing/pubspec.yaml

@@ -1,5 +1,5 @@
 name: leak_tracker_flutter_testing
-version: 1.0.8
+version: 1.0.9
 description: Flutter specific helpers for dart memory leak tracking.
 repository: https://github.com/dart-lang/leak_tracker/tree/main/pkgs/leak_tracker_flutter_testing
 
@@ -17,7 +17,6 @@ dependencies:
 
 dev_dependencies:
   flutter_lints: ^3.0.0
-  logging: ^1.1.1
 
 dependency_overrides:
   leak_tracker:

pkgs/leak_tracker_flutter_testing/test/tests/end_to_end/_retaining_path_test.dart

@@ -2,12 +2,9 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import 'dart:async';
-
 import 'package:flutter_test/flutter_test.dart';
 import 'package:leak_tracker/src/leak_tracking/_primitives/_retaining_path/_connection.dart';
 import 'package:leak_tracker/src/leak_tracking/_primitives/_retaining_path/_retaining_path.dart';
-import 'package:logging/logging.dart';
 
 // We duplicate testing for retaining path here,
 // because there were cases when the tests were passing for dart,
@@ -21,23 +18,7 @@ class MyArgClass<T> {
   MyArgClass();
 }
 
-final _logs = <String>[];
-late StreamSubscription<LogRecord> subscription;
-
 void main() {
-  setUpAll(() {
-    subscription = Logger.root.onRecord
-        .listen((LogRecord record) => _logs.add(record.message));
-  });
-
-  setUp(() {
-    _logs.clear();
-  });
-
-  tearDownAll(() async {
-    await subscription.cancel();
-  });
-
   testWidgets('Path for $MyClass instance is found.',
       (WidgetTester tester) async {
     final instance = MyClass();
@@ -75,11 +56,9 @@ void main() {
       retainingPath(connection, instance2),
     ];
 
-    await Future.wait(obtainers);
+    final paths = await Future.wait(obtainers);
 
-    expect(
-      _logs.where((item) => item == 'Connecting to VM service protocol...'),
-      hasLength(1),
-    );
+    expect(paths, hasLength(2));
+    expect(paths.where((p) => p == null).toList(), hasLength(0));
   });
 }