reland of https://github.com/flutter/flutter/pull/171927
towards https://github.com/flutter/flutter/issues/171790
Use the content aware hash when downloading engine artifacts. These are
currently produced when changes to DEPs, engine/, or the release file
are changed in a not-seen-before way.
We can eventually remove engine.version being tracked in release
branches as an optimization.
FLUTTER_PREBUILT_ENGINE_VERSION will stay for overriding the
engine.version for testing. Though Cocoon does not need to actually set
it for framework only PRs anymore.
fxies post submit tests for content_hash download:
SHARD=framework_tests SUBSHARD=misc dart --enable-asserts
dev/bots/test.dart
SHARD=tool_host_cross_arch_tests dart --enable-asserts
dev/bots/test.dart
```
╔═╡ERROR https://github.com/flutter/flutter/pull/1╞════════════════════════════════════════════════════════════════════
║ Expected "Flutter Engine Version: 45b085ab2118f30441ae6e2daab4b8eb3e4a063c", but found "Flutter Engine Version: 407c051ec9".
╚═══════════════════════════════════════════════════════════════════════════════
```
```
Expected: contains '45b085ab2118f30441ae6e2daab4b8eb3e4a063c'
Which: does not contain '45b085ab2118f30441ae6e2daab4b8eb3e4a063c'
```
4.7 KiB
How flutter fetches engine artifacts
flutter.dev/to/engine-artifacts
While in the same repository, the flutter (tool), which is used to run and
test the framework, needs to know how to download the engine artifacts for the
current platform and target device. Engine artifacts include dart (the
standalone Dart SDK), which runs flutter itself, and per-platform and build
mode prebuilt engines (which include the C++ compiled engine, and the embedders
for Android, iOS, and so-on).
When using a released version of Flutter, i.e. from a channel such as stable,
bin/internal/engine.version is set to the
content hash SHA for a merged commit in https://github.com/flutter/flutter, where
the engine artifacts have already been pre-built and uploaded.
When using the master channel, or contributing to Flutter (which is typically
as a fork of Flutter's master channel), the engine SHA is computed by
generating a content-aware hash of files that affect the engine build (such as
DEPS and the engine directory itself).
For advanced use-cases, such as on CI platforms, or for custom 1-off testing
using a pre-built Flutter engine (to use a locally built Flutter engine see
locally built engines), the environment variable FLUTTER_PREBUILT_ENGINE_VERSION can be set,
again to a engine SHA for a merged commit in flutter/flutter. This is only needed
if different artifacts from the content sha are desired:
$ FLUTTER_PREBUILT_ENGINE_VERSION=abc123 flutter --version
..
Engine • revision abc123 ..
..
stateDiagram-v2
[*] --> CheckEnvVar
CheckEnvVar: <code>FLUTTER_PREBUILT_ENGINE_VERSION</code> set?
UseEnvVar: Use <code>FLUTTER_PREBUILT_ENGINE_VERSION</code>
CheckReleaseFile: <code>bin/internal/engine.version</code> exists?
UseReleaseFile: Use <code>bin/internal/engine.version</code>
UseContentAwareHash: Compute content-aware hash
CheckEnvVar --> UseEnvVar: Yes
CheckEnvVar --> CheckReleaseFile: No
UseEnvVar --> [*]: Done
CheckReleaseFile --> UseReleaseFile: Yes
CheckReleaseFile --> UseContentAwareHash: No
UseReleaseFile --> [*]: Done
UseContentAwareHash --> [*]: Done
Flutter CI/CD Testing
On Cocoon (Flutter's internal CI/CD) we often set
FLUTTER_PREBUILT_ENGINE_VERSION to the following:
| Branch | Presubmit | Merge Queue | Postsubmit |
|---|---|---|---|
main |
content.sha |
content.sha |
content.sha |
flutter-x.x-candidate.x |
content.sha |
N/A1 | content.sha |
stable or beta |
N/A2 | N/A1 | N/A2 |
| anything else3 | content.sha |
content.sh |
content.sha |
To generate a new
engine.version:./bin/internal/content_aware_hash.sh > ./bin/internal/engine.versionAs of
b0ccfb53801abc9b0aa93e7cca3a3841513c3086(May 6 2025), the packaging release process will refuse to let you publish a release with an out of dateengine.version.
References
The script(s) that compute (and test the computation of) the engine version:
bin/internal/update_engine_version.shbin/internal/update_engine_version.ps1dev/tools/test/update_engine_version_test.dartbin/internal/last_engine_commit.shbin/internal/last_engine_commit.ps1dev/tools/test/last_engine_commit_test.dartbin/internal/content_aware_hash.shbin/internal/content_aware_hash.ps1dev/tools/test/content_aware_hash_test.dart
The tool uses the engine version in the following locations: