firka/flutter
firka/flutter
5
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[flutter_tools] Fix legacy version file not being ensured (#133097)

Browse Source 
Fixes https://github.com/flutter/flutter/issues/133093

When I introduced the new, more robust version file `//flutter/bin/cache/version.json` in https://github.com/flutter/flutter/pull/124558, I changed `class FlutterVersion` into an abstract interface, implemented by `_FlutterVersionFromGit` (which is essentially the previous behavior) and `_FlutterVersionFromFile`, which merely reads the data it would have computed via git from `//flutter/bin/cache/version.json`.

While doing this, I made `_FlutterVersionFromGit.ensureVersionFile()` to be a no-op, since I assumed this would not be necessary since we already had a version file in the cache. However, this method was what was previously responsible for ensuring `//flutter/version` existed on disk. This means that if, for whatever reason, the user had `//flutter/bin/cache/flutter.version.json` present but NOT `//flutter/version`, the tool would have never created that file, and they would hit the tool crash seen in https://github.com/flutter/flutter/issues/133093.

This fixes the tool by ensuring `//flutter/version` exists regardless of if we're hydrating `FlutterVersion` from `//flutter/bin/cache/flutter.version.json` or not.
This commit is contained in:
Christopher Fujino 2023-08-23 11:31:06 -07:00 committed by GitHub
parent ad78cf3506
commit 9e59a68c98
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 60 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
packages/flutter_tools/lib/src/version.dart
View File

@ -532,7 +532,13 @@ class _FlutterVersionFromFile extends FlutterVersion {
final String devToolsVersion; final String devToolsVersion;
@override @override
void ensureVersionFile() {} void ensureVersionFile() {
_ensureLegacyVersionFile(
fs: fs,
flutterRoot: flutterRoot,
frameworkVersion: frameworkVersion,
);
}
} }
class _FlutterVersionGit extends FlutterVersion { class _FlutterVersionGit extends FlutterVersion {
@ -599,10 +605,11 @@ class _FlutterVersionGit extends FlutterVersion {
@override @override
void ensureVersionFile() { void ensureVersionFile() {
final File legacyVersionFile = fs.file(fs.path.join(flutterRoot, 'version')); _ensureLegacyVersionFile(
if (!legacyVersionFile.existsSync()) { fs: fs,
legacyVersionFile.writeAsStringSync(frameworkVersion); flutterRoot: flutterRoot,
} frameworkVersion: frameworkVersion,
);
const JsonEncoder encoder = JsonEncoder.withIndent(' '); const JsonEncoder encoder = JsonEncoder.withIndent(' ');
final File newVersionFile = FlutterVersion.getVersionFile(fs, flutterRoot); final File newVersionFile = FlutterVersion.getVersionFile(fs, flutterRoot);
@ -612,6 +619,17 @@ class _FlutterVersionGit extends FlutterVersion {
} }
} }
void _ensureLegacyVersionFile({
required FileSystem fs,
required String flutterRoot,
required String frameworkVersion,
}) {
final File legacyVersionFile = fs.file(fs.path.join(flutterRoot, 'version'));
if (!legacyVersionFile.existsSync()) {
legacyVersionFile.writeAsStringSync(frameworkVersion);
}
}
/// Checks if the provided [version] is tracking a standard remote. /// Checks if the provided [version] is tracking a standard remote.
/// ///
/// A "standard remote" is one having the same url as(in order of precedence): /// A "standard remote" is one having the same url as(in order of precedence):

37
packages/flutter_tools/test/general.shard/version_test.dart
View File

@ -554,6 +554,43 @@ void main() {
Cache: () => cache, Cache: () => cache,
}); });
testUsingContext('_FlutterVersionFromFile.ensureVersionFile ensures legacy version file exists', () async {
final MemoryFileSystem fs = MemoryFileSystem.test();
final Directory flutterRoot = fs.directory('/path/to/flutter');
final Directory cacheDir = flutterRoot
.childDirectory('bin')
.childDirectory('cache')
..createSync(recursive: true);
const String devToolsVersion = '0000000';
final File legacyVersionFile = flutterRoot.childFile('version');
const Map<String, Object> versionJson = <String, Object>{
'channel': 'stable',
'frameworkVersion': '1.2.3',
'repositoryUrl': 'https://github.com/flutter/flutter.git',
'frameworkRevision': '1234abcd',
'frameworkCommitDate': '2023-04-28 12:34:56 -0400',
'engineRevision': 'deadbeef',
'dartSdkVersion': 'deadbeef2',
'devToolsVersion': devToolsVersion,
'flutterVersion': 'foo',
};
cacheDir.childFile('flutter.version.json').writeAsStringSync(
jsonEncode(versionJson),
);
expect(legacyVersionFile.existsSync(), isFalse);
final FlutterVersion flutterVersion = FlutterVersion(
clock: _testClock,
fs: fs,
flutterRoot: flutterRoot.path,
);
flutterVersion.ensureVersionFile();
expect(legacyVersionFile.existsSync(), isTrue);
expect(legacyVersionFile.readAsStringSync(), '1.2.3');
}, overrides: <Type, Generator>{
ProcessManager: () => processManager,
Cache: () => cache,
});
testUsingContext('FlutterVersion() falls back to git if .version.json is malformed', () async { testUsingContext('FlutterVersion() falls back to git if .version.json is malformed', () async {
final MemoryFileSystem fs = MemoryFileSystem.test(); final MemoryFileSystem fs = MemoryFileSystem.test();
final Directory flutterRoot = fs.directory(fs.path.join('path', 'to', 'flutter')); final Directory flutterRoot = fs.directory(fs.path.join('path', 'to', 'flutter'));