diff --git a/doc/leak_tracking/TROUBLESHOOT.md b/doc/leak_tracking/TROUBLESHOOT.md index 87864cb3..b4873f9a 100644 --- a/doc/leak_tracking/TROUBLESHOOT.md +++ b/doc/leak_tracking/TROUBLESHOOT.md @@ -80,6 +80,25 @@ testWidgets('async onInit throws FlutterError', ... ``` +## Convert the leak to tech debt + +If the leak is complicated and the test failure blocks important process, +temporary turn off leak tracking and create issue to fix the leak and re-enable leak tracking. + +* For one test, add parameter to `testWidgets`: + ``` + // TODO ... + experimentalLeakTesting: LeakTesting.settings.withIgnoredAll(), + +* For a test suite, add line to the test's `main`: + ``` + // TODO ... + LeakTesting.settings = LeakTesting.settings.withIgnoredAll(); + ``` + +* For all tests, update[`test/flutter_test_config.dart`](https://api.flutter.dev/flutter/flutter_test/flutter_test-library.html) to not invoke `LeakTesting.enable();` + + ## Get additional information To understand the root cause of a memory leak, you may want to gather additional information. diff --git a/pkgs/leak_tracker/CHANGELOG.md b/pkgs/leak_tracker/CHANGELOG.md index 15b3feb2..7e18c646 100644 --- a/pkgs/leak_tracker/CHANGELOG.md +++ b/pkgs/leak_tracker/CHANGELOG.md @@ -1,3 +1,7 @@ +# 10.0.7 + +* Fix broken link in error message. + # 10.0.6 * Handle double tracking. diff --git a/pkgs/leak_tracker/lib/src/shared/_primitives.dart b/pkgs/leak_tracker/lib/src/shared/_primitives.dart index 10999ff3..7628f9c8 100644 --- a/pkgs/leak_tracker/lib/src/shared/_primitives.dart +++ b/pkgs/leak_tracker/lib/src/shared/_primitives.dart @@ -35,7 +35,7 @@ final leakTrackerYamlHeader = ''' /// The enum is test covered to catch broken links. enum Links { gitHubTroubleshooting( - 'https://github.com/dart-lang/leak_tracker/blob/main/doc/TROUBLESHOOT.md', + 'https://github.com/dart-lang/leak_tracker/blob/main/doc/leak_tracking/TROUBLESHOOT.md', null, ), ; diff --git a/pkgs/leak_tracker/pubspec.yaml b/pkgs/leak_tracker/pubspec.yaml index 27b2056e..393182b2 100644 --- a/pkgs/leak_tracker/pubspec.yaml +++ b/pkgs/leak_tracker/pubspec.yaml @@ -1,5 +1,5 @@ name: leak_tracker -version: 10.0.6 +version: 10.0.7 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 diff --git a/pkgs/leak_tracker/test/tests/shared/_primitives_test.dart b/pkgs/leak_tracker/test/tests/shared/_primitives_test.dart index ef532290..681fcfcd 100644 --- a/pkgs/leak_tracker/test/tests/shared/_primitives_test.dart +++ b/pkgs/leak_tracker/test/tests/shared/_primitives_test.dart @@ -11,6 +11,9 @@ void main() { for (final link in Links.values) { test('$link is not broken', () async { final content = await loadPageHtmlContent(link.value); + + expect(content, isNot(contains('"title":"File not found"'))); + final hash = link.hash; if (hash != null) { expect(content, contains('href="#$hash"')); diff --git a/pkgs/leak_tracker_flutter_testing/CHANGELOG.md b/pkgs/leak_tracker_flutter_testing/CHANGELOG.md index aa1ee9fe..ceeedd0b 100644 --- a/pkgs/leak_tracker_flutter_testing/CHANGELOG.md +++ b/pkgs/leak_tracker_flutter_testing/CHANGELOG.md @@ -1,3 +1,7 @@ +## 3.0.7 + +* Upgrade leak_tracker to 10.0.7. + ## 3.0.6 * Upgrade leak_tracker to 10.0.7. diff --git a/pkgs/leak_tracker_flutter_testing/lib/src/matchers.dart b/pkgs/leak_tracker_flutter_testing/lib/src/matchers.dart index a94251cf..cffd5442 100644 --- a/pkgs/leak_tracker_flutter_testing/lib/src/matchers.dart +++ b/pkgs/leak_tracker_flutter_testing/lib/src/matchers.dart @@ -28,7 +28,7 @@ Future> memoryEvents( return events; } -/// Checks if Iterable contains two events, +/// Checks if `Iterable` contains two events, /// first `ObjectCreated` and then `ObjectDisposed`. Matcher areCreateAndDispose = const _AreCreateAndDispose(); diff --git a/pkgs/leak_tracker_flutter_testing/pubspec.yaml b/pkgs/leak_tracker_flutter_testing/pubspec.yaml index ab8e5bec..6568af0b 100644 --- a/pkgs/leak_tracker_flutter_testing/pubspec.yaml +++ b/pkgs/leak_tracker_flutter_testing/pubspec.yaml @@ -1,5 +1,5 @@ name: leak_tracker_flutter_testing -version: 3.0.6 +version: 3.0.7 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