Unverified Commit c55b3220 authored by Jonah Williams's avatar Jonah Williams Committed by GitHub

[flutter_tools] fix performance of tree-shake-icons (#55417)

Fixes the performance issue with tree-shake-icons and filters to ttf mime type. Does not change default or error behavior.
parent 72397fd4
...@@ -60,9 +60,9 @@ Future<Depfile> copyAssets(Environment environment, Directory outputDirectory) a ...@@ -60,9 +60,9 @@ Future<Depfile> copyAssets(Environment environment, Directory outputDirectory) a
file.parent.createSync(recursive: true); file.parent.createSync(recursive: true);
final DevFSContent content = entry.value; final DevFSContent content = entry.value;
if (content is DevFSFileContent && content.file is File) { if (content is DevFSFileContent && content.file is File) {
inputs.add(globals.fs.file(content.file.path)); inputs.add(content.file as File);
if (!await iconTreeShaker.subsetFont( if (!await iconTreeShaker.subsetFont(
inputPath: content.file.path, input: content.file as File,
outputPath: file.path, outputPath: file.path,
relativePath: entry.key, relativePath: entry.key,
)) { )) {
......
...@@ -4,6 +4,7 @@ ...@@ -4,6 +4,7 @@
import 'package:meta/meta.dart'; import 'package:meta/meta.dart';
import 'package:process/process.dart'; import 'package:process/process.dart';
import 'package:mime/mime.dart' as mime;
import '../../artifacts.dart'; import '../../artifacts.dart';
import '../../base/common.dart'; import '../../base/common.dart';
...@@ -66,6 +67,12 @@ class IconTreeShaker { ...@@ -66,6 +67,12 @@ class IconTreeShaker {
} }
} }
/// The MIME type for ttf fonts.
static const Set<String> kTtfMimeTypes = <String>{
'font/ttf', // based on internet search
'application/x-font-ttf', // based on running locally.
};
/// The [Source] inputs that targets using this should depend on. /// The [Source] inputs that targets using this should depend on.
/// ///
/// See [Target.inputs]. /// See [Target.inputs].
...@@ -77,6 +84,7 @@ class IconTreeShaker { ...@@ -77,6 +84,7 @@ class IconTreeShaker {
final Environment _environment; final Environment _environment;
final String _fontManifest; final String _fontManifest;
Future<void> _iconDataProcessing;
Map<String, _IconTreeShakerData> _iconData; Map<String, _IconTreeShakerData> _iconData;
final ProcessManager _processManager; final ProcessManager _processManager;
...@@ -89,10 +97,10 @@ class IconTreeShaker { ...@@ -89,10 +97,10 @@ class IconTreeShaker {
&& _environment.defines[kIconTreeShakerFlag] == 'true' && _environment.defines[kIconTreeShakerFlag] == 'true'
&& _environment.defines[kBuildMode] != 'debug'; && _environment.defines[kBuildMode] != 'debug';
/// Fills the [_iconData] map. // Fills the [_iconData] map.
Future<Map<String, _IconTreeShakerData>> _getIconData(Environment environment) async { Future<void> _getIconData(Environment environment) async {
if (!enabled) { if (!enabled) {
return null; return;
} }
final File appDill = environment.buildDir.childFile('app.dill'); final File appDill = environment.buildDir.childFile('app.dill');
...@@ -119,12 +127,14 @@ class IconTreeShaker { ...@@ -119,12 +127,14 @@ class IconTreeShaker {
); );
if (fonts.length != iconData.length) { if (fonts.length != iconData.length) {
throwToolExit('Expected to find fonts for ${iconData.keys}, but found ' throwToolExit(
'${fonts.keys}. This usually means you are refering to ' 'Expected to find fonts for ${iconData.keys}, but found '
'font families in an IconData class but not including them ' '${fonts.keys}. This usually means you are refering to '
'in the assets section of your pubspec.yaml, are missing ' 'font families in an IconData class but not including them '
'the package that would include them, or are missing ' 'in the assets section of your pubspec.yaml, are missing '
'"uses-material-design: true".'); 'the package that would include them, or are missing '
'"uses-material-design: true".',
);
} }
final Map<String, _IconTreeShakerData> result = <String, _IconTreeShakerData>{}; final Map<String, _IconTreeShakerData> result = <String, _IconTreeShakerData>{};
...@@ -135,13 +145,11 @@ class IconTreeShaker { ...@@ -135,13 +145,11 @@ class IconTreeShaker {
codePoints: iconData[entry.key], codePoints: iconData[entry.key],
); );
} }
return result; _iconData = result;
} }
/// Calls font-subset, which transforms the `inputPath` font file to a /// Calls font-subset, which transforms the [input] font file to a
/// subsetted version at `outputPath`. /// subsetted version at [outputPath].
///
/// The `relativePath` parameter
/// ///
/// All parameters are required. /// All parameters are required.
/// ///
...@@ -150,15 +158,24 @@ class IconTreeShaker { ...@@ -150,15 +158,24 @@ class IconTreeShaker {
/// If the font-subset subprocess fails, it will [throwToolExit]. /// If the font-subset subprocess fails, it will [throwToolExit].
/// Otherwise, it will return true. /// Otherwise, it will return true.
Future<bool> subsetFont({ Future<bool> subsetFont({
@required String inputPath, @required File input,
@required String outputPath, @required String outputPath,
@required String relativePath, @required String relativePath,
}) async { }) async {
if (!enabled) { if (!enabled) {
return false; return false;
} }
if (input.lengthSync() < 12) {
_iconData ??= await _getIconData(_environment); return false;
}
final String mimeType = mime.lookupMimeType(
input.path,
headerBytes: await input.openRead(0, 12).first,
);
if (!kTtfMimeTypes.contains(mimeType)) {
return false;
}
await (_iconDataProcessing ??= _getIconData(_environment));
assert(_iconData != null); assert(_iconData != null);
final _IconTreeShakerData iconTreeShakerData = _iconData[relativePath]; final _IconTreeShakerData iconTreeShakerData = _iconData[relativePath];
...@@ -176,7 +193,7 @@ class IconTreeShaker { ...@@ -176,7 +193,7 @@ class IconTreeShaker {
final List<String> cmd = <String>[ final List<String> cmd = <String>[
fontSubset.path, fontSubset.path,
outputPath, outputPath,
inputPath, input.path,
]; ];
final String codePoints = iconTreeShakerData.codePoints.join(' '); final String codePoints = iconTreeShakerData.codePoints.join(' ');
_logger.printTrace('Running font-subset: ${cmd.join(' ')}, ' _logger.printTrace('Running font-subset: ${cmd.join(' ')}, '
...@@ -186,9 +203,7 @@ class IconTreeShaker { ...@@ -186,9 +203,7 @@ class IconTreeShaker {
fontSubsetProcess.stdin.writeln(codePoints); fontSubsetProcess.stdin.writeln(codePoints);
await fontSubsetProcess.stdin.flush(); await fontSubsetProcess.stdin.flush();
await fontSubsetProcess.stdin.close(); await fontSubsetProcess.stdin.close();
} on Exception catch (_) { } on Exception {
// handled by checking the exit code.
} on OSError catch (_) { // ignore: dead_code_on_catch_subtype
// handled by checking the exit code. // handled by checking the exit code.
} }
......
...@@ -136,7 +136,7 @@ class BuildBundleCommand extends BuildSubCommand { ...@@ -136,7 +136,7 @@ class BuildBundleCommand extends BuildSubCommand {
extraGenSnapshotOptions: buildInfo.extraGenSnapshotOptions, extraGenSnapshotOptions: buildInfo.extraGenSnapshotOptions,
fileSystemScheme: stringArg('filesystem-scheme'), fileSystemScheme: stringArg('filesystem-scheme'),
fileSystemRoots: stringsArg('filesystem-root'), fileSystemRoots: stringsArg('filesystem-root'),
treeShakeIcons: boolArg('tree-shake-icons'), treeShakeIcons: buildInfo.treeShakeIcons,
); );
return FlutterCommandResult.success(); return FlutterCommandResult.success();
} }
......
...@@ -19,7 +19,7 @@ class BuildWebCommand extends BuildSubCommand { ...@@ -19,7 +19,7 @@ class BuildWebCommand extends BuildSubCommand {
BuildWebCommand({ BuildWebCommand({
@required bool verboseHelp, @required bool verboseHelp,
}) { }) {
addTreeShakeIconsFlag(); addTreeShakeIconsFlag(enabledByDefault: false);
usesTargetOption(); usesTargetOption();
usesPubOption(); usesPubOption();
addBuildModeFlags(excludeDebug: true); addBuildModeFlags(excludeDebug: true);
......
...@@ -425,10 +425,13 @@ abstract class FlutterCommand extends Command<void> { ...@@ -425,10 +425,13 @@ abstract class FlutterCommand extends Command<void> {
); );
} }
void addTreeShakeIconsFlag() { void addTreeShakeIconsFlag({
bool enabledByDefault
}) {
argParser.addFlag('tree-shake-icons', argParser.addFlag('tree-shake-icons',
negatable: true, negatable: true,
defaultsTo: kIconTreeShakerEnabledDefault, defaultsTo: enabledByDefault
?? kIconTreeShakerEnabledDefault,
help: 'Tree shake icon fonts so that only glyphs used by the application remain.', help: 'Tree shake icon fonts so that only glyphs used by the application remain.',
); );
} }
...@@ -579,8 +582,12 @@ abstract class FlutterCommand extends Command<void> { ...@@ -579,8 +582,12 @@ abstract class FlutterCommand extends Command<void> {
'combination with "--${FlutterOptions.kSplitDebugInfoOption}"', 'combination with "--${FlutterOptions.kSplitDebugInfoOption}"',
); );
} }
final BuildMode buildMode = getBuildMode();
final bool treeShakeIcons = argParser.options.containsKey('tree-shake-icons')
&& buildMode.isPrecompiled
&& boolArg('tree-shake-icons');
return BuildInfo(getBuildMode(), return BuildInfo(buildMode,
argParser.options.containsKey('flavor') argParser.options.containsKey('flavor')
? stringArg('flavor') ? stringArg('flavor')
: null, : null,
...@@ -601,9 +608,7 @@ abstract class FlutterCommand extends Command<void> { ...@@ -601,9 +608,7 @@ abstract class FlutterCommand extends Command<void> {
buildName: argParser.options.containsKey('build-name') buildName: argParser.options.containsKey('build-name')
? stringArg('build-name') ? stringArg('build-name')
: null, : null,
treeShakeIcons: argParser.options.containsKey('tree-shake-icons') treeShakeIcons: treeShakeIcons,
? boolArg('tree-shake-icons')
: kIconTreeShakerEnabledDefault,
splitDebugInfoPath: splitDebugInfoPath, splitDebugInfoPath: splitDebugInfoPath,
dartObfuscation: dartObfuscation, dartObfuscation: dartObfuscation,
dartDefines: argParser.options.containsKey(FlutterOptions.kDartDefinesOption) dartDefines: argParser.options.containsKey(FlutterOptions.kDartDefinesOption)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment