How shorebirdtech/updater works
This repository provides Shorebird’s Flutter code-push runtime, patch-packaging tool, and optional Dart bindings. The principal app workflow enters through the Flutter engine’s C API, initializes the updater, checks for and downloads updates, manages patch state and files, and exposes boot/launch validation. The graph also preserves patch packaging and Dart/web surfaces documented in the README. Internal links follow the SOURCE INDEX; unsampled implementations are represented only where the README establishes their role.
Main entry points: updater.rs Update Orchestration · updater_state.rs Updater State · config.rs Runtime Config · lifecycle.rs Patch Lifecycle
Components 23
Updater Runtime
- Update Orchestration
library/src/updater.rs - Runtime Config
library/src/config.rs - App YAML Config
library/src/yaml.rs - Update Networking
library/src/network.rs - Patch Events
library/src/events.rs
Patch State and Storage
- Updater State
library/src/cache/updater_state.rs - Patch Lifecycle
library/src/cache/lifecycle.rs - State File I/O
library/src/cache/disk_io.rs - Patch Verification
library/src/cache/signing.rs - File Error Context
library/src/file_errors.rs
App Interfaces
- Engine C API
library/src/c_api/engine.rs - File Callbacks
library/src/c_api/c_file.rs - Dart C API
library/src/c_api/dart.rs - Dart IO Bindings
shorebird_code_push/lib/src/shorebird_updater_io.dart - Dart Web Bindings
shorebird_code_push/lib/src/shorebird_updater_web.dart - Dart Updater API
shorebird_code_push/lib/src/shorebird_updater.dart
Patch Packaging
- Patch Packaging Tool
patch/src/main.rs - Patch Library
patch/src/lib.rs - String Patch Tool
patch/src/bin/string_patch.rs
Other components
- Flutter Engine
- Flutter App
- Update Server
- Shorebird CLI
Connections 23
- Flutter Engine → Engine C API: calls
library/src/c_api/engine.rs - Engine C API → Update Orchestration: dispatches
library/src/c_api/engine.rs - Engine C API → File Callbacks: uses callbacks
library/src/c_api/engine.rs - Flutter App → Dart Updater API: uses
README.md - Dart Updater API → Dart IO Bindings: selects platform
- Dart Updater API → Dart Web Bindings: selects platform
- Dart IO Bindings → Dart C API: calls native API
- Dart Web Bindings → Update Server: communicates updates
- Update Orchestration → Runtime Config: reads config
library/src/updater.rs - Update Orchestration → Update Networking: requests updates
library/src/updater.rs - Update Orchestration → Updater State: manages patches
library/src/updater.rs - Update Orchestration → Patch Events: reports events
library/src/updater.rs - Runtime Config → App YAML Config: parses settings
library/src/config.rs - Runtime Config → Update Networking: configures hooks
library/src/config.rs - Update Networking → Update Server: sends requests
library/src/network.rs - Updater State → Patch Lifecycle: tracks patches
library/src/cache/updater_state.rs - Updater State → State File I/O: persists state
library/src/cache/updater_state.rs - Updater State → Patch Verification: verifies patches
library/src/cache/updater_state.rs - Patch Lifecycle → State File I/O: reads and writes
library/src/cache/lifecycle.rs - Patch Lifecycle → Patch Verification: uses verification
library/src/cache/lifecycle.rs - State File I/O → File Error Context: adds error context
library/src/cache/disk_io.rs - Shorebird CLI → Patch Packaging Tool: runs
README.md - Patch Packaging Tool → Patch Library: packages patches