Read flutter version from new location (#4113)

Author: sigurdm

lib/src/sdk/flutter.dart

@@ -2,12 +2,14 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+import 'dart:convert';
 import 'dart:io';
 
 import 'package:path/path.dart' as p;
 import 'package:pub_semver/pub_semver.dart';
 
 import '../io.dart';
+import '../log.dart';
 import '../sdk.dart';
 
 class FlutterSdk extends Sdk {
@@ -54,15 +56,34 @@ class FlutterSdk extends Sdk {
     return null;
   }();
   static final Version? _version = () {
-    if (_rootDirectory == null) return null;
+    final rootDirectory = _rootDirectory;
+    if (rootDirectory == null) return null;
+    if (!dirExists(rootDirectory)) {
+      // $FLUTTER_ROOT has been set, but doesn't exist.
+      return null;
+    }
+    final flutterVersionPath =
+        p.join(_rootDirectory!, 'bin', 'cache', 'flutter.version.json');
 
     try {
-      return Version.parse(
-        readTextFile(p.join(_rootDirectory!, 'version')).trim(),
+      final versionJson = jsonDecode(
+        readTextFile(flutterVersionPath),
+      );
+      if (versionJson is! Map) {
+        return null;
+      }
+      final flutterVersion = versionJson['flutterVersion'];
+      if (flutterVersion is! String) {
+        throw FormatException('flutter-version is not a string');
+      }
+      return Version.parse(flutterVersion);
+    } on IOException catch (e) {
+      warning(
+        'Could not open flutter version file at `$flutterVersionPath`: $e\n',
       );
-    } on IOException {
-      return null; // I guess the file doesn't exist
-    } on FormatException {
+      return null;
+    } on FormatException catch (e) {
+      fine('Bad flutter version file at `$flutterVersionPath` $e');
       return null; // I guess the file has the wrong format
     }
   }();

test/add/sdk/sdk_test.dart

@@ -27,7 +27,7 @@ void main() {
           [d.libDir('baz', 'foo 0.0.1'), d.libPubspec('baz', '0.0.1')],
         ),
       ]),
-      d.file('version', '1.2.3'),
+      d.flutterVersion('1.2.3'),
     ]).create();
   });
 

test/deps_test.dart

