Create package leak_tracker_flutter_testing. #119

polina-c · 2023-08-08T01:32:19Z

This PR is needed to stop copy-pasting leak_tracker for Flutter between flutter and tests for leak_tracker.

Also:
Fixes #78
Fixes #52

devoncarew

Several comments! Mostly about updating references where things were renamed / moved, and fleshing out the documentation a bit more.

For a package's readme I think it's useful to assume that the user has no context on a package when they first pull up the pub.dev page; the readme should give them some simple grounding on what the package is, why they may want to use it, and how they'd go about doing that.

.github/workflows/ci.yaml

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

pkgs/leak_tracker_flutter_testing/README.md

pkgs/leak_tracker_flutter_testing/lib/leak_tracker_flutter_testing.dart

...utter_testing/test/tests/end_to_end/leak_tracking_config_test/leak_tracking_config_test.dart

pkgs/leak_tracker_testing/README.md

pkgs/leak_tracker/README.md

devoncarew · 2023-08-09T14:45:57Z

pkgs/leak_tracker/README.md

@@ -1,6 +1,18 @@
 [![pub package](https://img.shields.io/pub/v/leak_tracker.svg)](https://pub.dev/packages/leak_tracker)
 [![package publisher](https://img.shields.io/pub/publisher/leak_tracker.svg)](https://pub.dev/packages/leak_tracker/publisher)

-Coming soon!
+Coming soon! See https://github.com/flutter/devtools/issues/3951 and https://github.com/flutter/devtools/issues/5606.


I'd move this into a section below - ## Following package development or similar.

We do not want to recommend people start using the package yet, because flutter framework contains leaks. I am working on cleaning them. When it is done, I will do what you suggested.

pkgs/leak_tracker/README.md

pkgs/leak_tracker_testing/README.md

pkgs/leak_tracker_flutter_testing/README.md

Co-authored-by: Daniel Chevalier <[email protected]>

devoncarew

One question about the maturity that we want to message for package:leak_tracker_flutter_testing.

devoncarew · 2023-08-10T20:13:13Z

pkgs/leak_tracker_flutter_testing/pubspec.yaml

@@ -0,0 +1,23 @@
+name: leak_tracker_flutter_testing
+version: 1.0.0


Are the apis stable or do we expect additional iteration as we explore the space? I ask because we message that the leak_tracker package itself is ~alpha level, however we've published 9 major stable versions of it. In hindsight, we should have started with an 0.1 version there and evolved from that.

If we know that the API is going to evolve before we're comfortable calling it stable than we should start with a pre-release (0.x) version. If we think that the API is stable - and looks like what we'd invite people to consume - then we could start with a 1.0.

pkgs/leak_tracker_testing/README.md

devoncarew · 2023-08-10T20:16:33Z

pkgs/leak_tracker/README.md

+
+First, [understand leak tracking concepts](https://github.com/dart-lang/leak_tracker/blob/main/doc/CONCEPTS.md).
+
+TODO(polina-c): add usage information.


This todo will be what people see when they visit the package on pub.dev - this will be part of the public docs of the package.

Yes, I want people to see that this is still under construction and after stabilization this information will be added.

devoncarew · 2023-08-10T20:18:25Z

pkgs/leak_tracker_flutter_testing/pubspec.yaml

@@ -0,0 +1,23 @@
+name: leak_tracker_flutter_testing
+version: 1.0.0


Another way to put it - the package version is a way to message the maturity of the package.

Co-authored-by: Devon Carew <[email protected]>

polina-c · 2023-08-10T21:02:43Z

Are the apis stable or do we expect additional iteration as we explore the space? I ask because we message that the leak_tracker package itself is ~alpha level, however we've published 9 major stable versions of it. In hindsight, we should have started with an 0.1 version there and evolved from that.

If we know that the API is going to evolve before we're comfortable calling it stable than we should start with a pre-release (0.x) version. If we think that the API is stable - and looks like what we'd invite people to consume - then we could start with a 1.0.

I increase major version because of breaking changes.

At the moment the API is stable enough for Flutter Framework to use it as dev_dependency.
But the Flutter itself is not clean enough to recommend this package for users. And, as we clean up flutter,
we learn, and change API to handle leak tracking better.

That's why the packages are unlisted and we say everywhere that leak tracker is under construction.

Does it help?

devoncarew · 2023-08-11T16:51:22Z

Are the apis stable or do we expect additional iteration as we explore the space? I ask because we message that the leak_tracker package itself is ~alpha level, however we've published 9 major stable versions of it. In hindsight, we should have started with an 0.1 version there and evolved from that.
If we know that the API is going to evolve before we're comfortable calling it stable than we should start with a pre-release (0.x) version. If we think that the API is stable - and looks like what we'd invite people to consume - then we could start with a 1.0.

I increase major version because of breaking changes.

At the moment the API is stable enough for Flutter Framework to use it as dev_dependency. But the Flutter itself is not clean enough to recommend this package for users. And, as we clean up flutter, we learn, and change API to handle leak tracking better.

That's why the packages are unlisted and we say everywhere that leak tracker is under construction.

Does it help?

We should follow semver here; pre-release packages should use versions < 1.0 (0.1, 0.2, 0.3, ...), rev'ing through their point releases as we make breaking api changes. When we're ready for general consumption - ready to call the package stable - we should then release a 1.0 version.

polina-c added 8 commits August 5, 2023 16:14

Update flutter_classes.dart

11c130b

-

75a3acf

-

53d7c9e

-

6d72708

-

eaec6d3

-

4d5c350

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

ba95b98

-

f4bc04d

polina-c requested a review from CoderDake as a code owner August 8, 2023 01:32

polina-c marked this pull request as draft August 8, 2023 01:32

polina-c added 2 commits August 7, 2023 18:54

Update ci.yaml

79e7ac8

-

0efb422

polina-c requested a review from devoncarew August 8, 2023 21:36

polina-c marked this pull request as ready for review August 8, 2023 21:36

devoncarew reviewed Aug 9, 2023

View reviewed changes

polina-c added 4 commits August 9, 2023 21:39

-

bc5634b

-

fa81e8b

Update pubspec.yaml

1f7448f

Update README.md

b4d1c0d

CoderDake reviewed Aug 10, 2023

View reviewed changes

polina-c and others added 5 commits August 10, 2023 09:12

Update pkgs/leak_tracker_testing/README.md

916f357

Co-authored-by: Daniel Chevalier <[email protected]>

Update pkgs/leak_tracker_testing/README.md

193ba07

Co-authored-by: Daniel Chevalier <[email protected]>

Update pkgs/leak_tracker_flutter_testing/README.md

fa84386

Co-authored-by: Daniel Chevalier <[email protected]>

Update pkgs/leak_tracker_flutter_testing/README.md

8b1ba5e

Co-authored-by: Daniel Chevalier <[email protected]>

Update pkgs/leak_tracker_flutter_testing/README.md

a35d367

Co-authored-by: Daniel Chevalier <[email protected]>

devoncarew approved these changes Aug 10, 2023

View reviewed changes

Update pkgs/leak_tracker_testing/README.md

34f1ea7

Co-authored-by: Devon Carew <[email protected]>

polina-c merged commit 19b01cf into dart-lang:main Aug 10, 2023
2 checks passed

polina-c deleted the next branch August 10, 2023 21:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create package leak_tracker_flutter_testing. #119

Create package leak_tracker_flutter_testing. #119

polina-c commented Aug 8, 2023 •

edited

Loading

devoncarew left a comment

devoncarew Aug 9, 2023

polina-c Aug 10, 2023 •

edited

Loading

devoncarew left a comment

devoncarew Aug 10, 2023

devoncarew Aug 10, 2023

polina-c Aug 10, 2023

devoncarew Aug 10, 2023

polina-c commented Aug 10, 2023

devoncarew commented Aug 11, 2023

		@@ -0,0 +1,23 @@
		name: leak_tracker_flutter_testing
		version: 1.0.0


		First, [understand leak tracking concepts](https://github.com/dart-lang/leak_tracker/blob/main/doc/CONCEPTS.md).

		TODO(polina-c): add usage information.

Create package leak_tracker_flutter_testing. #119

Create package leak_tracker_flutter_testing. #119

Conversation

polina-c commented Aug 8, 2023 • edited Loading

devoncarew left a comment

Choose a reason for hiding this comment

devoncarew Aug 9, 2023

Choose a reason for hiding this comment

polina-c Aug 10, 2023 • edited Loading

Choose a reason for hiding this comment

devoncarew left a comment

Choose a reason for hiding this comment

devoncarew Aug 10, 2023

Choose a reason for hiding this comment

devoncarew Aug 10, 2023

Choose a reason for hiding this comment

polina-c Aug 10, 2023

Choose a reason for hiding this comment

devoncarew Aug 10, 2023

Choose a reason for hiding this comment

polina-c commented Aug 10, 2023

devoncarew commented Aug 11, 2023

polina-c commented Aug 8, 2023 •

edited

Loading

polina-c Aug 10, 2023 •

edited

Loading