From 7da1aa2a57b7f36a6cbacc8a656d348de4813a54 Mon Sep 17 00:00:00 2001
From: Greg Price <greg@zulip.com>
Date: Tue, 11 Jun 2024 17:01:15 -0700
Subject: [PATCH] tools/upgrade: Add first version of updating Flutter

This version leaves it to the user/developer to handle actually
upgrading their Flutter install to latest; but it takes care of
updating pubspec.yaml and pubspec.lock.

The upgrade of the actual Flutter install will presumably look
different anyway after #15 / #579, so we leave that to the future.
---
 README.md     |  7 ++---
 tools/upgrade | 81 +++++++++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 82 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 060ccdd540..c551fe7b7a 100644
--- a/README.md
+++ b/README.md
@@ -243,12 +243,11 @@ new PR merged that we particularly want to take.
 
 To update the version bounds:
 * Use `flutter upgrade` to upgrade your local Flutter and Dart.
-* Update the lower bounds at `environment` in `pubspec.yaml`
-  to the new versions, as seen in `flutter --version`.
-* Run `flutter pub get`, which will update `pubspec.lock`.
+* Run `tools/upgrade flutter-local`, which makes a commit updating
+  `pubspec.yaml` and `pubspec.lock` to match your local Flutter.
 * Make a quick check that things work: `tools/check`,
   and do a quick smoke-test of the app.
-* Commit and push the changes in `pubspec.yaml` and `pubspec.lock`.
+* Send the changes as a PR.
 
 
 ### Upgrading dependencies
diff --git a/tools/upgrade b/tools/upgrade
index a09ba38a68..2b5098dd57 100755
--- a/tools/upgrade
+++ b/tools/upgrade
@@ -20,7 +20,7 @@ usage: tools/upgrade [OPTION]... [STEP]...
 
 Upgrade our dependencies.
 
-By default, run all upgrade steps:
+By default, run the following upgrade steps:
   ${default_steps[*]}
 
 Each step produces a Git commit if there were any changes.
@@ -29,6 +29,12 @@ The steps are:
 
   pod         Upgrade CocoaPods pods.
 
+  flutter-local
+              Upgrade Flutter and its supporting libraries.
+              EXPERIMENTAL and not in the default list,
+              because it takes your current locally-installed version
+              rather than finding the latest.
+
   pub         Upgrade pub packages within the constraints expressed
               in pubspec.yaml, then upgrade pods to match.
 
@@ -50,7 +56,7 @@ while (( $# )); do
     case "$1" in
         --no-pod)
             opt_pod=; shift;;
-        pod|pub|pub-major)
+        pod|flutter-local|pub|pub-major)
             opt_steps+=("$1"); shift;;
         --help) usage; exit 0;;
         *) usage >&2; exit 2;;
@@ -139,6 +145,76 @@ deps: Update CocoaPods pods (tools/upgrade pod)
 "
 }
 
+upgrade_flutter_local() {
+    local pattern flutter_version_output flutter_version dart_sdk_version
+
+    check_no_uncommitted_or_untracked
+
+    # No check_pub_get_clean.  This operates on a `flutter` you've
+    # already locally upgraded, so if that happens to update any
+    # supporting libraries then it's expected that those will show up
+    # on `flutter pub get`.
+    # check_pub_get_clean
+
+    # TODO upgrade Flutter to latest, rather than what's lying around
+
+    # Sometimes the `flutter --version` output begins with lines like
+    # "Resolving dependencies..."; so the pattern accommodates those.
+    # The pattern requires Dart 3.x, because we'll emit "<4.0.0" below.
+    pattern=$'\nFlutter (\S+) .*\sDart \S+ \(build (3\.\S+)\)'
+
+    flutter_version_output=$(run_visibly flutter --version)
+    if ! [[ $'\n'"${flutter_version_output}" =~ $pattern ]]; then
+        echo >&2 "error: 'flutter --version' output not recognized"
+        printf >&2 "output was:\n-----\n%s\n-----" "${flutter_version_output}"
+        return 1
+    fi
+    flutter_version="${BASH_REMATCH[1]}"
+    dart_sdk_version="${BASH_REMATCH[2]}"
+
+    yaml_fragment="\
+  sdk: '>=${dart_sdk_version} <4.0.0'
+  flutter: '>=${flutter_version}'
+" \
+      perl -i -0pe 's/^  sdk: .*\n  flutter: .*\n/$ENV{yaml_fragment}/m' \
+        pubspec.yaml
+
+    if no_uncommitted_changes; then
+        echo >&2 "flutter: No changes."
+        return
+    fi
+
+    run_visibly flutter pub get
+
+    local libraries_updated=
+    if git diff pubspec.lock | perl -0ne '
+            s/.*?\n(@@)/$1/s;  # cut `git diff` header
+            if (/^[-+](?!  (dart|flutter):)/m) { exit 0; } else { exit 1; }
+          '; then
+        libraries_updated=y
+    fi
+
+    local more="
+
+And update Flutter's supporting libraries to match."
+    git commit -a -m "\
+deps: Upgrade Flutter to ${flutter_version}${libraries_updated:+"${more}"}
+"
+
+    cat <<EOF
+
+There was a Flutter upgrade${libraries_updated:+, and libraries were updated}.
+
+The \`tools/upgrade\` script created a draft commit, but
+it requires manual checking:
+
+ * The update was to the Flutter version you currently
+   have installed at the \`flutter\` command.
+   Check that is is the latest Flutter from main,
+   or otherwise the version you intend to upgrade to.
+EOF
+}
+
 upgrade_pub() {
     check_have_cocoapods
     check_no_uncommitted_or_untracked
@@ -233,6 +309,7 @@ for step in "${opt_steps[@]}"; do
     echo "======== tools/upgrade ${step}"
     case "${step}" in
         pod)       upgrade_pod ;;
+        flutter-local) upgrade_flutter_local ;;
         pub)       upgrade_pub ;;
         pub-major) upgrade_pub_major ;;
         *)   echo >&2 "Internal error: unknown step ${step}" ;;