Flutter migrate command #100284

GaryQian · 2022-03-17T07:45:22Z

Adds

flutter migrate start
flutter migrate abandon
flutter migrate apply
flutter migrate status

This feature includes the following sections:

migrate_compute.dart - performs the majority of the migration computation via the computeMigration function.
migrate_utils.dart - Utility and data classes that provide utility methods to access git and other bash/dos commands.
migrate_manifest - Data class that wraps a MigrateResult and represents the manifest that is output alongside the staged files
custom_merge.dart - Handles manually merging files with known structures to produce better results. The initial version only manually merges .metadata though this should be expanded to include pubspec.yaml and other commonly encountered known files.

skia-gold · 2022-03-22T05:41:28Z

Gold has detected about 1 new digest(s) on patchset 5.
View them at https://flutter-gold.skia.org/cl/github/100284

jmagman · 2022-04-05T20:49:27Z

packages/flutter_tools/lib/src/migrate/migrate_utils.dart

Can you just use systemTempDirectory.createTempSync as the rest of the tool does?

Ahh sure, didn't know about this utility!

christopherfujino · 2022-04-06T16:20:46Z

@GaryQian you have a validation error in your .ci.yaml that's causing none of the pre-submit checks to be scheduled: https://github.com/flutter/flutter/pull/100284/checks?check_run_id=5843295727

christopherfujino · 2022-04-06T16:21:11Z

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

can you link to an issue?

christopherfujino · 2022-04-06T16:23:03Z

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

I suggest also checking in this block if it exists; if it doesn't, the likely reason is a typo in the argument.

christopherfujino · 2022-04-06T16:24:20Z

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

