Skip to content

Commit 07dd8b0

Browse files
authored
feat(web): support --web-content-hash for physical static assets (flutter#191919)
Supports content-hashing physical static assets under `assets/` and rewrites target path mappings in `AssetManifest.bin`, `AssetManifest.bin.json`, `AssetManifest.json`, and `FontManifest.json` when building Flutter Web with `--web-content-hash`. ### What this PR accomplishes * Computes SHA-256 (first 8 hex characters) for project static assets under `build/web/assets/`. * Renames physical assets on disk prior to file extension (`image.<hash>.png`). * Rewrites `AssetManifest.bin`, `AssetManifest.bin.json`, and `AssetManifest.json` variant maps to point to hashed filenames so `AssetImage` transparently resolves content-hashed assets at runtime. * Rewrites font asset target paths in `FontManifest.json`. * Excludes special files (`AssetManifest.*`, `FontManifest.json`, `NOTICES`, `NOTICES.Z`) and all shaders (`*.frag` and `shaders/`) from content-hashing to prevent runtime discovery and CanvasKit `FragmentProgram` 404s. * Cleans `build/web/assets/` on incremental rebuilds to prevent stale asset accumulation, and updates `flutter_assets.d` for hermetic build tracking. * Follows `dart-use-path-package` conventions (`fileSystem.path` context decomposition and `p.posix.joinAll` manifest bridging). > [!NOTE] > Direct runtime resolution for arbitrary `rootBundle.load(...)` and `rootBundle.loadString(...)` calls (which pass raw keys to the engine channel without consulting `AssetManifest`) will be completed in a companion framework task. Part of flutter#191915 Part of flutter#149031
1 parent f13bf48 commit 07dd8b0

3 files changed

Lines changed: 404 additions & 23 deletions

File tree

‎packages/flutter_tools/lib/src/build_system/targets/web.dart‎

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import '../../isolated/native_assets/dart_hook_result.dart';
2626
import '../../project.dart';
2727
import '../../web/bootstrap.dart';
2828
import '../../web/compile.dart';
29+
import '../../web/content_hash.dart';
2930
import '../../web/file_generators/flutter_service_worker_js.dart';
3031
import '../../web/file_generators/main_dart.dart' as main_dart;
3132
import '../../web/web_constants.dart';
@@ -123,27 +124,6 @@ class WebEntrypointTarget extends Target {
123124
String hashAndRenameWebOutput({required File file, File? sourceMapFile}) =>
124125
_hashAndRenameWebOutput(file: file, sourceMapFile: sourceMapFile);
125126

126-
const List<String> _kKnownHashedExtensions = <String>[
127-
'.js.map',
128-
'.wasm.map',
129-
'.mjs.map',
130-
'.js',
131-
'.wasm',
132-
'.mjs',
133-
];
134-
135-
String _computeHashedBasename(String oldBasename, String contentHash, FileSystem fileSystem) {
136-
final String doubleExt = fileSystem.path.extension(oldBasename, 2);
137-
final String ext = _kKnownHashedExtensions.contains(doubleExt)
138-
? doubleExt
139-
: fileSystem.path.extension(oldBasename);
140-
if (ext.isNotEmpty) {
141-
final String stem = oldBasename.substring(0, oldBasename.length - ext.length);
142-
return '$stem.$contentHash$ext';
143-
}
144-
return '$oldBasename.$contentHash';
145-
}
146-
147127
String _hashAndRenameWebOutput({required File file, File? sourceMapFile}) {
148128
if (!file.existsSync()) {
149129
return file.basename;
@@ -157,7 +137,7 @@ String _hashAndRenameWebOutput({required File file, File? sourceMapFile}) {
157137
.convert(file.readAsBytesSync())
158138
.toString()
159139
.substring(0, 8);
160-
final String newBasename = _computeHashedBasename(file.basename, contentHash, file.fileSystem);
140+
final String newBasename = computeHashedBasename(file.basename, contentHash, file.fileSystem);
161141

162142
// The source map shares the binary's hash so the pair stays discoverable as
163143
// '<binary>.map'. A `.wasm` binary embeds its map name in a binary custom
@@ -1108,6 +1088,9 @@ class WebReleaseBundle extends Target {
11081088

11091089
createVersionFile(environment, environment.defines);
11101090
final Directory outputDirectory = environment.outputDir.childDirectory('assets');
1091+
if (outputDirectory.existsSync()) {
1092+
outputDirectory.deleteSync(recursive: true);
1093+
}
11111094
outputDirectory.createSync(recursive: true);
11121095

11131096
final DartHooksResult dartHookResult = await LinkHooks.loadHookResult(environment);
@@ -1120,7 +1103,26 @@ class WebReleaseBundle extends Target {
11201103
);
11211104
final Depfile bundledDepfile = _bundleLocalRobotoFallback(environment, depfile);
11221105
final DepfileService depfileService = environment.depFileService;
1123-
depfileService.writeToFile(bundledDepfile, environment.buildDir.childFile('flutter_assets.d'));
1106+
1107+
final bool webContentHash = compileTargets.any(
1108+
(Dart2WebTarget t) => t.compilerConfig.webContentHash,
1109+
);
1110+
if (webContentHash) {
1111+
final Map<String, File> renamedOutputs = hashWebAssets(outputDirectory);
1112+
final List<File> updatedOutputs = bundledDepfile.outputs.map((File f) {
1113+
final String normalizedPath = environment.fileSystem.path.normalize(f.path);
1114+
return renamedOutputs[normalizedPath] ?? renamedOutputs[f.path] ?? f;
1115+
}).toList();
1116+
depfileService.writeToFile(
1117+
Depfile(bundledDepfile.inputs, updatedOutputs),
1118+
environment.buildDir.childFile('flutter_assets.d'),
1119+
);
1120+
} else {
1121+
depfileService.writeToFile(
1122+
bundledDepfile,
1123+
environment.buildDir.childFile('flutter_assets.d'),
1124+
);
1125+
}
11241126

11251127
final Directory webResources = environment.projectDir.childDirectory('web');
11261128
final List<File> inputResourceFiles = webResources
Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
1+
// Copyright 2014 The Flutter Authors. All rights reserved.
2+
// Use of this source code is governed by a BSD-style license that can be
3+
// found in the LICENSE file.
4+
5+
import 'dart:typed_data';
6+
7+
import 'package:crypto/crypto.dart' as crypto;
8+
import 'package:path/path.dart' as p; // flutter_ignore: package_path_import
9+
import 'package:standard_message_codec/standard_message_codec.dart';
10+
11+
import '../base/file_system.dart';
12+
import '../convert.dart';
13+
14+
const List<String> _kKnownHashedExtensions = <String>[
15+
'.js.map',
16+
'.wasm.map',
17+
'.mjs.map',
18+
'.js',
19+
'.wasm',
20+
'.mjs',
21+
];
22+
23+
const Set<String> _kUnhashedAssetRelativePaths = <String>{
24+
'AssetManifest.json',
25+
'AssetManifest.bin',
26+
'AssetManifest.bin.json',
27+
'FontManifest.json',
28+
'NOTICES',
29+
'NOTICES.Z',
30+
};
31+
32+
String computeHashedBasename(String oldBasename, String contentHash, FileSystem fileSystem) {
33+
final String doubleExt = fileSystem.path.extension(oldBasename, 2);
34+
final String ext = _kKnownHashedExtensions.contains(doubleExt)
35+
? doubleExt
36+
: fileSystem.path.extension(oldBasename);
37+
if (ext.isNotEmpty) {
38+
final String stem = oldBasename.substring(0, oldBasename.length - ext.length);
39+
return '$stem.$contentHash$ext';
40+
}
41+
return '$oldBasename.$contentHash';
42+
}
43+
44+
Map<String, File> hashWebAssets(Directory assetsDir) {
45+
final renamedFileMap = <String, File>{};
46+
if (!assetsDir.existsSync()) {
47+
return renamedFileMap;
48+
}
49+
50+
final FileSystem fileSystem = assetsDir.fileSystem;
51+
final List<File> files = assetsDir.listSync(recursive: true).whereType<File>().toList();
52+
final renamedAssets = <String, String>{};
53+
54+
for (final file in files) {
55+
final String relativePath = fileSystem.path.relative(file.path, from: assetsDir.path);
56+
final List<String> segments = fileSystem.path.split(relativePath);
57+
final String posixRelativePath = p.posix.joinAll(segments);
58+
59+
if (_kUnhashedAssetRelativePaths.contains(posixRelativePath) ||
60+
fileSystem.path.extension(file.path).toLowerCase() == '.frag' ||
61+
segments.firstOrNull == 'shaders') {
62+
continue;
63+
}
64+
65+
final String basename = fileSystem.path.basename(file.path);
66+
final String contentHash = crypto.sha256
67+
.convert(file.readAsBytesSync())
68+
.toString()
69+
.substring(0, 8);
70+
final String newBasename = computeHashedBasename(basename, contentHash, fileSystem);
71+
72+
final newSegments = <String>[...segments.sublist(0, segments.length - 1), newBasename];
73+
final String newRelativePath = fileSystem.path.joinAll(newSegments);
74+
final String posixNewPath = p.posix.joinAll(newSegments);
75+
76+
// Rename the physical file on disk.
77+
final String newPath = fileSystem.path.join(assetsDir.path, newRelativePath);
78+
final String oldPath = file.path;
79+
final String normalizedOldPath = fileSystem.path.normalize(oldPath);
80+
file.renameSync(newPath);
81+
final File newFile = fileSystem.file(newPath);
82+
renamedFileMap[oldPath] = newFile;
83+
renamedFileMap[normalizedOldPath] = newFile;
84+
85+
// Map POSIX paths (for manifests). Handle raw, decoded, and encoded paths.
86+
renamedAssets[posixRelativePath] = posixNewPath;
87+
try {
88+
final String decoded = Uri.decodeFull(posixRelativePath);
89+
renamedAssets[decoded] = posixNewPath;
90+
} on FormatException {
91+
// Retain raw path if malformed percent escape sequence.
92+
}
93+
final String encoded = Uri.encodeFull(posixRelativePath);
94+
renamedAssets[encoded] = posixNewPath;
95+
}
96+
97+
// Now update the manifests if they exist.
98+
final File assetManifestBin = assetsDir.childFile('AssetManifest.bin');
99+
if (assetManifestBin.existsSync()) {
100+
final Uint8List rawBytes = assetManifestBin.readAsBytesSync();
101+
final message = ByteData.sublistView(rawBytes);
102+
final Object? decoded = const StandardMessageCodec().decodeMessage(message);
103+
if (decoded is Map<Object?, Object?>) {
104+
final newManifest = <String, dynamic>{};
105+
for (final MapEntry<Object?, Object?> entry in decoded.entries) {
106+
final key = entry.key.toString();
107+
final Object? variantsVal = entry.value;
108+
if (variantsVal is! List<Object?>) {
109+
newManifest[key] = variantsVal;
110+
continue;
111+
}
112+
final newVariants = <dynamic>[];
113+
for (final Object? variantObj in variantsVal) {
114+
if (variantObj is! Map<Object?, Object?>) {
115+
newVariants.add(variantObj);
116+
continue;
117+
}
118+
final newVariantMap = <String, dynamic>{};
119+
for (final MapEntry<Object?, Object?> vEntry in variantObj.entries) {
120+
final vKey = vEntry.key.toString();
121+
if (vKey == 'asset') {
122+
final vValue = vEntry.value.toString();
123+
newVariantMap[vKey] = renamedAssets[vValue] ?? vValue;
124+
} else {
125+
newVariantMap[vKey] = vEntry.value;
126+
}
127+
}
128+
newVariants.add(newVariantMap);
129+
}
130+
newManifest[key] = newVariants;
131+
}
132+
final ByteData encoded = const StandardMessageCodec().encodeMessage(newManifest)!;
133+
final encodedBytes = Uint8List.sublistView(encoded);
134+
assetManifestBin.writeAsBytesSync(encodedBytes);
135+
136+
// Update AssetManifest.bin.json
137+
final File assetManifestBinJson = assetsDir.childFile('AssetManifest.bin.json');
138+
if (assetManifestBinJson.existsSync()) {
139+
assetManifestBinJson.writeAsStringSync(json.encode(base64.encode(encodedBytes)));
140+
}
141+
}
142+
}
143+
144+
// Update legacy AssetManifest.json if present.
145+
final File assetManifestJson = assetsDir.childFile('AssetManifest.json');
146+
if (assetManifestJson.existsSync()) {
147+
final Object? decodedJson = json.decode(assetManifestJson.readAsStringSync());
148+
if (decodedJson is Map<String, dynamic>) {
149+
final newManifest = <String, dynamic>{};
150+
for (final MapEntry<String, dynamic> entry in decodedJson.entries) {
151+
final Object? variants = entry.value;
152+
if (variants is! List<dynamic>) {
153+
newManifest[entry.key] = variants;
154+
continue;
155+
}
156+
final newVariants = <String>[];
157+
for (final Object? variant in variants) {
158+
if (variant is String) {
159+
newVariants.add(renamedAssets[variant] ?? variant);
160+
} else if (variant != null) {
161+
newVariants.add(variant.toString());
162+
}
163+
}
164+
newManifest[entry.key] = newVariants;
165+
}
166+
assetManifestJson.writeAsStringSync(json.encode(newManifest));
167+
}
168+
}
169+
170+
final File fontManifest = assetsDir.childFile('FontManifest.json');
171+
if (fontManifest.existsSync()) {
172+
final Object? decodedJson = json.decode(fontManifest.readAsStringSync());
173+
if (decodedJson is List<dynamic>) {
174+
for (final Object? font in decodedJson) {
175+
if (font is Map<String, dynamic>) {
176+
final Object? fonts = font['fonts'];
177+
if (fonts is List<dynamic>) {
178+
for (final Object? fontAsset in fonts) {
179+
if (fontAsset is Map<String, dynamic>) {
180+
final Object? asset = fontAsset['asset'];
181+
if (asset is String && renamedAssets.containsKey(asset)) {
182+
fontAsset['asset'] = renamedAssets[asset];
183+
}
184+
}
185+
}
186+
}
187+
}
188+
}
189+
fontManifest.writeAsStringSync(json.encode(decodedJson));
190+
}
191+
}
192+
193+
return renamedFileMap;
194+
}

0 commit comments

Comments
 (0)