assets.dart 11.8 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
import 'shader_compiler.dart';
18 19 20 21

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

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

  final IconTreeShaker iconTreeShaker = IconTreeShaker(
    environment,
72
    assetBundle.entries[kFontManifestJson] as DevFSStringContent?,
73 74 75 76
    processManager: environment.processManager,
    logger: environment.logger,
    fileSystem: environment.fileSystem,
    artifacts: environment.artifacts,
77
  );
78 79 80 81 82 83
  final ShaderCompiler shaderCompiler = ShaderCompiler(
    processManager: environment.processManager,
    logger: environment.logger,
    fileSystem: environment.fileSystem,
    artifacts: environment.artifacts,
  );
84

85 86 87
  final Map<String, DevFSContent> assetEntries = <String, DevFSContent>{
    ...assetBundle.entries,
    ...?additionalContent,
88 89
    if (skslBundle != null)
      kSkSLShaderBundlePath: skslBundle,
90
  };
91 92 93
  final Map<String, AssetKind> entryKinds = <String, AssetKind>{
    ...assetBundle.entryKinds,
  };
94

95
  await Future.wait<void>(
96
    assetEntries.entries.map<Future<void>>((MapEntry<String, DevFSContent> entry) async {
97 98
      final PoolResource resource = await pool.request();
      try {
Dan Field's avatar
Dan Field committed
99 100
        // This will result in strange looking files, for example files with `/`
        // on Windows or files that end up getting URI encoded such as `#.ext`
101
        // to `%23.ext`. However, we have to keep it this way since the
Dan Field's avatar
Dan Field committed
102 103
        // platform channels in the framework will URI encode these values,
        // and the native APIs will look for files this way.
104 105
        final File file = environment.fileSystem.file(
          environment.fileSystem.path.join(outputDirectory.path, entry.key));
106
        final AssetKind assetKind = entryKinds[entry.key] ?? AssetKind.regular;
107 108 109 110
        outputs.add(file);
        file.parent.createSync(recursive: true);
        final DevFSContent content = entry.value;
        if (content is DevFSFileContent && content.file is File) {
111
          inputs.add(content.file as File);
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
          bool doCopy = true;
          switch (assetKind) {
            case AssetKind.regular:
              break;
            case AssetKind.font:
              doCopy = !await iconTreeShaker.subsetFont(
                input: content.file as File,
                outputPath: file.path,
                relativePath: entry.key,
              );
              break;
            case AssetKind.shader:
              doCopy = !await shaderCompiler.compileShader(
                input: content.file as File,
                outputPath: file.path,
              );
              break;
          }
          if (doCopy) {
131 132
            await (content.file as File).copy(file.path);
          }
133 134 135 136 137 138 139
        } else {
          await file.writeAsBytes(await entry.value.contentsAsBytes());
        }
      } finally {
        resource.release();
      }
  }));
140 141 142 143

  // 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.
144
  if (environment.defines[kDeferredComponents] == 'true' && buildMode != null) {
145 146
    await Future.wait<void>(assetBundle.deferredComponentsEntries.entries.map<Future<void>>(
      (MapEntry<String, Map<String, DevFSContent>> componentEntries) async {
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
        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();
            }
        }));
    }));
  }
190 191 192 193 194 195 196
  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;
197 198
}

199 200 201 202 203 204 205 206 207 208 209 210
/// 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.
211 212 213 214 215
DevFSContent? processSkSLBundle(String? bundlePath, {
  required TargetPlatform targetPlatform,
  required FileSystem fileSystem,
  required Logger logger,
  String? engineVersion,
216 217 218 219 220 221 222 223 224 225 226 227
}) {
  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.
228
  Map<String, Object?>? bundle;
229
  try {
230
    final Object? rawBundle = json.decode(skSLBundleFile.readAsStringSync());
231
    if (rawBundle is Map<String, Object?>) {
232 233 234 235 236 237 238 239 240 241 242 243 244
      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).
245
  final String? bundleEngineRevision = bundle['engineRevision'] as String?;
246 247 248 249 250 251 252 253 254
  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');
  }

255 256 257 258 259 260
  final String? parsedPlatform = bundle['platform'] as String?;
  TargetPlatform? bundleTargetPlatform;
  if (parsedPlatform != null) {
    bundleTargetPlatform = getTargetPlatformForName(parsedPlatform);
  }
  if (bundleTargetPlatform == null || bundleTargetPlatform != targetPlatform) {
261
    logger.printError(
262
      'The SkSL bundle was created for $bundleTargetPlatform, but the current '
263 264 265 266
      'platform is $targetPlatform. This may lead to less efficient shader '
      'caching.'
    );
  }
267
  return DevFSStringContent(json.encode(<String, Object?>{
268 269 270 271
    'data': bundle['data'],
  }));
}

272 273 274
/// Copy the assets defined in the flutter manifest into a build directory.
class CopyAssets extends Target {
  const CopyAssets();
275

276 277 278 279
  @override
  String get name => 'copy_assets';

  @override
280 281 282
  List<Target> get dependencies => const <Target>[
    KernelSnapshot(),
  ];
283 284 285 286

  @override
  List<Source> get inputs => const <Source>[
    Source.pattern('{FLUTTER_ROOT}/packages/flutter_tools/lib/src/build_system/targets/assets.dart'),
287
    ...IconTreeShaker.inputs,
288
    ...ShaderCompiler.inputs,
289 290 291
  ];

  @override
292 293 294 295
  List<Source> get outputs => const <Source>[];

  @override
  List<String> get depfiles => const <String>[
296
    'flutter_assets.d',
297 298 299
  ];

  @override
300
  Future<void> build(Environment environment) async {
301 302 303 304
    final Directory output = environment
      .buildDir
      .childDirectory('flutter_assets');
    output.createSync(recursive: true);
305 306 307 308 309
    final Depfile depfile = await copyAssets(
      environment,
      output,
      targetPlatform: TargetPlatform.android,
    );
310
    final DepfileService depfileService = DepfileService(
311 312
      fileSystem: environment.fileSystem,
      logger: environment.logger,
313 314 315 316 317
    );
    depfileService.writeToFile(
      depfile,
      environment.buildDir.childFile('flutter_assets.d'),
    );
318 319
  }
}