Show output from `pub get` in `flutter pub get` #106300

sigurdm · 2022-06-20T14:30:16Z

dart pub get has detailed output about outdated dependencies. This is currently not exposed from flutter pub get.

We are missing out on at least this information:

newer version available
package obsolete
version retracted
known vulnerability (planned)

Before:

> flutter pub get
Running "flutter pub get" in sensors_plus...                     1,691ms
Warning: You are using these overridden dependencies:
! sensors_plus_platform_interface 1.1.1 from path ../../sensors_plus_platform_interface
! sensors_plus_web 1.1.1 from path ../../sensors_plus_web
Running "flutter pub get" in example...                          1,019ms

Note how the warnings output really belongs to the resolution from the example.

After:

> flutter pub get
Running "flutter pub get" in sensors_plus...                     1,803ms
Resolving dependencies...
  matcher 0.12.11 (0.12.12 available)
  test 1.21.1 (1.21.2 available)
  test_api 0.4.9 (0.4.10 available)
  test_core 0.4.13 (0.4.14 available)
  vm_service 8.3.0 (9.0.0 available)
Got dependencies!
Resolving dependencies in ./example...
Got dependencies in ./example.

This PR also uses pub get --example (implemented here) to resolve in './example' if it exists.

Now the output from resolution in ./example is reduced as long as there are no errors.

Because flutter pub get will retry pub get until successful the output of each run is recorded, and only the output of the last run is shown.

Fix: a small bug where flutter create for some templates would invoke pub even if given a --no-pub argument.

Cleanup: pub get will no longer be invoked with --no-precompile (that is now default).

Output from pub get is also show when doing flutter create - that might be distracting - maybe we should turn that off:

> flutter create test_plugin -tplugin
Creating project test_plugin...
Running "flutter pub get" in test_plugin...                      1,931ms
Resolving dependencies in test_plugin...
+ async 2.9.0
+ boolean_selector 2.1.0
+ characters 1.2.1
+ clock 1.1.1
+ collection 1.16.0
+ fake_async 1.3.1
+ flutter 0.0.0 from sdk flutter
+ flutter_lints 2.0.1
+ flutter_test 0.0.0 from sdk flutter
+ lints 2.0.0
+ matcher 0.12.11 (0.12.12 available)
+ material_color_utilities 0.1.5
+ meta 1.8.0
+ path 1.8.2
+ plugin_platform_interface 2.1.2
+ sky_engine 0.0.99 from sdk flutter
+ source_span 1.9.0
+ stack_trace 1.10.0
+ stream_channel 2.1.0
+ string_scanner 1.1.1
+ term_glyph 1.2.1
+ test_api 0.4.9 (0.4.10 available)
+ vector_math 2.1.2
Changed 23 dependencies in test_plugin!
Resolving dependencies in test_plugin/example...
Got dependencies in test_plugin/example.
Wrote 25 files.

All done!

Your plugin code is in test_plugin/lib/test_plugin.dart.

Your example app code is in test_plugin/example/lib/main.dart.


You've created a plugin project that doesn't yet support any platforms.


To add platforms, run `flutter create -t plugin --platforms <platforms> .` under test_plugin.
For more information, see https://flutter.dev/go/plugin-platforms.

Also includes color in the pub terminal output (depending on the flutter terminal color detection):

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

christopherfujino · 2022-06-28T18:34:09Z

