Ignore test helpers. #196

polina-c · 2023-12-18T01:35:01Z

Leaks detected in test helpers create extra toil for users of leak_tracker.

This PR adds functionality to ignore disposables, created in test helpers.

It also adds API to test leak_tracker, to test testWidgets and other test engines that use the testing API.

PR for Flutter that uses the created testing API: flutter/flutter#140553

Also this PR enables leak tracking by default in LeakTesting.settings, because it is disabled by default in LeakTesting.enabled.

…rame

…rame-2

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

kenzieschmoll · 2024-01-08T16:53:12Z

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

+  const IgnoredLeaksSet.byClass(Map<String, int?> byClass)
+      : this(byClass: byClass);


why not use this.byClass directly like before?

I do not want to duplicate default for this.ignoreAll

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

kenzieschmoll · 2024-01-08T16:55:51Z

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

+  /// Is used to test functionality of
+  /// the leak tracker.


is this really only used for testing? if so, should this be marked visibleForTesting?

Hm...
Indeed.
I did not know I can use test only members in other packages too.

Ups. It is used for read in production code of leak tracker. And it is complecsity to make just 'write' test-only.

pkgs/leak_tracker/lib/src/shared/shared_model.dart

pkgs/leak_tracker_flutter_testing/test/test_infra/test_helpers.dart

kenzieschmoll · 2024-01-08T17:13:29Z

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

