// Copyright 2019 The Chromium Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. import 'package:pool/pool.dart'; import '../../asset.dart'; import '../../base/file_system.dart'; import '../../devfs.dart'; import '../../plugins.dart'; import '../../project.dart'; import '../build_system.dart'; import '../depfile.dart'; /// A helper function to copy an asset bundle into an [environment]'s output /// directory. /// /// Returns a [Depfile] containing all assets used in the build. Future<Depfile> copyAssets(Environment environment, Directory outputDirectory) async { final File pubspecFile = environment.projectDir.childFile('pubspec.yaml'); final AssetBundle assetBundle = AssetBundleFactory.instance.createBundle(); await assetBundle.build( manifestPath: pubspecFile.path, packagesPath: environment.projectDir.childFile('.packages').path, ); final Pool pool = Pool(kMaxOpenFiles); final List<File> inputs = <File>[ // An asset manifest with no assets would have zero inputs if not // for this pubspec file. pubspecFile, ]; final List<File> outputs = <File>[]; await Future.wait<void>( assetBundle.entries.entries.map<Future<void>>((MapEntry<String, DevFSContent> entry) async { final PoolResource resource = await pool.request(); try { final File file = fs.file(outputDirectory.uri.resolve(entry.key)); outputs.add(file); file.parent.createSync(recursive: true); final DevFSContent content = entry.value; if (content is DevFSFileContent && content.file is File) { inputs.add(fs.file(content.file.path)); await (content.file as File).copy(file.path); } else { await file.writeAsBytes(await entry.value.contentsAsBytes()); } } finally { resource.release(); } })); return Depfile(inputs, outputs); } /// Copy the assets defined in the flutter manifest into a build directory. class CopyAssets extends Target { const CopyAssets(); @override String get name => 'copy_assets'; @override List<Target> get dependencies => const <Target>[]; @override List<Source> get inputs => const <Source>[ Source.pattern('{FLUTTER_ROOT}/packages/flutter_tools/lib/src/build_system/targets/assets.dart'), ]; @override List<Source> get outputs => const <Source>[]; @override List<String> get depfiles => const <String>[ 'flutter_assets.d' ]; @override Future<void> build(Environment environment) async { final Directory output = environment .buildDir .childDirectory('flutter_assets'); output.createSync(recursive: true); final Depfile depfile = await copyAssets(environment, output); depfile.writeToFile(environment.buildDir.childFile('flutter_assets.d')); } } /// Rewrites the `.flutter-plugins` file of [project] based on the plugin /// dependencies declared in `pubspec.yaml`. // TODO(jonahwiliams): this should be per platform and located in build // outputs. class FlutterPlugins extends Target { const FlutterPlugins(); @override String get name => 'flutter_plugins'; @override List<Target> get dependencies => const <Target>[]; @override List<Source> get inputs => const <Source>[ Source.pattern('{FLUTTER_ROOT}/packages/flutter_tools/lib/src/build_system/targets/assets.dart'), Source.pattern('{PROJECT_DIR}/pubspec.yaml'), ]; @override List<Source> get outputs => const <Source>[ Source.pattern('{PROJECT_DIR}/.flutter-plugins'), ]; @override Future<void> build(Environment environment) async { // The pubspec may change for reasons other than plugins changing, so we compare // the manifest before writing. Some hosting build systems use timestamps // so we need to be careful to avoid tricking them into doing more work than // necessary. final FlutterProject project = FlutterProject.fromDirectory(environment.projectDir); final List<Plugin> plugins = findPlugins(project); final String pluginManifest = plugins .map<String>((Plugin p) => '${p.name}=${escapePath(p.path)}') .join('\n'); final File flutterPluginsFile = environment.projectDir.childFile('.flutter-plugins'); if (!flutterPluginsFile.existsSync() || flutterPluginsFile.readAsStringSync() != pluginManifest) { flutterPluginsFile.writeAsStringSync(pluginManifest); } } }