[flutter_tool] New command project #102118

Jasguerrero · 2022-04-18T23:41:57Z

#2885

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.

packages/flutter_tools/lib/src/analyze_project.dart

packages/flutter_tools/lib/executable.dart

packages/flutter_tools/lib/src/analyze_project.dart

packages/flutter_tools/lib/src/analyze_project_validator.dart

christopherfujino · 2022-04-19T23:33:43Z

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

+        break;
+    }
+
+    buffer.write('$icon ${result.toString()}');


nit. .toString() is unneeded, the default behavior of interpolating a non-string into a string is to call .toString() on it anyway

Suggested change

buffer.write('$icon ${result.toString()}');

buffer.write('$icon $result');

christopherfujino · 2022-04-19T23:35:24Z

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

+
+  @override
+  Future<FlutterCommandResult> runCommand() async {
+    globals.flutterVersion.fetchTagsAndUpdate();


why is this needed?

No need. will delete it next commit

christopherfujino · 2022-04-19T23:35:55Z

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

+  Future<FlutterCommandResult> runCommand() async {
+    globals.flutterVersion.fetchTagsAndUpdate();
+
+    Directory workingDirectory;


nit. prefer final and you can replace the if/else with a ternary

christopherfujino · 2022-04-19T23:36:14Z

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

+  }
+
+  void presentResults(final List<ProjectValidatorResult> results) {
+    StringBuffer buffer = StringBuffer();


this can be final

christopherfujino · 2022-04-19T23:36:47Z

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

+    for (ProjectValidatorResult result in results) {
+      addToBufferResult(result, buffer);
+      buffer.write('\n');
+      globals.logger.printBox(buffer.toString());


Shouldn't you be printing the buffer outside of the for loop?

If this is a bug, can you write a test that would have caught it (for example, hard-code the expected logger output, so that we can see what it should look like)? Add it to packages/flutter_tools/test/commands.shard/hermetic/analyze_project_test.dart

Yes. It should be outside, adding a test is a good idea

christopherfujino · 2022-04-20T22:09:00Z

packages/flutter_tools/lib/src/analyze_project.dart

+  final String name;
+  final String value;
+  final String? warning;
+  final StatusProjectValidator _status;


might as well make this public and get rid of the getter.

christopherfujino · 2022-04-20T22:09:12Z

packages/flutter_tools/lib/src/analyze_project.dart

+
+class ProjectValidatorResult {
+
+  ProjectValidatorResult(this.name, this.value, this._status, {this.warning});


nit. prefer named parameters when you have more than 2

also, this constructor can be made const

christopherfujino · 2022-04-20T22:10:06Z

packages/flutter_tools/lib/src/analyze_project_validator.dart

+}
+
+const List <ProjectValidator> allProjectValidators = [
+  // add validators


Suggested change

// add validators

// TODO(jsguerrero): add validators

christopherfujino · 2022-04-20T22:10:58Z

packages/flutter_tools/lib/src/analyze_project_validator.dart

+import 'analyze_project.dart';
+import 'project.dart';
+
+abstract class ProjectValidator {


Can you add dartdoc's for all the new classes you add, and any non-obvious methods? (for example .supportsProject is self-explanatory)

christopherfujino · 2022-04-20T22:11:27Z

packages/flutter_tools/lib/src/analyze_project_validator.dart

+  Future<List<ProjectValidatorResult>> start(FlutterProject project);
+}
+
+const List <ProjectValidator> allProjectValidators = [


nit. make this a static on the ProjectValidator class. Static's are essentially global like this; however, it's a little more organized.

christopherfujino · 2022-04-20T22:12:49Z

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

+import '../runner/flutter_command.dart';
+
+class ValidateProjectCommand extends FlutterCommand {
+  ValidateProjectCommand(this.fileSystem, this.logger, {this.verbose = false});


nit use named parameters when you have more than 2

christopherfujino · 2022-04-20T22:16:39Z

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

+    String icon;
+    switch(result.status) {
+      case StatusProjectValidator.error:
+        icon = '[X]';


We should be consistent with the doctor and use this unicode character: https://github.com/flutter/flutter/blob/master/packages/flutter_tools/lib/src/doctor_validator.dart#L258

christopherfujino · 2022-04-20T22:17:55Z

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

+        break;
+    }
+
+    buffer.write('$icon $result');


if you call buffer.writeln() here you don't need to print an extra newline in the above scope (line 53).

Suggested change

buffer.write('$icon $result');

buffer.writeln('$icon $result');

christopherfujino · 2022-04-20T22:20:25Z

packages/flutter_tools/lib/src/analyze_project.dart

+
+  @override
+  String toString() {
+    if (_status == StatusProjectValidator.error) {


if you are returning early, you can un-nest the conditionals to make reading this easier:

if (_status == StatusProjectValidator.error) { return 'Error: $value'; } if (warning != null) { return '$name: $value (warning: $warning)'; } return '$name: $value';

christopherfujino · 2022-04-20T22:22:37Z

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

+
+    for (final ProjectValidator validator in allProjectValidators) {
+      if (!ranValidators.contains(validator) && validator.supportsProject(project)) {
+        results.addAll(await validator.start(project));


do we need to await one before starting the next, or are these safe to run concurrently?

christopherfujino · 2022-04-20T22:24:15Z

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

+
+    for (final ProjectValidator validator in allProjectValidators) {
+      if (!ranValidators.contains(validator) && validator.supportsProject(project)) {
+        results.addAll(await validator.start(project));


Also, can we use a spinner like in the doctor, so that the user knows the tool is still running?

https://github.com/flutter/flutter/blob/master/packages/flutter_tools/lib/src/doctor.dart#L341

Also maybe we should catch exceptions and mark them as crashed, as we do in the doctor: https://github.com/flutter/flutter/blob/master/packages/flutter_tools/lib/src/doctor.dart#L350

christopherfujino · 2022-04-20T22:28:51Z

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

+  }
+
+  void addToBufferResult(ProjectValidatorResult result, StringBuffer buffer) {
+    String icon;


i think you can mark this as final

Suggested change

String icon;

final String icon;

christopherfujino

This is coming along great. Just a few nits.

christopherfujino · 2022-04-27T16:30:06Z

packages/flutter_tools/test/commands.shard/hermetic/project_validator_test.dart

+  FileSystem fileSystem;
+
+  group('analyze project command', () {
+    setUpAll(() {


Don't re-use the same filesystem between tests

Suggested change

setUpAll(() {

setUp(() {

christopherfujino · 2022-04-27T16:30:46Z

packages/flutter_tools/test/commands.shard/hermetic/project_validator_test.dart

+}
+
+void main() {
+  final BufferLogger loggerTest = BufferLogger.test();


I'm thinking you probably shouldn't re-use the logger between tests?

christopherfujino · 2022-04-27T16:32:07Z

packages/flutter_tools/test/commands.shard/hermetic/project_validator_test.dart

+          '│ [✓] pass: value                          │\n'
+          '│ [✗] Error: my error                      │\n'
+          '│ [!] pass two: pass (warning: my warning) │\n'
+          '│                                          │\n'


Can we get rid of this extra line?

christopherfujino · 2022-04-27T16:37:23Z

packages/flutter_tools/lib/src/project_validator.dart

+  /// Can return more than one result in case a file/command have a lot of info to share to the user
+  Future<List<ProjectValidatorResult>> start(FlutterProject project);
+  /// new ProjectValidators should be added here for the ValidateProjectCommand to run
+  static List <ProjectValidator> allProjectValidators = <ProjectValidator>[


Suggested change

static List <ProjectValidator> allProjectValidators = <ProjectValidator>[

static const List <ProjectValidator> allProjectValidators = <ProjectValidator>[

packages/flutter_tools/test/commands.shard/hermetic/project_validator_test.dart

…jectValidator

christopherfujino · 2022-04-29T19:41:32Z

packages/flutter_tools/lib/executable.dart

@@ -146,6 +148,12 @@ List<FlutterCommand> generateCommands({
    terminal: globals.terminal,
    artifacts: globals.artifacts,
  ),
+  ValidateProjectCommand(


I don't think we should add this until it's ready to be used.

christopherfujino

LGTM!

fluttergithubbot · 2022-04-30T00:39:07Z

This pull request is not suitable for automatic merging in its current state.

The status or check suite Windows tool_integration_tests_2_6 has failed. Please fix the issues identified (or deflake) before re-applying this label.

flutter-dashboard bot added the tool Affects the "flutter" command-line tool. See also t: labels. label Apr 18, 2022

Jasguerrero marked this pull request as ready for review April 19, 2022 16:32

Jasguerrero requested a review from christopherfujino April 19, 2022 16:32

christopherfujino suggested changes Apr 19, 2022

View reviewed changes

christopherfujino reviewed Apr 20, 2022

View reviewed changes

Jasguerrero requested a review from christopherfujino April 21, 2022 21:59

christopherfujino reviewed Apr 27, 2022

View reviewed changes

Jasguerrero requested a review from christopherfujino April 27, 2022 19:48

christopherfujino reviewed Apr 27, 2022

View reviewed changes

packages/flutter_tools/test/commands.shard/hermetic/project_validator_test.dart Show resolved Hide resolved

Jasguerrero added 10 commits April 29, 2022 10:44

flutter command boiler plate

9a85c67

project validator result flutter#2885

24493de

test ProjectValidatorResult flutter#2885

caefd32

ProjectValidator absctract class flutter#2885

a9a68a5

get path from from user flutter#2885

7e76b6a

test validator task dummy flutter#2885

0f47acb

rename validate command project class flutter#2885

6d09663

refactor analyze project result to avoid mutable properties flutter#2885

36dc120

rename ProjectValidatorTask -> ProjectValidator flutter#2885

8c04cd8

remove AvailableProjectValidators clss and pass the logic to each Pro…

39c09fe

…jectValidator

Jasguerrero added 11 commits April 29, 2022 10:44

add dart doc to allProjectValidators variable

80d1b74

rename analyze_project file names

2b3a955

rename test files

2fb33d9

fix test file name

3cec3ba

executable edit to a relative import

f27e270

fix analyze suggestions

98d4733

prefer_initializing_formals

9f1239f

add new validator to tests

e571693

remove unused imports

a8307ed

add title to ProjectValidator

22d046d

add title to output result

e0e74b6

Jasguerrero requested review from Piinks and keyonghan as code owners April 29, 2022 17:48

Jasguerrero force-pushed the new_command_project branch from ccc923e to e0e74b6 Compare April 29, 2022 17:54

Jasguerrero removed request for Piinks and keyonghan April 29, 2022 17:55

christopherfujino reviewed Apr 29, 2022

View reviewed changes

remove command from executables

45b60ca

christopherfujino approved these changes Apr 29, 2022

View reviewed changes

remove unused imports

fbb97f9

Jasguerrero added the waiting for tree to go green label Apr 29, 2022

fluttergithubbot removed the waiting for tree to go green label Apr 30, 2022

Jasguerrero added the waiting for tree to go green label Apr 30, 2022

fluttergithubbot merged commit 780a6c4 into flutter:master Apr 30, 2022

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

Roll Flutter from 2bac06e73e51 to 780a6c422bab (1 revision) flutter/packages#1684

Merged

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

780a6c4 [flutter_tool] New command project (flutter/flutter#102118)

a2bdfa0

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

Roll Flutter from 0b3c5d1228f1 to fa519eb22fe3 (15 revisions) flutter/plugins#5451

Merged

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

780a6c4 [flutter_tool] New command project (flutter/flutter#102118)

65bd99e

egramond pushed a commit to egramond/flutter that referenced this pull request May 5, 2022

[flutter_tool] New command project (flutter#102118)

0f7e59e

	buffer.write('$icon ${result.toString()}');
	buffer.write('$icon $result');


		class ProjectValidatorResult {

		ProjectValidatorResult(this.name, this.value, this._status, {this.warning});

	buffer.write('$icon $result');
	buffer.writeln('$icon $result');

	static List <ProjectValidator> allProjectValidators = <ProjectValidator>[
	static const List <ProjectValidator> allProjectValidators = <ProjectValidator>[

[flutter_tool] New command project #102118

[flutter_tool] New command project #102118

Uh oh!

Conversation

Jasguerrero commented Apr 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

christopherfujino Apr 20, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

christopherfujino Apr 20, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

christopherfujino Apr 20, 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!

Choose a reason for hiding this comment

Uh oh!

christopherfujino left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

christopherfujino left a comment

Choose a reason for hiding this comment

Uh oh!

fluttergithubbot commented Apr 30, 2022

Jasguerrero commented Apr 18, 2022 •

edited

Loading

christopherfujino Apr 20, 2022 •

edited

Loading

christopherfujino Apr 20, 2022 •

edited

Loading

christopherfujino Apr 20, 2022 •

edited

Loading