@@ -271,7 +271,7 @@ void main() {
     test('with the Flutter SDK, if applicable', () async {
       await pubGet();
 
-      await d.dir('flutter', [d.file('version', '4.3.2+1')]).create();
+      await d.dir('flutter', [d.flutterVersion('4.3.2+1')]).create();
       await runPub(
         args: ['deps'],
         output: contains('Flutter SDK 4.3.2+1'),

test/descriptor.dart

@@ -364,3 +364,12 @@ PackageConfigEntry packageConfigEntry({
         languageVersion != null ? LanguageVersion.parse(languageVersion) : null,
   );
 }
+
+Descriptor flutterVersion(String version) {
+  return dir('bin', [
+    dir(
+      'cache',
+      [file('flutter.version.json', '{"flutterVersion":"$version"}')],
+    ),
+  ]);
+}

test/embedding/ensure_pubspec_resolved.dart

@@ -290,7 +290,7 @@ void testEnsurePubspecResolved() {
           },
         );
 
-        await d.dir('flutter', [d.file('version', '1.2.3')]).create();
+        await d.dir('flutter', [d.flutterVersion('1.2.3')]).create();
 
         await d.dir(appPath, [
           d.appPubspec(dependencies: {'foo': '^3.0.0'}),
@@ -300,7 +300,7 @@ void testEnsurePubspecResolved() {
           environment: {'FLUTTER_ROOT': p.join(d.sandbox, 'flutter')},
         );
 
-        await d.dir('flutter', [d.file('version', '0.9.0')]).create();
+        await d.dir('flutter', [d.flutterVersion('0.9.0')]).create();
 
         server.serve(
           'foo',
@@ -485,7 +485,7 @@ void testEnsurePubspecResolved() {
           },
         );
 
-        await d.dir('flutter', [d.file('version', '1.2.3')]).create();
+        await d.dir('flutter', [d.flutterVersion('1.2.3')]).create();
 
         await d.dir(appPath, [
           d.appPubspec(dependencies: {'foo': '3.0.0'}),
@@ -495,7 +495,7 @@ void testEnsurePubspecResolved() {
           environment: {'FLUTTER_ROOT': p.join(d.sandbox, 'flutter')},
         );
 
-        await d.dir('flutter', [d.file('version', '2.4.6')]).create();
+        await d.dir('flutter', [d.flutterVersion('2.4.6')]).create();
 
         // Run pub manually here because otherwise we don't have access to
         // d.sandbox.

test/get/flutter_constraint_upper_bound_ignored_test.dart

@@ -11,7 +11,7 @@ import '../test_pub.dart';
 void main() {
   test('pub get succeeds despite of "invalid" flutter upper bound', () async {
     final fakeFlutterRoot =
-        d.dir('fake_flutter_root', [d.file('version', '1.23.0')]);
+        d.dir('fake_flutter_root', [d.flutterVersion('1.23.0')]);
     await fakeFlutterRoot.create();
     await d.dir(appPath, [
       d.pubspec({

test/outdated/outdated_test.dart

@@ -435,7 +435,6 @@ Future<void> main() async {
       );
 
     await d.dir('flutter-root', [
-      d.file('version', '1.2.3'),
       d.dir('packages', [
         d.dir('flutter', [
           d.libPubspec('flutter', '1.0.0', sdk: '>=2.12.0 <3.0.0'),
@@ -444,6 +443,7 @@ Future<void> main() async {
           d.libPubspec('flutter_test', '1.0.0', sdk: '>=2.10.0 <3.0.0'),
         ]),
       ]),
+      d.flutterVersion('1.2.3'),
     ]).create();
 
     await d.dir(appPath, [

test/pinned_dependency_hint_test.dart

@@ -20,7 +20,7 @@ void main() {
           ],
         ),
       ]),
-      d.file('version', '1.2.3'),
+      d.flutterVersion('1.2.3'),
     ]).create();
     await servePackages()
       ..serve('bar', '1.0.0', deps: {'tool': '^2.0.0'})
@@ -52,7 +52,7 @@ void main() {
           ],
         ),
       ]),
-      d.file('version', '1.2.3'),
+      d.flutterVersion('1.2.3'),
     ]).create();
     await servePackages()
       ..serve('tool', '1.0.0', deps: {'bar': '^2.0.0'})

test/sdk_test.dart

@@ -29,7 +29,7 @@ void main() {
             [d.libDir('baz', 'foo 0.0.1'), d.libPubspec('baz', '0.0.1')],
           ),
         ]),
-        d.file('version', '1.2.3'),
+        d.flutterVersion('1.2.3'),
       ]).create();
     });
 
@@ -109,7 +109,9 @@ void main() {
         "doesn't fail if the Flutter SDK's version file doesn't exist when "
         'nothing depends on Flutter', () async {
       await d.appDir().create();
-      deleteEntry(p.join(d.sandbox, 'flutter', 'version'));
+      deleteEntry(
+        p.join(d.sandbox, 'flutter', 'bin', 'cache', 'flutterVersion'),
+      );
       await pubCommand(
         command,
         environment: {'FLUTTER_ROOT': p.join(d.sandbox, 'flutter')},

test/solve_suggestions_test.dart

@@ -12,7 +12,7 @@ import 'test_pub.dart';
 
 void main() {
   test('suggests an upgrade to the flutter sdk', () async {
-    await d.dir('flutter', [d.file('version', '1.2.3')]).create();
+    await d.dir('flutter', [d.flutterVersion('1.2.3')]).create();
     final server = await servePackages();
     server.serve(
       'foo',

test/validator/dependency_test.dart

@@ -124,7 +124,7 @@ void main() {
     });
 
     test('depends on Flutter from an SDK source', () async {
-      await d.dir('flutter', [d.file('version', '1.2.3')]).create();
+      await d.dir('flutter', [d.flutterVersion('1.2.3')]).create();
       await flutterPackage('flutter').create();
       await package(
         deps: {
@@ -140,9 +140,8 @@ void main() {
     test(
       'depends on a package from Flutter with an appropriate Dart SDK constraint',
       () async {
-        await d.dir('flutter', [d.file('version', '1.2.3')]).create();
+        await d.dir('flutter', [d.flutterVersion('1.2.3')]).create();
         await flutterPackage('foo').create();
-        await d.dir('flutter', [d.file('version', '1.2.3')]).create();
         await package(
           deps: {
             'foo': {'sdk': 'flutter', 'version': '>=1.2.3 <2.0.0'},

test/validator/flutter_constraint_test.dart

@@ -24,7 +24,7 @@ late d.DirectoryDescriptor fakeFlutterRoot;
 Future<void> setup({
   String? flutterConstraint,
 }) async {
-  fakeFlutterRoot = d.dir('fake_flutter_root', [d.file('version', '1.23.0')]);
+  fakeFlutterRoot = d.dir('fake_flutter_root', [d.flutterVersion('1.23.0')]);
   await fakeFlutterRoot.create();
   await d.validPackage().create();
   await d.dir(appPath, [

test/version_solver_test.dart

@@ -1363,7 +1363,7 @@ void sdkConstraint() {
 
   group('with a Flutter SDK', () {
     setUp(() {
-      return d.dir('flutter', [d.file('version', '1.2.3')]).create();
+      return d.dir('flutter', [d.flutterVersion('1.2.3')]).create();
     });
 
     test('succeeds with a matching constraint', () async {
@@ -2032,7 +2032,7 @@ void regressions() {
           [d.libDir('baz', 'foo 0.0.1'), d.libPubspec('baz', '0.0.1')],
         ),
       ]),
-      d.file('version', '1.2.3'),
+      d.flutterVersion('1.2.3'),
     ]).create();
     await servePackages()
       ..serve(