Allow the --update-on-path flag to be passed to the dt sync command (#9212)

Author: kenzieschmoll

CONTRIBUTING.md

@@ -100,9 +100,9 @@ of launch configurations for running and debugging DevTools:
 
 ### Workflow for making changes
 
-1. Change your local Flutter SDK to the latest flutter candidate branch:
+1. Ensure your local Flutter SDK, DevTools dependencies, and generated code are up-to-date:
 	```sh
-	dt update-flutter-sdk --update-on-path
+	dt sync --update-on-path
 	```
 	> Warning: this will delete any local changes in your Flutter SDK you checked out from git.
 
@@ -111,23 +111,18 @@ of launch configurations for running and debugging DevTools:
 	git checkout -b myBranch
 	```
 
-3. Ensure your branch, dependencies, and generated code are up-to-date:
-	```sh
-	dt sync
-	```
-
-4. Implement your changes, and commit to your branch:
+3. Implement your changes, and commit to your branch:
 	```sh
 	git commit -m “description”
 	```
 	If your improvement is user-facing, [document it](packages/devtools_app/release_notes/README.md) in the same PR.
 
-5. Push to your branch to GitHub:
+4. Push to your branch to GitHub:
 	```sh
 	git push origin myBranch
 	```
 
-6. Navigate to the [Pull Requests](https://github.com/flutter/devtools/pulls) tab in the main
+5. Navigate to the [Pull Requests](https://github.com/flutter/devtools/pulls) tab in the main
 [DevTools repo](https://github.com/flutter/devtools). You should see a popup to create a pull
 request from the branch in your cloned repo to the DevTools `master` branch. Create a pull request.
 
@@ -137,9 +132,18 @@ request from the branch in your cloned repo to the DevTools `master` branch. Cre
 	```
 	dt sync
 	```
-	This will pull the latest code from the upstream DevTools, upgrade dependencies, and perform code generation.
-
-- If you want to upgrade dependencies and re-generate code (like mocks), but do not want to merge `upstream/master`, instead run
+	This command will:
+	- pull the latest code from the upstream DevTools master branch
+	- update `tool/flutter-sdk`	to the Flutter version DevTools is built and tested
+	with on the CI
+	- upgrade dependencies
+	- perform code generation
+
+	Optionally, pass the `--update-on-path` flag to also update your local Flutter SDK
+	git checkout along with the `tool/flutter-sdk`. 
+
+- If you want to upgrade dependencies and re-generate code (like mocks), but do
+not want to merge `upstream/master` or update your Flutter SDK version, instead run
 	```
 	dt generate-code --upgrade
 	```

tool/lib/commands/shared.dart

@@ -52,6 +52,18 @@ extension BuildCommandArgsExtension on ArgParser {
     );
   }
 
+  void addUpdateOnPathFlag() {
+    addFlag(
+      SharedCommandArgs.updateOnPath.flagName,
+      negatable: false,
+      help:
+          'Update the Flutter SDK that is on PATH (your local '
+          'flutter/flutter git checkout). This flag is to be used in '
+          'combination with the ${SharedCommandArgs.updateFlutter.asArg()} '
+          'flag.',
+    );
+  }
+
   void addWasmFlag() {
     addFlag(
       SharedCommandArgs.wasm.flagName,
@@ -100,6 +112,7 @@ enum SharedCommandArgs {
   runApp('run-app'),
   serveWithDartSdk('serve-with-dart-sdk'),
   updateFlutter('update-flutter'),
+  updateOnPath('update-on-path'),
   updatePerfetto('update-perfetto');
 
   const SharedCommandArgs(this.flagName);

tool/lib/commands/sync.dart

@@ -6,8 +6,13 @@ import 'package:args/command_runner.dart';
 import 'package:io/io.dart';
 
 import '../utils.dart';
+import 'shared.dart';
 
 class SyncCommand extends Command {
+  SyncCommand() {
+    argParser.addUpdateOnPathFlag();
+  }
+
   @override
   String get name => 'sync';
 
@@ -21,7 +26,14 @@ class SyncCommand extends Command {
     await processManager.runProcess(
       CliCommand.git(['pull', 'upstream', 'master']),
     );
-    await processManager.runProcess(CliCommand.tool(['update-flutter-sdk']));
+    final updateOnPath =
+        argResults![SharedCommandArgs.updateOnPath.flagName] as bool;
+    await processManager.runProcess(
+      CliCommand.tool([
+        'update-flutter-sdk',
+        if (updateOnPath) SharedCommandArgs.updateOnPath.asArg(),
+      ]),
+    );
     await processManager.runProcess(
       CliCommand.tool(['generate-code', '--upgrade']),
     );

tool/lib/commands/update_flutter_sdk.dart

@@ -10,48 +10,24 @@ import 'package:devtools_tool/model.dart';
 import 'package:io/io.dart';
 
 import '../utils.dart';
-
-const _updateOnPath = 'update-on-path';
-const _useCacheFlag = 'use-cache';
+import 'shared.dart';
 
 final _flutterPreReleaseTagRegExp = RegExp(r'[0-9]+.[0-9]+.0-[0-9]+.0.pre');
 
 /// This command updates the the Flutter SDK contained in the 'tool/' directory
-/// to the latest Flutter candidate branch.
-///
-/// When the '--from-path' flag is passed, the Flutter SDK that is on PATH (your
-/// local flutter/flutter git checkout) will be updated as well.
+/// to the latest Flutter candidate branch, as specified by the commit hash in
+/// the flutter-candidate.txt file in the repository root.
 ///
-/// This command will use the Flutter version from the 'flutter-candidate.txt'
-/// file in the repository root, unless the '--no-use-cache' flag is passed,
-/// in which case it will run the 'tool/latest_flutter_candidate.sh' script to
-/// fetch the latest version from upstream.
-///
-/// The version from 'flutter-candidate.txt' should be identical most of the
-/// time since the GitHub workflow that updates this file runs twice per day.
+/// When the '--update-on-path' flag is passed, the Flutter SDK that is on PATH
+/// (your local flutter/flutter git checkout) will be updated as well.
 ///
 /// To run this script:
-/// `dt update-flutter-sdk [--from-path] [--no-use-cache]`
+/// `dt update-flutter-sdk [--update-on-path]`
 class UpdateFlutterSdkCommand extends Command {
   UpdateFlutterSdkCommand() {
-    argParser
-      ..addFlag(
-        _updateOnPath,
-        negatable: false,
-        help:
-            'Also update the Flutter SDK that is on PATH (your local '
-            'flutter/flutter git checkout)',
-      )
-      ..addFlag(
-        _useCacheFlag,
-        negatable: true,
-        defaultsTo: true,
-        help:
-            'Update the Flutter SDK(s) to the cached Flutter version stored '
-            'in "flutter-candidate.txt" instead of the latest version at '
-            '"https://flutter.googlesource.com/mirrors/flutter/"',
-      );
+    argParser.addUpdateOnPathFlag();
   }
+
   @override
   String get name => 'update-flutter-sdk';
 
@@ -63,49 +39,22 @@ class UpdateFlutterSdkCommand extends Command {
 
   @override
   Future run() async {
-    final updateOnPath = argResults![_updateOnPath] as bool;
-    final useCachedVersion = argResults![_useCacheFlag] as bool;
+    final updateOnPath =
+        argResults![SharedCommandArgs.updateOnPath.flagName] as bool;
     final log = Logger.standard();
-
-    // TODO(kenz): we can remove this if we can rewrite the
-    // 'latest_flutter_candidate.sh' script as a Dart script, or if we instead
-    // duplicate it as a Windows script (we may need this to be a non-Dart
-    // script for execution on the bots before we have a Dart SDK available).
-    if (Platform.isWindows && !useCachedVersion) {
-      log.stderr(
-        'On windows, you can only use the cached Flutter version from '
-        '"flutter-candidate.txt". Please remove the "--no-use-cache" flag and '
-        'try again.',
-      );
-      return 1;
-    }
-
     final repo = DevToolsRepo.getInstance();
     final processManager = ProcessManager();
 
     final String? flutterVersion;
-
-    if (useCachedVersion) {
-      final versionStr =
-          repo.readFile(Uri.parse('flutter-candidate.txt')).trim();
-      // If the version string doesn't match the expected pattern for a
-      // pre-release tag, then assume it's a commit hash:
-      flutterVersion =
-          _flutterPreReleaseTagRegExp.hasMatch(versionStr)
-              ? 'tags/$versionStr'
-              : versionStr;
-    } else {
-      flutterVersion =
-          (await processManager.runProcess(
-            CliCommand('sh', ['latest_flutter_candidate.sh']),
-            workingDirectory: repo.toolDirectoryPath,
-          )).stdout.replaceFirst('refs/', '').trim();
-    }
-
-    log.stdout(
-      'Updating to Flutter version '
-      '${useCachedVersion ? 'from cache' : 'from upstream'}: $flutterVersion',
-    );
+    final versionStr = repo.readFile(Uri.parse('flutter-candidate.txt')).trim();
+    // If the version string doesn't match the expected pattern for a
+    // pre-release tag, then assume it's a commit hash:
+    flutterVersion =
+        _flutterPreReleaseTagRegExp.hasMatch(versionStr)
+            ? 'tags/$versionStr'
+            : versionStr;
+
+    log.stdout('Updating to Flutter version from cache: $flutterVersion');
 
     final flutterSdkDirName = repo.sdkDirectoryName;
     final toolSdkPath = repo.toolFlutterSdkPath;