tool/lib/commands/update_flutter_sdk.dart

// Copyright 2023 The Flutter Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file or at https://developers.google.com/open-source/licenses/bsd.

import 'dart:io';

import 'package:args/command_runner.dart';
import 'package:cli_util/cli_logging.dart';
import 'package:devtools_tool/model.dart';
import 'package:io/io.dart';

import '../utils.dart';

const _updateOnPath = 'update-on-path';
const _useCacheFlag = 'use-cache';

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.
///
/// 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.
///
/// To run this script:
/// `dt update-flutter-sdk [--from-path] [--no-use-cache]`
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/"',
      );
  }
  @override
  String get name => 'update-flutter-sdk';

  @override
  String get description =>
      'Updates the the Flutter SDK contained in the \'tool/\' directory to the '
      'latest Flutter candidate branch. Optionally, can also update the Flutter'
      'SDK that is on PATH (your local flutter/flutter git checkout).';

  @override
  Future run() async {
    final updateOnPath = argResults![_updateOnPath] as bool;
    final useCachedVersion = argResults![_useCacheFlag] 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 flutterSdkDirName = repo.sdkDirectoryName;
    final toolSdkPath = repo.toolFlutterSdkPath;

    // If the flag was set, update the SDK on PATH in addition to the
    // tool/flutter-sdk copy.
    if (updateOnPath) {
      final pathSdk = FlutterSdk.findFromPathEnvironmentVariable();
      log.stdout('Updating Flutter from PATH at ${pathSdk.sdkPath}');

      // Verify we have an upstream remote to pull from.
      await findRemote(
        processManager,
        remoteId: 'flutter/flutter.git',
        workingDirectory: pathSdk.sdkPath,
      );

      await processManager.runAll(
        commands: [
          CliCommand.git(['stash']),
          CliCommand.git(['fetch', 'upstream']),
          CliCommand.git(['checkout', 'upstream/master']),
          CliCommand.git(['reset', '--hard', 'upstream/master']),
          CliCommand.git(['checkout', flutterVersion, '-f']),
          CliCommand.flutter(['--version']),
        ],
        workingDirectory: pathSdk.sdkPath,
      );
      log.stdout('Finished updating Flutter from PATH at ${pathSdk.sdkPath}');
    }

    // Next, update (or clone) the tool/flutter-sdk copy.
    if (Directory(toolSdkPath).existsSync()) {
      log.stdout('Updating Flutter at $toolSdkPath');
      await processManager.runAll(
        commands: [
          CliCommand.git(['fetch']),
          CliCommand.git(['checkout', flutterVersion, '-f']),
          CliCommand.flutter(['--version']),
        ],
        workingDirectory: toolSdkPath,
      );
    } else {
      log.stdout('Cloning Flutter into $toolSdkPath');
      await processManager.runProcess(
        CliCommand.git([
          'clone',
          'https://github.com/flutter/flutter',
          flutterSdkDirName,
        ]),
        workingDirectory: repo.toolDirectoryPath,
      );
      await processManager.runAll(
        commands: [
          CliCommand.git(['checkout', flutterVersion, '-f']),
          CliCommand.flutter(['--version']),
        ],
        workingDirectory: toolSdkPath,
      );
    }
    log.stdout('Finished updating Flutter at $toolSdkPath.');
  }
}