Skip to content

The ultimate harness for coding agents and beyond. All your agents. All your machines. One command center. Start with code, then follow your curiosity and build across disciplines: CAD, circuits, robots, games and music.

Record Flutter target timings for native release builds (#642)

Dee6a315374b19f
diff --git a/desktop/scripts/build-macos-variants.py b/desktop/scripts/build-macos-variants.py
index 2243c070e..b5661f002 100644
--- a/desktop/scripts/build-macos-variants.py
+++ b/desktop/scripts/build-macos-variants.py
@@ -61,10 +61,39 @@ def phase(checks, desktop, output, receipt):
raise RuntimeError("macOS phase failed; see the per-variant results")
+def flutter_timings(path):
+ """Keep only SDK target timings, never arbitrary diagnostic fields or argv."""
+ try:
+ data = json.loads(path.read_text())
+ targets = data["targets"]
+ if not isinstance(targets, list) or not targets:
+ raise ValueError("no target timings")
+ result = []
+ for target in targets:
+ name = target["name"]
+ elapsed = target["elapsedMilliseconds"]
+ if (not isinstance(name, str) or not re.fullmatch(r"[A-Za-z0-9_-]{1,128}", name)
+ or type(elapsed) is not int or elapsed < 0
+ or type(target["skipped"]) is not bool or type(target["succeeded"]) is not bool):
+ raise ValueError("invalid target timing")
+ result.append({key: target[key] for key in ("name", "elapsedMilliseconds", "skipped", "succeeded")})
+ return dict(status="recorded", targets=result)
+ except (OSError, ValueError, KeyError, TypeError):
+ # Profiling is diagnostic, not an additional publication gate. The actual
+ # build/signing/artifact checks still determine the coordinator's result.
+ return dict(status="unavailable")
+
+
def build(version, defines, desktop, output, receipt):
variant_script = str(desktop / "scripts/publish-macos-variant.sh")
- phase([check("universal-build", ["bash", variant_script, "apple-silicon", version, "--build-only", *defines], 1800)],
- desktop, output, receipt)
+ profile = output / "flutter-build.json"
+ profile.unlink(missing_ok=True)
+ try:
+ phase([check("universal-build", ["bash", variant_script, "apple-silicon", version, "--build-only",
+ f"--performance-measurement-file={profile}", *defines], 1800)],
+ desktop, output, receipt)
+ finally:
+ receipt["flutter_build"] = flutter_timings(profile)
source = desktop / "build/macos/Build/Products/Release/Harness.app"
copies = []
for variant in VARIANTS:
diff --git a/desktop/scripts/publish-macos-variant.sh b/desktop/scripts/publish-macos-variant.sh
index de17c68b4..2fcc30db8 100755
--- a/desktop/scripts/publish-macos-variant.sh
+++ b/desktop/scripts/publish-macos-variant.sh
@@ -45,7 +45,7 @@ SIGN_IDENTITY="${SIGN_IDENTITY:-Developer ID Application}" # same default as u
die() { echo "error: $*" >&2; exit 1; }
usage() {
- echo "usage: bash scripts/publish-macos-variant.sh <intel|apple-silicon> <X.Y.Z> [--build-only] [--no-build] [--no-notarize] [--dart-define=KEY=VALUE ...]" >&2
+ echo "usage: bash scripts/publish-macos-variant.sh <intel|apple-silicon> <X.Y.Z> [--build-only] [--no-build] [--no-notarize] [--dart-define=KEY=VALUE ...] [--performance-measurement-file=PATH]" >&2
exit 1
}
@@ -60,13 +60,15 @@ DO_NOTARIZE=1
# Handed to `flutter build` and nowhere else — upload-desktop.sh --no-build never builds. A release
# passes none; .github/workflows/desktop-internal-build.yml passes the tester's flags.
DART_DEFINES=()
+PERFORMANCE_ARGS=()
for arg in "$@"; do
case "$arg" in
--build-only) BUILD_ONLY=1 ;;
--no-build) DO_BUILD=0 ;;
--no-notarize) DO_NOTARIZE=0 ;;
--dart-define=*) DART_DEFINES+=("$arg") ;;
- *) die "unknown argument '$arg' — only --build-only, --no-build, --no-notarize and --dart-define=KEY=VALUE; the version is explicit, so there is nothing to bump" ;;
+ --performance-measurement-file=*) PERFORMANCE_ARGS+=("$arg") ;;
+ *) die "unknown argument '$arg' — see usage for supported build options; the version is explicit, so there is nothing to bump" ;;
esac
done
@@ -90,6 +92,7 @@ command -v flutter >/dev/null 2>&1 || die "flutter not found"
# --- build, or derive a renderer variant from an explicitly supplied build ---
if [ "$DO_BUILD" -eq 0 ]; then
[ "${#DART_DEFINES[@]}" -eq 0 ] || die "--dart-define cannot be applied with --no-build"
+ [ "${#PERFORMANCE_ARGS[@]}" -eq 0 ] || die "performance measurement requires a build"
echo ">> using the existing universal app for $VARIANT $VER"
else
[ "$APP_BUNDLE" = "$APP_DIR/build/macos/Build/Products/Release/Harness.app" ] \
@@ -104,7 +107,7 @@ else
rm -rf "$APP_BUNDLE"
# An empty array under set -u needs this expansion on macOS bash 3.2.
( cd "$APP_DIR" && flutter build macos --release --build-name="$VER" --build-number="$BUILD_NUM" \
- ${DART_DEFINES[@]+"${DART_DEFINES[@]}"} )
+ ${DART_DEFINES[@]+"${DART_DEFINES[@]}"} ${PERFORMANCE_ARGS[@]+"${PERFORMANCE_ARGS[@]}"} )
fi
[ -d "$APP_BUNDLE" ] || die "app bundle missing after the build: $APP_BUNDLE"
# A copied app must be the requested build and keep both architectures. Renderer
diff --git a/scripts/tests/test_macos_variants.py b/scripts/tests/test_macos_variants.py
index 6ddb3c45f..5206ba9ef 100644
--- a/scripts/tests/test_macos_variants.py
+++ b/scripts/tests/test_macos_variants.py
@@ -40,6 +40,9 @@ else:
counter=Path("compile-count")
counter.write_text(str(int(counter.read_text())+1) if counter.exists() else "1")
Path("build-args.json").write_text(__import__("json").dumps(args))
+ if not os.environ.get("COORDINATOR_NO_PROFILE"):
+ profile=next(arg.split("=",1)[1] for arg in args if arg.startswith("--performance-measurement-file="))
+ Path(profile).write_text(__import__("json").dumps({"targets":[{"name":"release_macos_bundle_flutter_assets","elapsedMilliseconds":1234,"skipped":False,"succeeded":True}]}))
app=Path("build/macos/Build/Products/Release/Harness.app")
app.mkdir(parents=True,exist_ok=True)
app.joinpath("version").write_text(version)
@@ -88,6 +91,8 @@ print("published fixture")
self.assertEqual((self.desktop / "compile-count").read_text(), "1")
self.assertIn("--dart-define=PRIVATE_FIXTURE=do-not-record-this", json.loads((self.desktop / "build-args.json").read_text()))
self.assertNotIn("do-not-record-this", json.dumps(receipt))
+ self.assertEqual(receipt["flutter_build"], dict(status="recorded", targets=[dict(
+ name="release_macos_bundle_flutter_assets", elapsedMilliseconds=1234, skipped=False, succeeded=True)]))
for variant in variants.VARIANTS:
app = self.output / variant / "Harness.app"
self.assertEqual((app / "renderer").read_text(), variant)
@@ -95,6 +100,34 @@ print("published fixture")
self.assertFalse((self.desktop / "build/macos/Build/Products/Release/Harness.app/renderer").exists())
self.assertFalse(list(self.desktop.glob("*-publication.json")), "build-only published artifacts")
+ def test_profiling_never_reuses_a_previous_builds_report(self):
+ self.output.mkdir(parents=True)
+ (self.output / "flutter-build.json").write_text('{"targets": [{"stale": true}]}')
+ with mock.patch.dict(os.environ, COORDINATOR_NO_PROFILE="1"):
+ result, receipt = self.run_build()
+ self.assertEqual(result, 0)
+ self.assertEqual(receipt["flutter_build"], dict(status="unavailable"))
+ self.assertFalse((self.output / "flutter-build.json").exists())
+
+ def test_profile_retains_timings_without_arbitrary_diagnostic_fields(self):
+ path = self.desktop / "profile.json"
+ target = dict(name="kernel_snapshot_program", elapsedMilliseconds=123, skipped=False, succeeded=True)
+ path.write_text(json.dumps(dict(targets=[dict(target, argv="private-argument")], environment="private-env")))
+ self.assertEqual(variants.flutter_timings(path), dict(status="recorded", targets=[target]))
+
+ def test_missing_or_invalid_profiles_are_explicitly_unavailable(self):
+ path = self.desktop / "profile.json"
+ self.assertEqual(variants.flutter_timings(path), dict(status="unavailable"))
+ valid = dict(name="kernel_snapshot_program", elapsedMilliseconds=123, skipped=False, succeeded=True)
+ invalid = [None, {}, {"targets": []}, {"targets": [None]}, {"targets": [{"name": "incomplete"}]}]
+ for field, value in (("name", "name\\nprivate=value"), ("elapsedMilliseconds", -1),
+ ("elapsedMilliseconds", True), ("skipped", "false"), ("succeeded", None)):
+ invalid.append(dict(targets=[dict(valid, **{field: value})]))
+ for value in invalid:
+ with self.subTest(value=value):
+ path.write_text(json.dumps(value))
+ self.assertEqual(variants.flutter_timings(path), dict(status="unavailable"))
+
def test_publications_overlap_without_sharing_artifact_or_manifest_paths(self):
result, receipt = self.run_build("--metadata-prefix", "harness/desktop/.ci/123")
self.assertEqual(result, 0, receipt)