Brandon DeRosier
ede7990ea2
* feat: enrich patch install failure messages with diagnostics The `message` field in `__patch_install_failure__` events previously contained generic strings that didn't help distinguish failure causes. Crash recovery messages now include: - `elapsed_secs`: time between boot start and crash recovery detection, helping distinguish immediate crashes (likely OOM) from delayed kills (user force-stop, OS reclaim hours later) - `file_ok`/`file_size`: whether the patch file is intact at recovery time, catching corruption or partial writes Message format changes: - Crash recovery: "crash_recovery: patch N failed to boot (elapsed_secs=S,file_ok=bool,file_size=N)" - Engine failure: "engine_report: patch N failed to launch" Also adds `boot_started_at` timestamp to PatchesState (backward compatible — older state files deserialize it as None). * chore: fix formatting * test: add coverage for crash recovery edge cases - crash_recovery_with_missing_file: patch artifact deleted before recovery, verifies file_ok=false,file_missing in message - crash_recovery_without_boot_timestamp: old state file without boot_started_at field, verifies elapsed_secs=unknown in message * refactor: simplify file check in crash recovery diagnostics Remove unreachable branch: Path::exists() calls fs::metadata() internally, so if metadata fails, exists() returns false. The separate file_unreadable case could never be reached. * refactor: use raw timestamps instead of elapsed_secs in crash recovery elapsed_secs was misleading because it included the time between the crash and the user reopening the app — not just the boot duration. Now reports boot_started_at (raw Unix timestamp) and detected_at (when crash recovery ran). Server-side analysis can compute elapsed time and cross-reference with successful boot durations from other devices. Example: "crash_recovery: patch 1 failed to boot (detected_at=1776900000,boot_started_at=1776899990,file_ok=true,file_size=524288)"
Updater library
This is the Rust side of the Shorebird code push system. This is built
in Rust with a C API for easy calling from other languages, most notably
for linking into libflutter.so.
The primary modification Shorebird makes to the stock Flutter engine is adding support for the updater library (this repo). The updater library is written in Rust and is used to update the code running in the Flutter app. The updater library is built as a static library and is linked into the Flutter engine during build time.
Parts
library: Runtime library linked into Flutter Engine to unpack and apply updates. Build into libupdater.a and linked into libflutter.so.patch: Developer tooling to package Shorebird updates ("patches"). Built intopatch.exeand downloaded and run byshorebirdcommand line tool: https://github.com/shorebirdtech/shorebird/tree/main/packages/shorebird_cli.shorebird_code_push: The Dart bindings for communicating with the updater library from within a Flutter app. Published to pub.dev, usage is optional by developers.
Most interesting code is in the library directory. There is also
a README.md in that directory explaining the design.
Developing
It's best to edit this repository from within an engine checkout. See BUILDING_ENGINE.md for instructions on how to set up an engine checkout.
The workflow I use involves 2 to 3 VSC windows:
- Opening the engine
src.
In that terminal I:
cd third_party/updater
- To build the updater as part of the engine:
cargo ndk --target aarch64-linux-android build --release && \
ninja -C ../../out/android_release_arm64 && say "done"
The cargo part should not be needed, but I haven't yet done the work to integrate the Rust code into the gn files for the Flutter engine yet.
I add say "done" to the end as linking can take several minutes for release
Android builds.
-
In a second window, I open
code third_party/updater. I do this because otherwise therust_analyzercan't seem to find the rust code. We could fix this by adding the directory to the VSC workspace, but I'm not sure where we would put the workspace file in the first place.srcis actuallyshorebirdtech/buildrootand is controlled viagclientbyshorebirdtech/engine/DEPS. -
In a third window I open my test app. e.g.:
flutter create test_app
cd test_app
shorebird init
shorebird release
code .
- To run the test app with my local engine I use:
shorebird run --local-engine-src-path $HOME/Documents/GitHub/engine/src \
--local-engine android_release_arm64
You may also need to build out/host_release once as flutter build looks for
some Dart .dill files in host_release.
Coverage
We'd like to get to 100% coverage but aren't there yet.
https://github.com/taiki-e/cargo-llvm-cov is the best tool I've found for generating coverage reports.
Install: https://github.com/taiki-e/cargo-llvm-cov#installation
cargo llvm-cov will then generate the report.