Skip to content

[flutter_tools] Make variants of Pub have consistent method signatures #98119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
fluttergithubbot merged 1 commit into from
Feb 11, 2022
Merged

[flutter_tools] Make variants of Pub have consistent method signatures #98119

fluttergithubbot merged 1 commit into from
Feb 11, 2022

Conversation

@swift-kim
Copy link
Contributor

@swift-kim swift-kim commented Feb 9, 2022

The abstract class Pub and its implementations (_DefaultPub, ThrowingPub, and etc.) have slightly different method signatures. For example, _DefaultPub.batch allows null directory paths while Pub.batch doesn't (this is grammatically correct because Pub is an abstract class):

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

Lines 122 to 130 in c54a27d

Future<void> batch(
List<String> arguments, {
required PubContext context,
String directory,
MessageFilter filter,
String failureMessage = 'pub failed',
required bool retry,
bool showTraceForErrors,
});

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

Lines 300 to 309 in c54a27d

Future<void> batch(
List<String> arguments, {
required PubContext context,
String? directory,
MessageFilter? filter,
String failureMessage = 'pub failed',
required bool retry,
bool? showTraceForErrors,
String? flutterRootOverride,
}) async {

This discrepancy has been caused by manual null safety migration in #80548 and seems to be a simple human error.

This change doesn't fix any existing error, and also doesn't change the tool's behavior, so there should be no need for tests.

cc @jmagman

@flutter-dashboard
Copy link

flutter-dashboard bot commented Feb 9, 2022

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat (don't just cc him here, he won't see it! He's on Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

@flutter-dashboard flutter-dashboard bot added the tool Affects the "flutter" command-line tool. See also t: labels. label Feb 9, 2022
jmagman
jmagman approved these changes Feb 9, 2022
View reviewed changes
Copy link
Member

@jmagman jmagman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@jmagman
Copy link
Member

jmagman commented Feb 9, 2022 •
edited
Loading

Adding second reviewer @christopherfujino

@christopherfujino
Copy link
Contributor

christopherfujino commented Feb 10, 2022

I'm surprised an implementing class can override a method with a more loose (i.e. nullable) argument type. In any case, nice catch.

christopherfujino
christopherfujino approved these changes Feb 10, 2022
View reviewed changes
Copy link
Contributor

@christopherfujino christopherfujino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@fluttergithubbot fluttergithubbot merged commit 2a010d9 into flutter:master Feb 11, 2022
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 11, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 11, 2022
@engine-flutter-autoroll
2a010d9 [flutter_tools] Make variants of Pub have consistent method s…
d6f4237 
…ignatures (flutter/flutter#98119)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 11, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 11, 2022
@engine-flutter-autoroll
2a010d9 [flutter_tools] Make variants of Pub have consistent method s…
f91ef40 
…ignatures (flutter/flutter#98119)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 11, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 11, 2022
@engine-flutter-autoroll
2a010d9 [flutter_tools] Make variants of Pub have consistent method s…
8f6a323 
…ignatures (flutter/flutter#98119)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 11, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Feb 11, 2022
@engine-flutter-autoroll
2a010d9 [flutter_tools] Make variants of Pub have consistent method s…
f005f7e 
…ignatures (flutter/flutter#98119)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 11, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 11, 2022
@engine-flutter-autoroll
2a010d9 [flutter_tools] Make variants of Pub have consistent method s…
820293f 
…ignatures (flutter/flutter#98119)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 11, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Feb 11, 2022
@engine-flutter-autoroll
2a010d9 [flutter_tools] Make variants of Pub have consistent method s…
c78a960 
…ignatures (flutter/flutter#98119)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 11, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 11, 2022
@engine-flutter-autoroll
2a010d9 [flutter_tools] Make variants of Pub have consistent method s…
2ab9a01 
…ignatures (flutter/flutter#98119)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 11, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Feb 11, 2022
@engine-flutter-autoroll
2a010d9 [flutter_tools] Make variants of Pub have consistent method s…
e457395 
…ignatures (flutter/flutter#98119)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 11, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 11, 2022
@engine-flutter-autoroll
2a010d9 [flutter_tools] Make variants of Pub have consistent method s…
84c9e32 
…ignatures (flutter/flutter#98119)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 11, 2022
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Feb 11, 2022
@engine-flutter-autoroll
2a010d9 [flutter_tools] Make variants of Pub have consistent method s…
376d64b 
…ignatures (flutter/flutter#98119)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 11, 2022
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 11, 2022
@engine-flutter-autoroll
2a010d9 [flutter_tools] Make variants of Pub have consistent method s…
051b233 
…ignatures (flutter/flutter#98119)
clocksmith pushed a commit to clocksmith/flutter that referenced this pull request Mar 8, 2022
@swift-kim @clocksmith
[flutter_tools] Make variants of Pub have consistent method signatures (
03a4d8b 
flutter#98119)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jmagman jmagman jmagman approved these changes

+1 more reviewer

@christopherfujino christopherfujino christopherfujino approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

tool Affects the "flutter" command-line tool. See also t: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@swift-kim @jmagman @christopherfujino @fluttergithubbot