assets.dart 10.9 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4 5 6 7 8
// 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';
9 10 11
import '../../base/logger.dart';
import '../../build_info.dart';
import '../../convert.dart';
12 13
import '../../devfs.dart';
import '../build_system.dart';
14
import '../depfile.dart';
15
import 'common.dart';
16
import 'icon_tree_shaker.dart';
17 18 19 20

/// A helper function to copy an asset bundle into an [environment]'s output
/// directory.
///
21 22
/// Throws [Exception] if [AssetBundle.build] returns a non-zero exit code.
///
23 24 25
/// [additionalContent] may contain additional DevFS entries that will be
/// included in the final bundle, but not the AssetManifest.json file.
///
26
/// Returns a [Depfile] containing all assets used in the build.
27
Future<Depfile> copyAssets(Environment environment, Directory outputDirectory, {
28 29 30
  Map<String, DevFSContent>? additionalContent,
  required TargetPlatform targetPlatform,
  BuildMode? buildMode,
31
}) async {
32
  // Check for an SkSL bundle.
33 34
  final String? shaderBundlePath = environment.defines[kBundleSkSLPath] ?? environment.inputs[kBundleSkSLPath];
  final DevFSContent? skslBundle = processSkSLBundle(
35 36 37 38 39 40 41
    shaderBundlePath,
    engineVersion: environment.engineVersion,
    fileSystem: environment.fileSystem,
    logger: environment.logger,
    targetPlatform: targetPlatform,
  );

42
  final File pubspecFile =  environment.projectDir.childFile('pubspec.yaml');
43
  // Only the default asset bundle style is supported in assemble.
44 45 46
  final AssetBundle assetBundle = AssetBundleFactory.defaultInstance(
    logger: environment.logger,
    fileSystem: environment.fileSystem,
47
    platform: environment.platform,
48
    splitDeferredAssets: buildMode != BuildMode.debug && buildMode != BuildMode.jitRelease,
49
  ).createBundle();
50
  final int resultCode = await assetBundle.build(
51 52
    manifestPath: pubspecFile.path,
    packagesPath: environment.projectDir.childFile('.packages').path,
53
    deferredComponentsEnabled: environment.defines[kDeferredComponents] == 'true',
54
    targetPlatform: targetPlatform,
55
  );
56 57 58
  if (resultCode != 0) {
    throw Exception('Failed to bundle asset files.');
  }
59 60 61 62 63 64 65
  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>[];
66 67 68

  final IconTreeShaker iconTreeShaker = IconTreeShaker(
    environment,
69
    assetBundle.entries[kFontManifestJson] as DevFSStringContent?,
70 71 72 73
    processManager: environment.processManager,
    logger: environment.logger,
    fileSystem: environment.fileSystem,
    artifacts: environment.artifacts,
74 75
  );

76 77 78
  final Map<String, DevFSContent> assetEntries = <String, DevFSContent>{
    ...assetBundle.entries,
    ...?additionalContent,
79 80
    if (skslBundle != null)
      kSkSLShaderBundlePath: skslBundle,
81 82
  };

83
  await Future.wait<void>(
84
    assetEntries.entries.map<Future<void>>((MapEntry<String, DevFSContent> entry) async {
85 86
      final PoolResource resource = await pool.request();
      try {
Dan Field's avatar
Dan Field committed
87 88
        // This will result in strange looking files, for example files with `/`
        // on Windows or files that end up getting URI encoded such as `#.ext`
89
        // to `%23.ext`. However, we have to keep it this way since the
Dan Field's avatar
Dan Field committed
90 91
        // platform channels in the framework will URI encode these values,
        // and the native APIs will look for files this way.
92 93
        final File file = environment.fileSystem.file(
          environment.fileSystem.path.join(outputDirectory.path, entry.key));
94 95 96 97
        outputs.add(file);
        file.parent.createSync(recursive: true);
        final DevFSContent content = entry.value;
        if (content is DevFSFileContent && content.file is File) {
98
          inputs.add(content.file as File);
99
          if (!await iconTreeShaker.subsetFont(
100
            input: content.file as File,
101 102 103 104 105
            outputPath: file.path,
            relativePath: entry.key,
          )) {
            await (content.file as File).copy(file.path);
          }
106 107 108 109 110 111 112
        } else {
          await file.writeAsBytes(await entry.value.contentsAsBytes());
        }
      } finally {
        resource.release();
      }
  }));
113 114 115 116

  // Copy deferred components assets only for release or profile builds.
  // The assets are included in assetBundle.entries as a normal asset when
  // building as debug.
117
  if (environment.defines[kDeferredComponents] == 'true' && buildMode != null) {
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
    await Future.wait<void>(
      assetBundle.deferredComponentsEntries.entries.map<Future<void>>((MapEntry<String, Map<String, DevFSContent>> componentEntries) async {
        final Directory componentOutputDir =
            environment.projectDir
                .childDirectory('build')
                .childDirectory(componentEntries.key)
                .childDirectory('intermediates')
                .childDirectory('flutter');
        await Future.wait<void>(
          componentEntries.value.entries.map<Future<void>>((MapEntry<String, DevFSContent> entry) async {
            final PoolResource resource = await pool.request();
            try {
              // This will result in strange looking files, for example files with `/`
              // on Windows or files that end up getting URI encoded such as `#.ext`
              // to `%23.ext`. However, we have to keep it this way since the
              // platform channels in the framework will URI encode these values,
              // and the native APIs will look for files this way.

              // If deferred components are disabled, then copy assets to regular location.
              final File file = environment.defines[kDeferredComponents] == 'true'
                ? environment.fileSystem.file(
                    environment.fileSystem.path.join(componentOutputDir.path, buildMode.name, 'deferred_assets', 'flutter_assets', entry.key))
                : environment.fileSystem.file(
                    environment.fileSystem.path.join(outputDirectory.path, 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(content.file as File);
                if (!await iconTreeShaker.subsetFont(
                  input: content.file as File,
                  outputPath: file.path,
                  relativePath: entry.key,
                )) {
                  await (content.file as File).copy(file.path);
                }
              } else {
                await file.writeAsBytes(await entry.value.contentsAsBytes());
              }
            } finally {
              resource.release();
            }
        }));
    }));
  }
163 164 165 166 167 168 169
  final Depfile depfile = Depfile(inputs + assetBundle.additionalDependencies, outputs);
  if (shaderBundlePath != null) {
    final File skSLBundleFile = environment.fileSystem
      .file(shaderBundlePath).absolute;
    depfile.inputs.add(skSLBundleFile);
  }
  return depfile;
170 171
}

172 173 174 175 176 177 178 179 180 181 182 183
/// The path of the SkSL JSON bundle included in flutter_assets.
const String kSkSLShaderBundlePath = 'io.flutter.shaders.json';

/// Validate and process an SkSL asset bundle in a [DevFSContent].
///
/// Returns `null` if the bundle was not provided, otherwise attempts to
/// validate the bundle.
///
/// Throws [Exception] if the bundle is invalid due to formatting issues.
///
/// If the current target platform is different than the platform constructed
/// for the bundle, a warning will be printed.
184 185 186 187 188
DevFSContent? processSkSLBundle(String? bundlePath, {
  required TargetPlatform targetPlatform,
  required FileSystem fileSystem,
  required Logger logger,
  String? engineVersion,
189 190 191 192 193 194 195 196 197 198 199 200
}) {
  if (bundlePath == null) {
    return null;
  }
  // Step 1: check that file exists.
  final File skSLBundleFile = fileSystem.file(bundlePath);
  if (!skSLBundleFile.existsSync()) {
    logger.printError('$bundlePath does not exist.');
    throw Exception('SkSL bundle was invalid.');
  }

  // Step 2: validate top level bundle structure.
201
  Map<String, Object>? bundle;
202
  try {
203
    final Object? rawBundle = json.decode(skSLBundleFile.readAsStringSync());
204 205 206 207 208 209 210 211 212 213 214 215 216 217
    if (rawBundle is Map<String, Object>) {
      bundle = rawBundle;
    } else {
      logger.printError('"$bundle" was not a JSON object: $rawBundle');
      throw Exception('SkSL bundle was invalid.');
    }
  } on FormatException catch (err) {
    logger.printError('"$bundle" was not a JSON object: $err');
    throw Exception('SkSL bundle was invalid.');
  }
  // Step 3: Validate that:
  // * The engine revision the bundle was compiled with
  //   is the same as the current revision.
  // * The target platform is the same (this one is a warning only).
218
  final String? bundleEngineRevision = bundle['engineRevision'] as String?;
219 220 221 222 223 224 225 226 227
  if (bundleEngineRevision != engineVersion) {
    logger.printError(
      'Expected Flutter $bundleEngineRevision, but found $engineVersion\n'
      'The SkSL bundle was produced with a different engine version. It must '
      'be recreated for the current Flutter version.'
    );
    throw Exception('SkSL bundle was invalid');
  }

228 229 230 231 232 233
  final String? parsedPlatform = bundle['platform'] as String?;
  TargetPlatform? bundleTargetPlatform;
  if (parsedPlatform != null) {
    bundleTargetPlatform = getTargetPlatformForName(parsedPlatform);
  }
  if (bundleTargetPlatform == null || bundleTargetPlatform != targetPlatform) {
234
    logger.printError(
235
      'The SkSL bundle was created for $bundleTargetPlatform, but the current '
236 237 238 239
      'platform is $targetPlatform. This may lead to less efficient shader '
      'caching.'
    );
  }
240
  return DevFSStringContent(json.encode(<String, Object?>{
241 242 243 244
    'data': bundle['data'],
  }));
}

245 246 247
/// Copy the assets defined in the flutter manifest into a build directory.
class CopyAssets extends Target {
  const CopyAssets();
248

249 250 251 252
  @override
  String get name => 'copy_assets';

  @override
253 254 255
  List<Target> get dependencies => const <Target>[
    KernelSnapshot(),
  ];
256 257 258 259

  @override
  List<Source> get inputs => const <Source>[
    Source.pattern('{FLUTTER_ROOT}/packages/flutter_tools/lib/src/build_system/targets/assets.dart'),
260
    ...IconTreeShaker.inputs,
261 262 263
  ];

  @override
264 265 266 267 268
  List<Source> get outputs => const <Source>[];

  @override
  List<String> get depfiles => const <String>[
    'flutter_assets.d'
269 270 271
  ];

  @override
272
  Future<void> build(Environment environment) async {
273 274 275 276
    final Directory output = environment
      .buildDir
      .childDirectory('flutter_assets');
    output.createSync(recursive: true);
277 278 279 280 281
    final Depfile depfile = await copyAssets(
      environment,
      output,
      targetPlatform: TargetPlatform.android,
    );
282
    final DepfileService depfileService = DepfileService(
283 284
      fileSystem: environment.fileSystem,
      logger: environment.logger,
285 286 287 288 289
    );
    depfileService.writeToFile(
      depfile,
      environment.buildDir.childFile('flutter_assets.d'),
    );
290 291
  }
}