@sigurdm is this ready for review? (it's marked a draft, but maybe that was by accident?)

sigurdm · 2022-06-30T14:04:27Z

@sigurdm is this ready for review? (it's marked a draft, but maybe that was by accident?)

Yeah - I marked it as draft until I added the color-handling - but I think it should be good now.

christopherfujino · 2022-07-07T23:45:37Z

packages/flutter_tools/lib/src/commands/create.dart

+    final bool includeWindows;
+    if (template == FlutterProjectType.module) {
+      // The module template only supports iOS and Android.
+      includeIos = true;


should we still check if platforms.contains('ios') (and ditto for android)?

We could - but it would change the current behaviour: https://github.com/flutter/flutter/pull/106300/files#diff-fa49e752dc7aba132fcab72c29e71c50541d612363171837a4658e0317fb7c9aL457

christopherfujino · 2022-07-07T23:58:03Z

packages/flutter_tools/lib/src/commands/create.dart

        break;
    }
+
+    if (boolArgDeprecated('pub')) {


These commands are hard to read--can you explain why you're adding this here?

Oh, did this used to be called earlier in the _generateModule() and such helper functions?

Yes this is moved from the helper-functions.

packages/flutter_tools/lib/src/commands/packages.dart

christopherfujino · 2022-07-08T00:08:18Z

packages/flutter_tools/lib/src/dart/pub.dart

+    }
+  }
+
+  Future<void> _runWithRetries(


What's the difference between this and batch()?

runWithRetries will retry the command as long as the exit code is _kPubExitCodeUnavailable the and print the output of the last run.

batch will show only the last line of the output. Run only a single run.

I wanted to get rid of batch but it has a few call-sites that I didn't want to touch in this PR:

flutter/packages/flutter_tools/lib/src/commands/update_packages.dart

Line 422 in 6704dfc

await pub.batch(

flutter/packages/flutter_tools/lib/src/commands/packages.dart

Line 211 in 6704dfc

await pub.batch(<String>['run', 'test', ...argResults!.rest], context: PubContext.runTest);

But looking at these it seems I can simplify batch even more None of those call sites do version solving (they to run test and deps)

I simplified batch and added documentation to _runWithRetries.

sigurdm · 2022-07-08T12:15:16Z

I'm going on 3 weeks vacation today. So don't expect responses before that.

christopherfujino · 2022-07-28T20:35:19Z

cc @Jasguerrero

sigurdm · 2022-08-25T14:16:08Z

I've rebased this, could you take another look?

christopherfujino

code LGTM, although you have some failing tests.

sigurdm · 2022-08-26T14:32:54Z

Fixed the test, had to hack the analyze_snippets_code.dart tool a bit.

There was also a bug if the example folder existed but had no pubspec.yaml - fixed that.

christopherfujino · 2022-08-26T16:15:04Z

Fixed the test, had to hack the analyze_snippets_code.dart tool a bit.

There was also a bug if the example folder existed but had no pubspec.yaml - fixed that.

thanks! when you're ready to merge, you can add the autosubmit label and the bot will merge when the tree is green.

This reverts commit 3802eb6.

…ter#106300)

…110478) This reverts commit 3802eb6.

…ter#106300)

…ter#106300)" (flutter#110478)" This reverts commit 0e195e9.

sigurdm added 3 commits June 20, 2022 07:26

Use output from pub in flutter pub get

271395f

merge to master

1e2ec47

WIP

188cba6

flutter-dashboard bot added a: text input Entering text in a text field or keyboard related problems tool Affects the "flutter" command-line tool. See also t: labels. labels Jun 20, 2022

sigurdm marked this pull request as draft June 20, 2022 14:30

sigurdm requested review from christopherfujino and jonahwilliams June 20, 2022 14:30

sigurdm added 5 commits June 23, 2022 11:37

Merge remote-tracking branch 'origin/master' into pub_get_output

1a10c02

Use color output if terminal supports it

36b6432

Merge

6704dfc

Add type annotation

db28008

Implement AppRunLogger.supportsColor

4dbce1d

sigurdm closed this Jun 30, 2022

sigurdm reopened this Jun 30, 2022

sigurdm marked this pull request as ready for review June 30, 2022 14:03

sigurdm mentioned this pull request Jul 4, 2022

[flutter_tools] stop using dart pub __deprecated_pub #106969

Closed

christopherfujino reviewed Jul 7, 2022

View reviewed changes

christopherfujino reviewed Jul 8, 2022

View reviewed changes

packages/flutter_tools/lib/src/commands/packages.dart Show resolved Hide resolved

christopherfujino reviewed Jul 8, 2022

View reviewed changes

packages/flutter_tools/lib/src/commands/packages.dart Show resolved Hide resolved

christopherfujino reviewed Jul 8, 2022

View reviewed changes

sigurdm added 2 commits July 8, 2022 07:57

Simplify batch

53d4055

Improve docs

2f072c7

sigurdm mentioned this pull request Aug 2, 2022

Incorrect colored output in the "outdated" command dart-lang/pub#3459

Closed

Merge with upstream

50069c5

Fix lints

01f63a6

sigurdm closed this Aug 25, 2022

sigurdm reopened this Aug 25, 2022

sigurdm added 2 commits August 25, 2022 13:05

Merge remote-tracking branch 'origin/master' into pub_get_output

6d7af54

Fix new test

6bf560b

christopherfujino approved these changes Aug 25, 2022

View reviewed changes

sigurdm added 6 commits August 26, 2022 12:01

Fix analyze_snipped_code.dart tool

08c085b

output debug trace

dab15aa

Remove debug info

17a6c81

Only call _updatePackageConfig in example/ if it has a pubspec.yaml.

114d160

remove recipes committed by mistake

a5052aa

And a recommit

9acf615

sigurdm added the autosubmit Merge PR when tree becomes green via auto submit App label Aug 29, 2022

auto-submit bot merged commit 3802eb6 into flutter:master Aug 29, 2022

zanderso added a commit that referenced this pull request Aug 29, 2022

Revert "Show output from pub get in flutter pub get (#106300)"

03f51ed

This reverts commit 3802eb6.

zanderso mentioned this pull request Aug 29, 2022

Revert "Show output from pub get in flutter pub get" #110478

Merged

engine-flutter-autoroll mentioned this pull request Aug 29, 2022

Roll Flutter from 041c3af53209 to 5848306e3784 (8 revisions) flutter/plugins#6333

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 29, 2022

3802eb6 Show output from pub get in flutter pub get (flutter/flut…

7e23eb4

…ter#106300)

zanderso added a commit that referenced this pull request Aug 29, 2022

Revert "Show output from pub get in flutter pub get (#106300)" (#…

0e195e9

…110478) This reverts commit 3802eb6.

engine-flutter-autoroll mentioned this pull request Aug 30, 2022

Roll Flutter from f66a09791920 to dfcd9650e36b (26 revisions) flutter/packages#2529

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 30, 2022

3802eb6 Show output from pub get in flutter pub get (flutter/flut…

637b917

…ter#106300)

engine-flutter-autoroll mentioned this pull request Aug 30, 2022

Roll Flutter from f66a09791920 to 2ed99fb70d08 (27 revisions) flutter/packages#2530

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 30, 2022

3802eb6 Show output from pub get in flutter pub get (flutter/flut…

481811a

…ter#106300)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 1, 2022

3802eb6 Show output from pub get in flutter pub get (flutter/flut…

dd3d5a5

…ter#106300)

sigurdm mentioned this pull request Sep 2, 2022

Reland: Show output from pub get in flutter pub get #110851

Merged

8 tasks

sigurdm added a commit to sigurdm/flutter that referenced this pull request Sep 2, 2022

Revert "Revert "Show output from pub get in flutter pub get (flut…

f68a9f8

…ter#106300)" (flutter#110478)" This reverts commit 0e195e9.

sigurdm mentioned this pull request Jun 1, 2023

The exit code 69 error message is not actionable dart-lang/pub#3923

Closed

Show output from pub get in flutter pub get #106300

Show output from pub get in flutter pub get #106300

Uh oh!

Conversation

sigurdm commented Jun 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

christopherfujino commented Jun 28, 2022

Uh oh!

sigurdm commented Jun 30, 2022

Uh oh!

christopherfujino Jul 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sigurdm Jul 8, 2022

Choose a reason for hiding this comment

Uh oh!

christopherfujino Jul 7, 2022

Choose a reason for hiding this comment

Uh oh!

christopherfujino Jul 7, 2022

Choose a reason for hiding this comment

Uh oh!

sigurdm Jul 8, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

christopherfujino Jul 8, 2022

Choose a reason for hiding this comment

Uh oh!

sigurdm Jul 8, 2022

Choose a reason for hiding this comment

Uh oh!

sigurdm commented Jul 8, 2022

Uh oh!

christopherfujino commented Jul 28, 2022

Uh oh!

sigurdm commented Aug 25, 2022

Uh oh!

christopherfujino left a comment

Choose a reason for hiding this comment

Uh oh!

sigurdm commented Aug 26, 2022

Uh oh!

christopherfujino commented Aug 26, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Show output from `pub get` in `flutter pub get` #106300

Show output from `pub get` in `flutter pub get` #106300

sigurdm commented Jun 20, 2022 •

edited

Loading

christopherfujino Jul 7, 2022 •

edited

Loading