DEV/flutter_flutter
1
0
Fork 0
mirror of https://github.com/flutter/flutter.git synced 2026-02-20 02:29:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

Precache platform filter change (#53701)

Browse Source 
Makes the following changes to the behavior of precache:
- The --all-platforms flags now fetches all artifacts, rather than just
  turning off platform filtering of selected artifacts.
- Explicitly requested artifacts are no longer subject to platform
  filtering. E.g., 'precache --ios' will download iOS artifacts on
  Windows and Linux (but 'precache' without an 'ios' flag will still
  only download iOS artifacts on macOS).
- Desktop platform artifacts now respect the bypassing of platform
  filtering.

Fixes #53272
This commit is contained in:
stuartmorgan 2020-04-01 10:54:59 -07:00 committed by GitHub
parent 67f70b4532
commit 445b5a14f2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 199 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
packages/flutter_tools/lib/src/cache.dart
View File

@ -156,6 +156,10 @@ class Cache {
// artifacts for the current platform.
bool includeAllPlatforms = false;
// Names of artifacts which should be cached even if they would normally
// be filtered out for the current platform.
Set<String> platformOverrideArtifacts;
// Whether to cache the unsigned mac binaries. Defaults to caching the signed binaries.
bool useUnsignedMacBinaries = false;
@ -523,6 +527,12 @@ abstract class CachedArtifact extends ArtifactSet {
@visibleForTesting
final List<File> downloadedFiles = <File>[];
// Whether or not to bypass normal platform filtering for this artifact.
bool get ignorePlatformFiltering {
return cache.includeAllPlatforms ||
(cache.platformOverrideArtifacts != null && cache.platformOverrideArtifacts.contains(developmentArtifact.name));
}
@override
bool isUpToDate() {
if (!location.existsSync()) {
@ -859,7 +869,7 @@ class MacOSEngineArtifacts extends EngineCachedArtifact {
@override
List<List<String>> getBinaryDirs() {
if (globals.platform.isMacOS) {
if (globals.platform.isMacOS || ignorePlatformFiltering) {
return _macOSDesktopBinaryDirs;
}
return const <List<String>>[];
@ -881,7 +891,7 @@ class WindowsEngineArtifacts extends EngineCachedArtifact {
@override
List<List<String>> getBinaryDirs() {
if (globals.platform.isWindows) {
if (globals.platform.isWindows || ignorePlatformFiltering) {
return _windowsDesktopBinaryDirs;
}
return const <List<String>>[];
@ -903,7 +913,7 @@ class LinuxEngineArtifacts extends EngineCachedArtifact {
@override
List<List<String>> getBinaryDirs() {
if (globals.platform.isLinux) {
if (globals.platform.isLinux || ignorePlatformFiltering) {
return _linuxDesktopBinaryDirs;
}
return const <List<String>>[];
@ -1020,14 +1030,14 @@ class IOSEngineArtifacts extends EngineCachedArtifact {
@override
List<List<String>> getBinaryDirs() {
return <List<String>>[
if (globals.platform.isMacOS || cache.includeAllPlatforms)
if (globals.platform.isMacOS || ignorePlatformFiltering)
..._iosBinaryDirs,
];
}
@override
List<String> getLicenseDirs() {
if (cache.includeAllPlatforms || globals.platform.isMacOS) {
if (globals.platform.isMacOS || ignorePlatformFiltering) {
return const <String>['ios', 'ios-profile', 'ios-release'];
}
return const <String>[];
@ -1302,7 +1312,7 @@ class IosUsbArtifacts extends CachedArtifact {
@override
Future<void> updateInner() {
if (!globals.platform.isMacOS && !cache.includeAllPlatforms) {
if (!globals.platform.isMacOS && !ignorePlatformFiltering) {
return Future<void>.value();
}
if (location.existsSync()) {

53
packages/flutter_tools/lib/src/commands/precache.dart
View File

@ -66,6 +66,33 @@ class PrecacheCommand extends FlutterCommand {
]
};
/// Returns a reverse mapping of _expandedArtifacts, from child artifact name
/// to umbrella name.
Map<String, String> _umbrellaForArtifactMap() {
return <String, String>{
for (final MapEntry<String, List<String>> entry in _expandedArtifacts.entries)
for (final String childArtifactName in entry.value)
childArtifactName: entry.key
};
}
/// Returns the name of all artifacts that were explicitly chosen via flags.
///
/// If an umbrella is chosen, its children will be included as well.
Set<String> _explicitArtifactSelections() {
final Map<String, String> umbrellaForArtifact = _umbrellaForArtifactMap();
final Set<String> selections = <String>{};
bool explicitlySelected(String name) => boolArg(name) && argResults.wasParsed(name);
for (final DevelopmentArtifact artifact in DevelopmentArtifact.values) {
final String umbrellaName = umbrellaForArtifact[artifact.name];
if (explicitlySelected(artifact.name) ||
(umbrellaName != null && explicitlySelected(umbrellaName))) {
selections.add(artifact.name);
}
}
return selections;
}
@override
Future<void> validateCommand() {
_expandedArtifacts.forEach((String umbrellaName, List<String> childArtifactNames) {
@ -84,12 +111,15 @@ class PrecacheCommand extends FlutterCommand {
@override
Future<FlutterCommandResult> runCommand() async {
if (boolArg('all-platforms')) {
final bool includeAllPlatforms = boolArg('all-platforms');
if (includeAllPlatforms) {
globals.cache.includeAllPlatforms = true;
}
if (boolArg('use-unsigned-mac-binaries')) {
globals.cache.useUnsignedMacBinaries = true;
}
globals.cache.platformOverrideArtifacts = _explicitArtifactSelections();
final Map<String, String> umbrellaForArtifact = _umbrellaForArtifactMap();
final Set<DevelopmentArtifact> requiredArtifacts = <DevelopmentArtifact>{};
for (final DevelopmentArtifact artifact in DevelopmentArtifact.values) {
// Don't include unstable artifacts on stable branches.
@ -100,25 +130,8 @@ class PrecacheCommand extends FlutterCommand {
continue;
}
bool expandedArtifactProcessed = false;
_expandedArtifacts.forEach((String umbrellaName, List<String> childArtifactNames) {
if (!childArtifactNames.contains(artifact.name)) {
return;
}
expandedArtifactProcessed = true;
// Expanded artifacts options are true by default.
// Explicitly ignore them if umbrella name is excluded.
// Example: --no-android [--android_gen_snapshot]
if (!boolArg(umbrellaName)) {
return;
}
// Example: --android [--android_gen_snapshot]
requiredArtifacts.add(artifact);
});
if (!expandedArtifactProcessed && boolArg(artifact.name)) {
final String argumentName = umbrellaForArtifact[artifact.name] ?? artifact.name;
if (includeAllPlatforms || boolArg(argumentName)) {
requiredArtifacts.add(artifact);
}
}

109
packages/flutter_tools/test/commands.shard/hermetic/precache_test.dart
View File

@ -8,6 +8,7 @@ import 'package:flutter_tools/src/features.dart';
import 'package:flutter_tools/src/runner/flutter_command.dart';
import 'package:flutter_tools/src/version.dart';
import 'package:mockito/mockito.dart';
import 'package:platform/platform.dart';
import '../../src/common.dart';
import '../../src/context.dart';
@ -270,6 +271,111 @@ void main() {
FeatureFlags: () => TestFeatureFlags(isWebEnabled: false),
});
testUsingContext('precache downloads iOS and Android artifacts by default', () async {
final PrecacheCommand command = PrecacheCommand();
applyMocksToCommand(command);
await createTestCommandRunner(command).run(
const <String>[
'precache',
],
);
expect(artifacts, unorderedEquals(<DevelopmentArtifact>{
DevelopmentArtifact.universal,
DevelopmentArtifact.iOS,
DevelopmentArtifact.androidGenSnapshot,
DevelopmentArtifact.androidMaven,
DevelopmentArtifact.androidInternalBuild,
}));
}, overrides: <Type, Generator>{
Cache: () => cache,
});
testUsingContext('precache --all-platforms gets all artifacts', () async {
final PrecacheCommand command = PrecacheCommand();
applyMocksToCommand(command);
await createTestCommandRunner(command).run(
const <String>[
'precache',
'--all-platforms',
],
);
expect(artifacts, unorderedEquals(<DevelopmentArtifact>{
DevelopmentArtifact.universal,
DevelopmentArtifact.iOS,
DevelopmentArtifact.androidGenSnapshot,
DevelopmentArtifact.androidMaven,
DevelopmentArtifact.androidInternalBuild,
DevelopmentArtifact.web,
DevelopmentArtifact.macOS,
DevelopmentArtifact.linux,
DevelopmentArtifact.windows,
DevelopmentArtifact.fuchsia,
DevelopmentArtifact.flutterRunner,
}));
}, overrides: <Type, Generator>{
Cache: () => cache,
FeatureFlags: () => TestFeatureFlags(
isWebEnabled: true,
isLinuxEnabled: true,
isMacOSEnabled: true,
isWindowsEnabled: true,
),
FlutterVersion: () => masterFlutterVersion,
});
testUsingContext('precache with default artifacts does not override platform filtering', () async {
final PrecacheCommand command = PrecacheCommand();
applyMocksToCommand(command);
await createTestCommandRunner(command).run(
const <String>[
'precache',
],
);
verify(cache.platformOverrideArtifacts = <String>{});
}, overrides: <Type, Generator>{
Cache: () => cache,
FlutterVersion: () => masterFlutterVersion,
});
testUsingContext('precache with explicit artifact options overrides platform filtering', () async {
final PrecacheCommand command = PrecacheCommand();
applyMocksToCommand(command);
await createTestCommandRunner(command).run(
const <String>[
'precache',
'--no-ios',
'--no-android',
'--macos',
],
);
expect(artifacts, unorderedEquals(<DevelopmentArtifact>{
DevelopmentArtifact.universal,
DevelopmentArtifact.macOS,
}));
verify(cache.platformOverrideArtifacts = <String>{'macos'});
}, overrides: <Type, Generator>{
Cache: () => cache,
FlutterVersion: () => masterFlutterVersion,
FeatureFlags: () => TestFeatureFlags(
isMacOSEnabled: true,
),
Platform: () => FakePlatform(
operatingSystem: 'windows',
environment: <String, String>{
'FLUTTER_ROOT': 'flutter',
'FLUTTER_ALREADY_LOCKED': 'true',
},
),
});
testUsingContext('precache downloads artifacts when --force is provided', () async {
when(cache.isUpToDate()).thenReturn(true);
final PrecacheCommand command = PrecacheCommand();
@ -285,6 +391,9 @@ void main() {
}, overrides: <Type, Generator>{
Cache: () => cache,
FlutterVersion: () => flutterVersion,
FeatureFlags: () => TestFeatureFlags(
isMacOSEnabled: true,
),
});
}

43
packages/flutter_tools/test/general.shard/cache_test.dart
View File

@ -520,7 +520,7 @@ void main() {
when(mockCache.includeAllPlatforms).thenReturn(false);
expect(artifacts.getBinaryDirs(), <List<String>>[<String>['linux-x64', 'linux-x64/font-subset.zip']]);
}, overrides: <Type, Generator> {
Platform: () => FakePlatform()..operatingSystem = 'linux',
Platform: () => FakePlatform(operatingSystem: 'linux'),
});
testUsingContext('FontSubset artifacts on windows', () {
@ -529,7 +529,7 @@ void main() {
when(mockCache.includeAllPlatforms).thenReturn(false);
expect(artifacts.getBinaryDirs(), <List<String>>[<String>['windows-x64', 'windows-x64/font-subset.zip']]);
}, overrides: <Type, Generator> {
Platform: () => FakePlatform()..operatingSystem = 'windows',
Platform: () => FakePlatform(operatingSystem: 'windows'),
});
testUsingContext('FontSubset artifacts on macos', () {
@ -538,7 +538,7 @@ void main() {
when(mockCache.includeAllPlatforms).thenReturn(false);
expect(artifacts.getBinaryDirs(), <List<String>>[<String>['darwin-x64', 'darwin-x64/font-subset.zip']]);
}, overrides: <Type, Generator> {
Platform: () => FakePlatform()..operatingSystem = 'macos',
Platform: () => FakePlatform(operatingSystem: 'macos'),
});
testUsingContext('FontSubset artifacts on fuchsia', () {
@ -547,7 +547,7 @@ void main() {
when(mockCache.includeAllPlatforms).thenReturn(false);
expect(() => artifacts.getBinaryDirs(), throwsToolExit(message: 'Unsupported operating system: ${globals.platform.operatingSystem}'));
}, overrides: <Type, Generator> {
Platform: () => FakePlatform()..operatingSystem = 'fuchsia',
Platform: () => FakePlatform(operatingSystem: 'fuchsia'),
});
testUsingContext('FontSubset artifacts for all platforms', () {
@ -560,7 +560,40 @@ void main() {
<String>['windows-x64', 'windows-x64/font-subset.zip'],
]);
}, overrides: <Type, Generator> {
Platform: () => FakePlatform()..operatingSystem = 'fuchsia',
Platform: () => FakePlatform(operatingSystem: 'fuchsia'),
});
testUsingContext('macOS desktop artifacts ignore filtering when requested', () {
final MockCache mockCache = MockCache();
final MacOSEngineArtifacts artifacts = MacOSEngineArtifacts(mockCache);
when(mockCache.includeAllPlatforms).thenReturn(false);
when(mockCache.platformOverrideArtifacts).thenReturn(<String>{'macos'});
expect(artifacts.getBinaryDirs(), isNotEmpty);
}, overrides: <Type, Generator> {
Platform: () => FakePlatform(operatingSystem: 'linux'),
});
testUsingContext('Windows desktop artifacts ignore filtering when requested', () {
final MockCache mockCache = MockCache();
final WindowsEngineArtifacts artifacts = WindowsEngineArtifacts(mockCache);
when(mockCache.includeAllPlatforms).thenReturn(false);
when(mockCache.platformOverrideArtifacts).thenReturn(<String>{'windows'});
expect(artifacts.getBinaryDirs(), isNotEmpty);
}, overrides: <Type, Generator> {
Platform: () => FakePlatform(operatingSystem: 'linux'),
});
testUsingContext('Linux desktop artifacts ignore filtering when requested', () {
final MockCache mockCache = MockCache();
final LinuxEngineArtifacts artifacts = LinuxEngineArtifacts(mockCache);
when(mockCache.includeAllPlatforms).thenReturn(false);
when(mockCache.platformOverrideArtifacts).thenReturn(<String>{'linux'});
expect(artifacts.getBinaryDirs(), isNotEmpty);
}, overrides: <Type, Generator> {
Platform: () => FakePlatform(operatingSystem: 'macos'),
});
}

3
packages/flutter_tools/test/src/testbed.dart
View File

@ -829,6 +829,9 @@ class FakeCache implements Cache {
@override
bool includeAllPlatforms;
@override
Set<String> platformOverrideArtifacts;
@override
bool useUnsignedMacBinaries;