+  });
+
+  test('Test leak is ignored.', () async {
+    createTestWidget();


how do we ensure this case is not a false negative? If StatelessLeakingWidget is really a leaking widget, I would think this case would expose a real leak.

Yes, current implementation is not perfect and will miss some leaks, but it seem to create reasonable balance.

In real cases leaks are mostly created after construction, later, when widgets start functioning.

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

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

kenzieschmoll · 2024-01-08T17:15:37Z

pkgs/leak_tracker_testing/lib/src/leak_testing.dart

@@ -34,7 +34,7 @@ import 'matchers.dart';
 @immutable
 class LeakTesting {
  const LeakTesting._({
-    this.ignore = true,
+    this.ignore = false,


if we are now using LeakTesting.enabled to set whether leak tracking is enabled, do we even need this ignore field anymore?

Yes, for some tests we want to turn off leak tracking.

LeakTesting.enabled cannot be turned off because it indicates that leak tracking infrastructure is used for this process in general.

ignore means to ignore just for this test.

makes sense?

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

pkgs/leak_tracker_flutter_testing/test/test_infra/memory_leak_tests.dart

…, shelf, tools, webdev Revisions updated by `dart tools/rev_sdk_deps.dart`. async (https://github.com/dart-lang/async/compare/9924570..e83d054): e83d054 2024-01-08 Futuristic Goo Fix typo (dart-lang/async#262) ecosystem (https://github.com/dart-lang/ecosystem/compare/dc44e82..1e2785d): 1e2785d 2024-01-09 Jacob MacDonald fix saving of comment ids to disk (dart-lang/ecosystem#221) 244a28d 2024-01-09 Moritz Update publish.yaml (dart-lang/ecosystem#217) bab9833 2024-01-09 Moritz Fix health commenting (dart-lang/ecosystem#219) f87e6f4 2024-01-08 Moritz Update health workflow (dart-lang/ecosystem#216) a58c7d8 2024-01-03 Moritz Fix `labeler.yml` (dart-lang/ecosystem#214) leak_tracker (https://github.com/dart-lang/leak_tracker/compare/3d4c0d6..4a5b077): 4a5b077 2024-01-09 Polina Cherkasova Enhance scripting. (dart-lang/leak_tracker#204) e7094f4 2024-01-08 Polina Cherkasova Ignore test helpers. (dart-lang/leak_tracker#196) 6591934 2024-01-03 Polina Cherkasova Handle deprecation in Flutter. (dart-lang/leak_tracker#203) markdown (https://github.com/dart-lang/markdown/compare/d2e7903..7fdfa55): 7fdfa55 2024-01-01 dependabot[bot] Bump actions/stale from 8.0.0 to 9.0.0 (dart-lang/markdown#571) 5fab3a7 2023-12-19 Alex Li ✨ Introduce AlertBlockSyntax (dart-lang/markdown#570) native (https://github.com/dart-lang/native/compare/0605d9a..14f6da1): 14f6da1d 2024-01-09 Simon Binder Support `@Native` fields and `addressOf` (dart-lang/native#860) protobuf (https://github.com/dart-lang/protobuf/compare/20ec685..a293fb9): a293fb9 2024-01-08 Ömer Sinan Ağacan Handle deprecated options in grpc services and methods, enum types and values, messages (google/protobuf.dart#908) 9a408a7 2024-01-08 Ömer Sinan Ağacan Generate docs of enums and rpc clients, some refactoring (google/protobuf.dart#909) c4fd596 2024-01-06 Ömer Sinan Ağacan Export GeneratedMessageGenericExtensions in generated files (google/protobuf.dart#907) shelf (https://github.com/dart-lang/shelf/compare/733588f..823966f): 823966f 2024-01-03 Moritz Fix `labeler.yml` (dart-lang/shelf#403) tools (https://github.com/dart-lang/tools/compare/2f59ab4..8ffc077): 8ffc077 2024-01-03 Moritz Fix `labeler.yml` (dart-lang/tools#224) webdev (https://github.com/dart-lang/webdev/compare/b2405cb..c08a65c): c08a65c9 2024-01-09 Elliott Brooks Loosen `vm_service` constraints and prepare DWDS for release to 23.1.1 (dart-lang/webdev#2329) 651bdae6 2024-01-08 Derek Xu Make FrontendServerClient start the frontend server from AOT snapshot by default (dart-lang/webdev#2263) 4d1de266 2024-01-03 Elliott Brooks Prepare DWDS for release to version 23.1.0 (dart-lang/webdev#2328) Change-Id: I4d7fd994cc54ac2d72335c3ebf40710f3bd020e6 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/345366 Commit-Queue: Konstantin Shcheglov <scheglov@google.com> Auto-Submit: Devon Carew <devoncarew@google.com> Reviewed-by: Konstantin Shcheglov <scheglov@google.com>

polina-c added 5 commits December 11, 2023 08:59

Update model.dart

f8ffe3f

Merge branch 'main' of github.com:dart-lang/leak_tracker into ignoreF…

abed3f6

…rame

-

4fe85fc

Merge branch 'main' of github.com:dart-lang/leak_tracker into ignoreF…

d7c50dd

…rame

Create test_helpers_test.dart

6f00362

github-actions bot added type-infra A repository infrastructure change or enhancement package:leak_tracker package:leak_tracker_flutter_testing package:leak_tracker_testing package:memory_usage labels Dec 18, 2023

polina-c added 20 commits December 17, 2023 19:31

-

4b8e35f

-

b57b706

Update test_helpers_test.dart

04a4a8e

Update leak_testing.dart

ac83246

Update _test_helper_detector.dart

b1f96fe

Update _test_helper_detector.dart

8c1a473

-

d801df7

Update testing.dart

f02b51a

Update testing_test.dart

5c8cf7d

Update testing.dart

e1f3ef1

Merge branch 'switch' into ignoreFrame

717055e

-

5826392

Merge branch 'main' of github.com:dart-lang/leak_tracker into switch

ed4b61e

-

000e93c

Merge branch 'main' of github.com:dart-lang/leak_tracker into ignoreF…

331b852

…rame

Merge branch 'switch' into ignoreFrame

f3af854

Update leak_tracker_flutter_testing.dart

d77c650

Update test_helpers_test.dart

378ee00

-

8ec30cf

Update _test_helper_detector.dart

688da78

polina-c added 14 commits December 26, 2023 14:31

-

4e2dae6

Update test_case.dart

c6f2ece

Update test_settings.dart

9d77ef8

Merge branch 'main' of github.com:dart-lang/leak_tracker into ignoreF…

64d0ebf

…rame-2

Merge branch 'main' of github.com:dart-lang/leak_tracker into ignoreF…

13d5003

…rame-2

-

8cd9920

-

d8617a5

-

8ae0506

Update test_settings.dart

1697ca0

Update _test_helper_detector.dart

7d7779f

-

fba6c60

Update _test_helper_detector.dart

229d5d4

-

6cedace

Update test_helpers_test.dart

fddae97

polina-c changed the title ~~Ignore test helpers.~~ Ignore test helpers and create API for testing. Jan 7, 2024

polina-c changed the title ~~Ignore test helpers and create API for testing.~~ Ignore test helpers. Jan 7, 2024

-

e12a1af

polina-c requested a review from kenzieschmoll January 7, 2024 01:50

polina-c marked this pull request as ready for review January 7, 2024 01:53

polina-c requested a review from CoderDake as a code owner January 7, 2024 01:53

kenzieschmoll reviewed Jan 8, 2024

View reviewed changes

pkgs/leak_tracker/lib/src/leak_tracking/primitives/_test_helper_detector.dart Outdated Show resolved Hide resolved

kenzieschmoll reviewed Jan 8, 2024

View reviewed changes

polina-c added 2 commits January 8, 2024 10:00

-

7789fbd

Update model.dart

22ee0e5

polina-c requested a review from kenzieschmoll January 8, 2024 18:58

kenzieschmoll approved these changes Jan 9, 2024

View reviewed changes

pkgs/leak_tracker/lib/src/leak_tracking/primitives/_test_helper_detector.dart Outdated Show resolved Hide resolved

pkgs/leak_tracker_flutter_testing/test/test_infra/memory_leak_tests.dart Outdated Show resolved Hide resolved

-

10311d7

polina-c merged commit e7094f4 into dart-lang:main Jan 9, 2024
3 checks passed

polina-c deleted the ignoreFrame branch January 9, 2024 02:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ignore test helpers. #196

Ignore test helpers. #196

polina-c commented Dec 18, 2023 •

edited

Loading

kenzieschmoll Jan 8, 2024

polina-c Jan 8, 2024

kenzieschmoll Jan 8, 2024

polina-c Jan 8, 2024 •

edited

Loading

polina-c Jan 8, 2024

kenzieschmoll Jan 8, 2024

polina-c Jan 8, 2024

kenzieschmoll Jan 8, 2024 •

edited

Loading

polina-c Jan 8, 2024 •

edited

Loading

		const IgnoredLeaksSet.byClass(Map<String, int?> byClass)
		: this(byClass: byClass);

Ignore test helpers. #196

Ignore test helpers. #196

Conversation

polina-c commented Dec 18, 2023 • edited Loading

kenzieschmoll Jan 8, 2024

Choose a reason for hiding this comment

polina-c Jan 8, 2024

Choose a reason for hiding this comment

kenzieschmoll Jan 8, 2024

Choose a reason for hiding this comment

polina-c Jan 8, 2024 • edited Loading

Choose a reason for hiding this comment

polina-c Jan 8, 2024

Choose a reason for hiding this comment

kenzieschmoll Jan 8, 2024

Choose a reason for hiding this comment

polina-c Jan 8, 2024

Choose a reason for hiding this comment

kenzieschmoll Jan 8, 2024 • edited Loading

Choose a reason for hiding this comment

polina-c Jan 8, 2024 • edited Loading

Choose a reason for hiding this comment

polina-c commented Dec 18, 2023 •

edited

Loading

polina-c Jan 8, 2024 •

edited

Loading

kenzieschmoll Jan 8, 2024 •

edited

Loading

polina-c Jan 8, 2024 •

edited

Loading