I think we should be much more conservative and probably prompt for some user input unless --force was provided. Something like: `logger.printStatus('Are you sure you want to delete ${workingDirectory.absolute.path}?');

christopherfujino · 2022-04-06T16:24:32Z

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

We should handle this delete failing.

christopherfujino · 2022-04-06T16:33:24Z

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

Can you break up this line?

christopherfujino · 2022-04-06T16:33:58Z

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

Suggested change

logger.printStatus('No git repo found. Please run in a project with an initialized git repo or initialize one with:');

logger.printError('No git repo found. Please run in a project with an initialized git repo or initialize one with:');

christopherfujino · 2022-04-06T16:35:23Z

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

Same feedback as https://github.com/flutter/flutter/pull/100284/files#r844145326

christopherfujino · 2022-04-06T16:35:53Z

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

Suggested change

logger.printStatus('No migration in progress. Please run:');

logger.printError('No migration in progress. Please run:');

Here and throughout, if we're about to fail, we should log to STDERR

christopherfujino · 2022-04-06T16:37:56Z

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

Use printError, also we should log out where we checked, in case this was wrong.

christopherfujino · 2022-04-06T16:40:58Z

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

Log to STDERR here why we're failing. Also, I think we should log something if they had uncommitted changes and we're overriding with --force

christopherfujino · 2022-04-06T16:42:08Z

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

since this is verbose, should we list the files we're modifying?

christopherfujino · 2022-04-06T16:48:41Z

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

I'm pretty sure you don't need to actually track these in your Commands. Any time you want verbose logging, you can call logger.printTrace(), and it will only actually show in the logger if the logger in the context is verbose. See https://github.com/flutter/flutter/blob/master/packages/flutter_tools/lib/executable.dart#L126

blasten · 2022-04-19T01:47:51Z

I was trying to run the example app in https://github.com/mobiten/flutter_staggered_animations/tree/master/example, and it just doesn't compile because it requires:

Android embedding migration
Bump Gradle, AGP, and Kotlin versions
Set new compileSdkVersion, and ndkVersion.

I was curious about how the migration tool will work in this case.

GaryQian · 2022-04-20T07:09:06Z

We can't do the all of the v2 embedding migration for them, they will still have to migrate manually. The tool will do some of the more mundane v2 embedding migrations though such as add metadata.

Some of the things in (2) and (3) are handled as merge conflicts that will have to be manually resolved until we add smarter per-file custom merging, which the design allows to be modularly added in the future. If the files are not user modified though, we usually see clean bumps in versions.

flutter-dashboard · 2022-05-10T17:47:20Z

This pull request executed golden file tests, but it has not been updated in a while (20+ days). Test results from Gold expire after as many days, so this pull request will need to be updated with a fresh commit in order to get results from Gold.

For more guidance, visit Writing a golden file test for package:flutter.

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

GaryQian · 2022-05-26T01:00:24Z

Closing this as it has been superseded by #102598 and the individual PRs for each subcommand.

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

GaryQian changed the title ~~Flutter migrate command~~ [WIP] Flutter migrate command Mar 17, 2022

GaryQian added the work in progress; do not review label Mar 17, 2022

GaryQian force-pushed the migratecommand branch from 2c9c3bc to 68d06fd Compare March 22, 2022 05:26

This was referenced Mar 24, 2022

Flutter Migrate #95708

Closed

Flutter migrate #40460

Closed

GaryQian changed the title ~~[WIP] Flutter migrate command~~ Flutter migrate command Mar 29, 2022

GaryQian removed the work in progress; do not review label Mar 29, 2022

GaryQian requested a review from blasten March 30, 2022 02:39

zanderso requested review from christopherfujino, jmagman and zanderso April 4, 2022 22:05

GaryQian force-pushed the migratecommand branch from 93e0c15 to 67efa27 Compare April 5, 2022 00:12

jmagman reviewed Apr 5, 2022

View reviewed changes

christopherfujino reviewed Apr 6, 2022

View reviewed changes

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

Copy link

Contributor

christopherfujino Apr 6, 2022

Choose a reason for hiding this comment

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

can you link to an issue?

christopherfujino reviewed Apr 6, 2022

View reviewed changes

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

Copy link

Contributor

christopherfujino Apr 6, 2022

Choose a reason for hiding this comment

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

We should handle this delete failing.

christopherfujino reviewed Apr 6, 2022

View reviewed changes

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

Copy link

Contributor

christopherfujino Apr 6, 2022

Choose a reason for hiding this comment

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

Can you break up this line?

christopherfujino reviewed Apr 6, 2022

View reviewed changes

GaryQian force-pushed the migratecommand branch from 7602469 to 76aaf52 Compare April 12, 2022 09:20

GaryQian mentioned this pull request Apr 12, 2022

Migrate tool results on examples/hello_world #101791

Closed

GaryQian added 21 commits April 12, 2022 15:58

Add various flags, fix tests

6148e0c

Simplify show-diff flag

cfd5b3e

docs

0fc1baa

Analyzer

8a68c5c

Fix platforms flag

c33297a

Manifest write tests

dc81639

Edgecases

a4825ef

Migrate resolve-conflicts command

19780fb

Resolve conflicts tool improved UXi

bcca9bf

Platform white/black listing

a027a0a

typos

94e2093

Working project filter and default

8de0601

ïmproved status

7c2f1bd

Äddress comments

d7ce524

Improved resolve-conflicts command

1ea5029

Edge cases

ce53ea8

Fix edge case

312aa52

Add dependency upgrading

677294c

Dependency locking handling

48fbe54

Cleanup, more robust dependency lock checks

c759e96

Confirm before abandon, always migrate .metadata

1f65cd6

GaryQian force-pushed the migratecommand branch from 70ab156 to 1f65cd6 Compare April 13, 2022 19:03

GaryQian added 3 commits April 14, 2022 02:07

Remove unnecessary twoway merge catch

d9ce072

Remove globals dep and analyzer

a0e29fc

Docs for utils

142708d

GaryQian closed this May 26, 2022

	logger.printStatus('No git repo found. Please run in a project with an initialized git repo or initialize one with:');
	logger.printError('No git repo found. Please run in a project with an initialized git repo or initialize one with:');

	logger.printStatus('No migration in progress. Please run:');
	logger.printError('No migration in progress. Please run:');

Flutter migrate command #100284

Flutter migrate command #100284

Uh oh!

Conversation

GaryQian commented Mar 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

skia-gold commented Mar 22, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

christopherfujino commented Apr 6, 2022

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!

Choose a reason for hiding this comment

Uh oh!

blasten commented Apr 19, 2022

Uh oh!

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

Uh oh!

Uh oh!

flutter-dashboard bot commented May 10, 2022

Uh oh!

GaryQian commented May 26, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

GaryQian commented Mar 17, 2022 •

edited

Loading

GaryQian commented Apr 20, 2022 •

edited

Loading