Repository navigation
Commit 985e184
authored
feat(web): emit precache_manifest.json when --web-content-hash is enabled (flutter#192953)
## Description
Implements **Phase 3** of Flutter Web Content Hashing (flutter#191916):
- **Emit `build/web/precache_manifest.json` when `--web-content-hash` is
enabled**:
- Generated inside `WebServiceWorker.build`
(`packages/flutter_tools/lib/src/web/content_hash.dart`) after
`hashWebAssets` rewrites hashed assets.
- Emits `{ "version": 1, "entries": [...] }` sorted lexicographically by
`"url"` for deterministic output.
- Each entry includes:
- `"url"`: POSIX path relative to `build/web/`
- `"hash"`: 8-character lowercase hex SHA-256 prefix of the file's bytes
- `"size"`: File byte length (`int`)
- `"urlHashed"`: `bool` (`true` if the filename already contains
`.$hash.` or ends with `.$hash` so custom service workers/PWAs can skip
redundant `?v=<hash>` cache-busting query parameters; `false` for
fixed-URL files such as `index.html`, `flutter_bootstrap.js`,
`assets/AssetManifest.bin`, `assets/FontManifest.json`,
`assets/NOTICES`, and `version.json`).
- **Non-Runtime Bloat Exclusion**:
- Excludes source maps (`*.map`), symbols (`*.symbols`), compiler info
(`*.info.json`), dotfiles (`.` prefix), `flutter_service_worker.js`,
`precache_manifest.json` itself, and `canvaskit/**` (unless
`kUseLocalCanvasKitFlag == 'true'` / `--no-web-resources-cdn`).
- **Stale Manifest Cleanup & Depfile Safety**:
- Deletes any stale `precache_manifest.json` in `build/web/` when
`--web-content-hash` is `false`.
- Excludes `precache_manifest.json` from `WebServiceWorker` input
discovery while registering it as a `Depfile` output to prevent
input/output cycles in `service_worker.d`.
- **Preserve `hide: true` on `--web-content-hash`**:
- Keeps `hide: true` on `WebOptions.webContentHash` while runtime
raw-key asset resolution (`rootBundle.load`,
`ui_web.AssetManager.getAssetUrl`) is completed in companion tasks, and
updates the `--help` description to clarify that
`assets/AssetManifest.bin.json` and `assets/FontManifest.json` must be
served with revalidation while they remain unhashed.
> [!NOTE]
> On `master`, passing the hidden `--web-content-hash` flag currently
causes raw-key asset loads (`rootBundle.load(...)`, `vector_graphics`,
DOM media plugins) to 404 on cold cache because physical files are
content-hashed on disk but runtime resolution has not yet landed. Phase
2.5 will add runtime key-to-hashed asset resolution in the web engine
(`ui_web.AssetManager`) before `--web-content-hash` is un-hidden for
general use.
## Related Issues
- Fixes flutter#191916
- Part of flutter#149031
## Tests
- Added 3 unit tests in
`packages/flutter_tools/test/general.shard/build_system/targets/web_test.dart`
verifying `precache_manifest.json` schema/sorting/filtering,
`kUseLocalCanvasKitFlag == 'true'` inclusion of `canvaskit/`, and stale
manifest deletion when `webContentHash: false`.1 parent 124f1de commit 985e184
4 files changed
Lines changed: 303 additions & 10 deletions
File tree
- packages/flutter_tools
- lib/src
- build_system/targets
- web
- test/general.shard/build_system/targets
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1532 | 1532 | | |
1533 | 1533 | | |
1534 | 1534 | | |
| 1535 | + | |
1535 | 1536 | | |
1536 | 1537 | | |
1537 | 1538 | | |
1538 | 1539 | | |
| 1540 | + | |
| 1541 | + | |
| 1542 | + | |
| 1543 | + | |
| 1544 | + | |
| 1545 | + | |
| 1546 | + | |
| 1547 | + | |
1539 | 1548 | | |
1540 | | - | |
| 1549 | + | |
1541 | 1550 | | |
1542 | 1551 | | |
1543 | 1552 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
192 | 192 | | |
193 | 193 | | |
194 | 194 | | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
80 | 80 | | |
81 | 81 | | |
82 | 82 | | |
83 | | - | |
84 | | - | |
85 | | - | |
86 | | - | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
87 | 87 | | |
88 | 88 | | |
89 | 89 | | |
90 | 90 | | |
91 | | - | |
92 | | - | |
93 | | - | |
94 | | - | |
95 | | - | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
96 | 98 | | |
97 | 99 | | |
98 | 100 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2675 | 2675 | | |
2676 | 2676 | | |
2677 | 2677 | | |
| 2678 | + | |
| 2679 | + | |
| 2680 | + | |
| 2681 | + | |
| 2682 | + | |
| 2683 | + | |
| 2684 | + | |
| 2685 | + | |
| 2686 | + | |
| 2687 | + | |
| 2688 | + | |
| 2689 | + | |
| 2690 | + | |
| 2691 | + | |
| 2692 | + | |
| 2693 | + | |
| 2694 | + | |
| 2695 | + | |
| 2696 | + | |
| 2697 | + | |
| 2698 | + | |
| 2699 | + | |
| 2700 | + | |
| 2701 | + | |
| 2702 | + | |
| 2703 | + | |
| 2704 | + | |
| 2705 | + | |
| 2706 | + | |
| 2707 | + | |
| 2708 | + | |
| 2709 | + | |
| 2710 | + | |
| 2711 | + | |
| 2712 | + | |
| 2713 | + | |
| 2714 | + | |
| 2715 | + | |
| 2716 | + | |
| 2717 | + | |
| 2718 | + | |
| 2719 | + | |
| 2720 | + | |
| 2721 | + | |
| 2722 | + | |
| 2723 | + | |
| 2724 | + | |
| 2725 | + | |
| 2726 | + | |
| 2727 | + | |
| 2728 | + | |
| 2729 | + | |
| 2730 | + | |
| 2731 | + | |
| 2732 | + | |
| 2733 | + | |
| 2734 | + | |
| 2735 | + | |
| 2736 | + | |
| 2737 | + | |
| 2738 | + | |
| 2739 | + | |
| 2740 | + | |
| 2741 | + | |
| 2742 | + | |
| 2743 | + | |
| 2744 | + | |
| 2745 | + | |
| 2746 | + | |
| 2747 | + | |
| 2748 | + | |
| 2749 | + | |
| 2750 | + | |
| 2751 | + | |
| 2752 | + | |
| 2753 | + | |
| 2754 | + | |
| 2755 | + | |
| 2756 | + | |
| 2757 | + | |
| 2758 | + | |
| 2759 | + | |
| 2760 | + | |
| 2761 | + | |
| 2762 | + | |
| 2763 | + | |
| 2764 | + | |
| 2765 | + | |
| 2766 | + | |
| 2767 | + | |
| 2768 | + | |
| 2769 | + | |
| 2770 | + | |
| 2771 | + | |
| 2772 | + | |
| 2773 | + | |
| 2774 | + | |
| 2775 | + | |
| 2776 | + | |
| 2777 | + | |
| 2778 | + | |
| 2779 | + | |
| 2780 | + | |
| 2781 | + | |
| 2782 | + | |
| 2783 | + | |
| 2784 | + | |
| 2785 | + | |
| 2786 | + | |
| 2787 | + | |
| 2788 | + | |
| 2789 | + | |
| 2790 | + | |
| 2791 | + | |
| 2792 | + | |
| 2793 | + | |
| 2794 | + | |
| 2795 | + | |
| 2796 | + | |
| 2797 | + | |
| 2798 | + | |
| 2799 | + | |
| 2800 | + | |
| 2801 | + | |
| 2802 | + | |
| 2803 | + | |
| 2804 | + | |
| 2805 | + | |
| 2806 | + | |
| 2807 | + | |
| 2808 | + | |
| 2809 | + | |
| 2810 | + | |
| 2811 | + | |
| 2812 | + | |
| 2813 | + | |
| 2814 | + | |
| 2815 | + | |
| 2816 | + | |
| 2817 | + | |
| 2818 | + | |
| 2819 | + | |
| 2820 | + | |
| 2821 | + | |
| 2822 | + | |
| 2823 | + | |
| 2824 | + | |
| 2825 | + | |
| 2826 | + | |
| 2827 | + | |
| 2828 | + | |
| 2829 | + | |
| 2830 | + | |
| 2831 | + | |
| 2832 | + | |
| 2833 | + | |
| 2834 | + | |
| 2835 | + | |
| 2836 | + | |
| 2837 | + | |
| 2838 | + | |
| 2839 | + | |
| 2840 | + | |
| 2841 | + | |
| 2842 | + | |
| 2843 | + | |
| 2844 | + | |
| 2845 | + | |
| 2846 | + | |
| 2847 | + | |
| 2848 | + | |
| 2849 | + | |
| 2850 | + | |
| 2851 | + | |
| 2852 | + | |
| 2853 | + | |
| 2854 | + | |
| 2855 | + | |
| 2856 | + | |
| 2857 | + | |
| 2858 | + | |
| 2859 | + | |
| 2860 | + | |
| 2861 | + | |
| 2862 | + | |
| 2863 | + | |
| 2864 | + | |
| 2865 | + | |
| 2866 | + | |
| 2867 | + | |
| 2868 | + | |
| 2869 | + | |
| 2870 | + | |
| 2871 | + | |
| 2872 | + | |
| 2873 | + | |
2678 | 2874 | | |
0 commit comments